API Documentation for: 0.11.8
Show:

platypus.components.Tutorial Class

Module: platypus

Available since 0.8.7

Tutorial provides a framework for playing tutorials. It allows the user to define things such as under what conditions tutorials will play, how often they play, and which tutorials have priority.

Methods

'child-entity-added'

(
  • entity
)

Checks added entity to determine if it is one of the conditions for one of the tutorials. If so, we track it.

Parameters:

  • entity Object

    The added entity.

'child-entity-removed'

(
  • entity
)

Removes entities from the watch list when they are destroyed.

Parameters:

  • entity Object

    The removed entity.

'handle-logic'

(
  • tick.delta
)

Defined in 'handle-logic':215

Checks tutorials to determine if they should play.

Parameters:

  • tick.delta Number

    The length of the tick.

'logic-tick'

(
  • tick.delta
)

Defined in 'logic-tick':207

Checks tutorials to determine if they should play.

Parameters:

  • tick.delta Number

    The length of the tick.

'peer-entity-added'

(
  • entity
)

Checks added entity to determine if it is one of the conditions for one of the tutorials. If so, we track it.

Parameters:

  • entity Object

    The added entity.

'peer-entity-removed'

(
  • entity
)

Removes entities from the watch list when they are destroyed.

Parameters:

  • entity Object

    The removed entity.

'sequence-complete'

()

Fired when audioVO finishes. Clears the playing tutorial returning it to the internal list of tutorials if it will be played again.

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