API Documentation for: 1.0.1
Show:

platypus.components.LogicDragDrop Class

A component that allows an object to be dragged and dropped. Can use collision to prevent dropping the objects in certain locations.

Methods

'component-added'

(
  • component
)

This component listens for added components to determine whether it should check for collision.

Parameters:

  • component platypus.Component

    Component added to entity.

    • type String

      Type of component to detect whether it's a collision component.

'handle-logic'

()

Defined in 'handle-logic':69

Updates the object's location on the handle-logic tick.

'handle-post-collision-logic'

()

Resolves whether the object state after we check if there are any collisions. If the object was dropped and can be dropped, it is.

'no-drop'

()

Defined in 'no-drop':180

This message comes from the collision system letting us know the object is currently in a location that it cannot be dropped.

'pointerdown'

(
  • eventData
)

Defined in 'pointerdown':108

The pointerdown event fires when we're grabbing the object. Starts the drag.

Parameters:

'pointermove'

(
  • eventData
)

Defined in 'pointermove':147

The pointermove event tells us when we're dragging a "stickyClick" object.

Parameters:

'pressmove'

(
  • eventData
)

Defined in 'pressmove':163

The pressmove event tells us when we're dragging the object.

Parameters:

'pressup'

(
  • eventData
)

Defined in 'pressup':133

The pressup event fires when we're trying to drop the object.

Parameters:

addEventListener

(
  • event
  • callback
)
Function private
This method adds an event listener to the entity.

Parameters:

  • event String
    The event that this component should listen for.
  • callback Function
    The handler for the event.

Returns:

Function: handler A reference to the bound handler.

addMethod

(
  • name
  • func
)
private
This method adds a method to the entity.

Parameters:

  • name String
    The name of the method. For example, if name is "turnYellow", the method is accessible on the entity as entity.turnYellow().
  • func Function
    The function describing the method.

destroy

() private

Inherited from platypus.Component: destroy:54

This method cleans up listeners and methods that this component added to the entity. It should never be called by the component itself. Call this.owner.removeComponent(this) instead.

getAssetList

(
  • definition
  • properties
  • defaultProperties
)
Array
This method can be overwritten to provide the list of assets this component requires. This method is invoked when the list of game scenes is created to determine assets for each scene.

Parameters:

  • definition Object
    The definition for the component.
  • properties Object
    The properties of the Entity.
  • defaultProperties Object
    The default properties of the Entity.

Returns:

Array: A list of the necessary assets to load.

getLateAssetList

(
  • data
)
Array
This method can be overwritten to provide the list of assets this component requires. This method is invoked when the list of game scenes is created to determine assets for each scene.

Parameters:

  • data Object
    Scene data that affects the list of assets.

Returns:

Array: A list of the necessary assets to load.

removeEventListener

(
  • event
  • callback
)
private
This method removes an event listener from the entity.

Parameters:

  • event String
    The event for which to remove a listener.
  • callback Function
    The listener to remove. If not supplied, all event listeners for the provided event are removed.

removeEventListeners

(
  • [listeners]
)
private
This method removes multiple event listeners from the entity.

Parameters:

  • [listeners] Array optional
    The list of listeners to remove. If not supplied, all event listeners are removed.

removeMethod

(
  • name
)
private
This method removes a method from the entity.

Parameters:

  • name String
    The name of the method to be removed.

toJSON

() Object

Inherited from platypus.Component: toJSON:45

Available since 0.11.0

Returns a JSON object describing the component.

Returns:

Object: Returns a JSON definition that can be used to recreate the component.

toString

() String
Returns a string describing the component.

Returns:

String: Returns the component type as a string of the form "[Component ComponentType]".

Properties

dragZ

Number

Defined in dragZ:16

Available since 0.8.3

Sets the z-order of the item while being dragged.

Default: 10000

stickyClick

Boolean

Defined in stickyClick:26

Available since 0.8.3

Sets whether a click-move should start the dragging behavior in addition to click-drag. This value is ignored for mobile devices.

Default: false