API Documentation for: 0.11.8
Show:

platypus.components.AudioVO Class

Module: platypus

Available since 0.6.0

This component plays audio using the SpringRoll VOPlayer instance. Audio is played by triggering specific messages defined in the audio component definition.

Methods

'*'

(
  • [message.events]
)

Defined in '*':157

Listens for messages specified by the audioMap and on receiving them, begins playing corresponding audio clips.

Parameters:

  • [message.events] Array optional

    Used to specify the list of events to trigger while playing this audio sequence.

'handle-render'

()

Defined in 'handle-render':172

On each handle-render message, this component checks its list of playing audio clips and stops any clips whose play length has been reached.

'stop-audio'

()

Defined in 'stop-audio':183

On receiving this message, audio will stop playing.

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

audioMap

Object

Defined in audioMap:117

Use the audioMap property object to map messages triggered with audio clips to play. At least one audio mapping should be included for audio to play. Here is an example audioMap object:

  {
                                                  "message-triggered": "audio-id",
                                                  // This simple form is useful to listen for "message-triggered" and play "audio-id" using default audio properties.
                                            
                                                  "another-message": {
                                                  // To specify audio properties, instead of mapping the message to an audio id string, map it to an object with one or more of the properties shown below. Many of these properties directly correspond to SoundJS play parameters.
                                            
                                                      "sound": "another-audio-id",
                                                      // Required. This is the audio clip to play when "another-message" is triggered.
                                            
                                                      "events": [{
                                                          "event": "walk-to-the-left",
                                                          "time": 1500
                                                      }]
                                                      // Optional. Used to specify a list of events to play once the VO begins.
                                                  }
                                              }

Default: null

Events

sequence-complete

When an audio sequence is finished playing, this event is triggered.