API Documentation for: 0.11.8
Show:

platypus.components.LogicAttachment Class

Creates an entity and connects it with the owner entity. This is useful for entities that have a one-to-one relationship with a given entity and must move as if connected to the host entity.

Methods

'attach'

(
  • input
)

Defined in 'attach':157

Creates and attaches the entity. The input value makes it possible to attach the entity on user input.

Parameters:

  • input Object

    An input object.

    • pressed Boolean

      If set to true, the entity is created and attached.

'change-attachment-offset'

(
  • offset
  • input.x
  • input.y
  • input.y
)

Changes the x, y, and z offset of the attachment.

Parameters:

  • offset Object

    An object containing the offset values.

  • input.x Number

    The new X offset.

  • input.y Number

    The new Y offset.

  • input.y Number

    The new Z offset.

'detach'

()

Defined in 'detach':167

Detaches and removes the entity.

'handle-logic'

()

Defined in 'handle-logic':104

On receiving this message, updates the attached entity's position.

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

attachment

String

Defined in attachment:28

The type of the entity to be attached.

Default: ''

attachState

String

Defined in attachState:20

An owner state, set to true when the attachment is attached. Meant to be read by other components or used in rendering.

Default: 'attached'

offsetX

Number

Defined in offsetX:46

The offset of the attached entity in x from the attachee.

Default: 0

offsetY

Number

Defined in offsetY:54

The offset of the attached entity in y from the attachee.

Default: 0

offsetZ

Number

Defined in offsetZ:62

The offset of the attached entity in z from the attachee.

Default: 0

startAttached

Boolean

Defined in startAttached:37

Whether the attachment starts out attached.

Default: false