API Documentation for: 0.11.8
Show:

platypus.components.CollisionGroup Class

This component groups other entities with this entity for collision checking. This is useful for carrying and moving platforms. It uses EntityContainer component messages if triggered to add to its collision list and also listens for explicit add/remove messages (useful in the absence of an EntityContainer component).

Methods

'add-collision-entity'

(
  • entity
)

On receiving this message, the component checks the entity to determine whether it listens for collision messages. If so, the entity is added to the collision group.

Parameters:

'child-entity-added'

(
  • entity
)

On receiving this message, the component checks the entity to determine whether it listens for collision messages. If so, the entity is added to the collision group.

Parameters:

'child-entity-removed'

(
  • entity
)

On receiving this message, the component looks for the entity in its collision group and removes it.

Parameters:

'relocate-entity'

()

When this message is triggered, the collision group updates its record of the owner's last (x, y) coordinate.

'remove-collision-entity'

(
  • entity
)

On receiving this message, the component looks for the entity in its collision group and removes it.

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.

getCollisionGroupAABB

()

Gets the bounding box of the group of entities.

Returns:

platypus.AABB

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.

getWorldEntities

()

Gets a list of all the entities in the world.

Returns:

Array

getWorldTerrain

()

Defined in getWorldTerrain:461

Gets the collision entity representing the world's terrain.

Returns:

platypus.Entity

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]".