API Documentation for: 0.11.10
Show:

platypus.components.LogicRotationalMovement Class

This component changes the (x, y) position of an object according to its current speed and heading. It maintains its own heading information independent of other components allowing it to be used simultaneously with other logic components like [[Logic-Pushable]]. It accepts directional messages that can stand alone, or come from a mapped controller, in which case it checks the pressed value of the message before changing its course accordingly.

Methods

'go-backward'

(
  • [state.pressed]
)

Defined in 'go-backward':155

On receiving this event, the entity goes backward.

Parameters:

  • [state.pressed] Boolean optional

    If state is included, the component checks the value of pressed: true causes movement in the triggered direction, false turns off movement in that direction. Note that if no message is included, the only way to stop movement in a particular direction is to trigger stop on the entity before progressing in a new orientation.

'go-forward'

(
  • [state.pressed]
)

Defined in 'go-forward':140

On receiving this event, the entity goes forward.

Parameters:

  • [state.pressed] Boolean optional

    If state is included, the component checks the value of pressed: true causes movement in the triggered direction, false turns off movement in that direction. Note that if no message is included, the only way to stop movement in a particular direction is to trigger stop on the entity before progressing in a new orientation.

'handle-logic'

(
  • tick.delta
)

Defined in 'handle-logic':70

On receiving this event, the component updates its location according to its current state.

Parameters:

  • tick.delta Number

    To determine how far to move the entity, the component checks the length of the tick.

'rotate'

(
  • angleDelta
)

Defined in 'rotate':102

This rotates the entity by a delta in radians.

Parameters:

  • angleDelta Number

    The change in angle.

'stop'

(
  • [state.pressed]
)

Defined in 'stop':170

Stops rotational and linear motion until movement messages are again received.

Parameters:

  • [state.pressed] Boolean optional

    If state is included, the component checks the value of pressed: a value of false will not stop the entity.

'stop-moving'

(
  • [state.pressed]
)

Defined in 'stop-moving':184

Stops linear motion until movement messages are again received.

Parameters:

  • [state.pressed] Boolean optional

    If state is included, the component checks the value of pressed: a value of false will not stop the entity.

'stop-turning'

(
  • [state.pressed]
)

Defined in 'stop-turning':196

Stops rotational motion until movement messages are again received.

Parameters:

  • [state.pressed] Boolean optional

    If state is included, the component checks the value of pressed: a value of false will not stop the entity.

'turn-left'

(
  • [state.pressed]
)

Defined in 'turn-left':126

On receiving this event, the entity turns left.

Parameters:

  • [state.pressed] Boolean optional

    If state is included, the component checks the value of pressed: true causes movement in the triggered direction, false turns off movement in that direction. Note that if no message is included, the only way to stop movement in a particular direction is to trigger stop on the entity before progressing in a new orientation.

'turn-right'

(
  • [state.pressed]
)

Defined in 'turn-right':112

On receiving this event, the entity turns right.

Parameters:

  • [state.pressed] Boolean optional

    If state is included, the component checks the value of pressed: true causes movement in the triggered direction, false turns off movement in that direction. Note that if no message is included, the only way to stop movement in a particular direction is to trigger stop on the entity before progressing in a new orientation.

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

angle

Number

Defined in angle:34

Radian orientation that entity should begin in. Defaults to 0 (facing right).

Default: 0

degree

Number

Defined in degree:43

Unit in radians that the angle should change per millisecond.

Default: 1

speed

Number

Defined in speed:25

Defines the distance in world units that the entity should be moved per millisecond.

Default: 0.3