API Documentation for: 0.11.8
Show:

platypus.components.LogicAngularMovement Class

This component moves the entity in the direction of an internally stored angle value. When moving, the entity constantly accelerates the entity in a direction up to a max velocity.

Methods

'handle-logic'

(
  • tick
)

Defined in 'handle-logic':69

Updates the position, velocity, and rotation of the entity

Parameters:

'move'

()

Defined in 'move':127

Start the entity accelerating toward the heading angle.

'set-angle'

(
  • angle
)

Defined in 'set-angle':118

Sets the internal heading angle in the component.

Parameters:

  • angle Number

    The value you want to set the angle to.

'set-max-velocity'

(
  • newMaxV
)

Set the max velocity.

Parameters:

  • newMaxV Number

    The max velocity value.

'stop'

()

Defined in 'stop':135

Stops the movement toward the heading angle.

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

acceleration

Number

Defined in acceleration:27

The rate of acceleration.

Default: 0.01

maxVelocity

Number

Defined in maxVelocity:18

The max velocity.

Default: 3

startAngle

Number

Defined in startAngle:45

The starting heading at which the entity will accelerate. In radians.

Default: 0

visualOffset

Number

Defined in visualOffset:36

The offset between the rotation value of the entity and the rotation of the art.

Default: 0