API Documentation for: 0.11.8
Show:

platypus.components.SceneChanger Class

This component allows the entity to initiate a change from the current scene to another scene.

Methods

'new-scene'

(
  • message.scene
  • message.persistentData
)

Defined in 'new-scene':42

On receiving this message, a new scene is loaded according to provided parameters or previously determined component settings.

Parameters:

  • message.scene String

    This is a label corresponding with a predefined scene.

  • message.persistentData Object

    Any values that should be passed to the next scene on the new scene's "scene-loaded" and "scene-live" events.

'set-persistent-scene-data'

(
  • persistentData
)

On receiving this message, persistent data is stored, waiting for a new-scene to make the transition.

Parameters:

  • persistentData Object

    Any values that should be passed to the next scene via the "scene-loaded" and "scene-live" events.

'set-scene'

(
  • scene
)

Defined in 'set-scene':57

On receiving this message, a scene value is stored, waiting for a new-scene to make the transition.

Parameters:

  • scene String

    This is a label corresponding with a predefined scene.

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

persistentData

platypus.Data | Object

Defined in persistentData:27

An object containing key/value pairs of information that should be passed into the new scene on the new scene's "scene-loaded" and "scene-live" events.

Default: null

scene

String

Defined in scene:18

Optional, but must be provided by a "new-scene" parameter if not defined here. This causes a "new-scene" event to load this scene.

Default: ""