AudioSystem

AudioSystem ⇐ MRSystem

This system manages spatial audio in the THREE.js scene.

Kind: global class
Extends: MRSystem

• AudioSystem ⇐ MRSystem
  • .AudioSystem
    • new exports.AudioSystem()
  • .update(deltaTime, frame)
  • .attachedComponent(entity)
  • .updatedComponent(entity)
  • .detachedComponent(entity)
  • .setAudioState(entity, comp)

audioSystem.AudioSystem

Kind: instance class of AudioSystem

new exports.AudioSystem()

AudioSystem’s Default constructor that sets up the audio listener and loader

audioSystem.update(deltaTime, frame)

The generic system update call. Updates the clipped view of every entity in this system’s registry.

Kind: instance method of AudioSystem

Param	Type	Description
deltaTime	number	given timestep to be used for any feature changes
frame	object	given frame information to be used for any feature changes

audioSystem.attachedComponent(entity)

Called when the entity component is initialized

Kind: instance method of AudioSystem

Param	Type	Description
entity	object	the entity being attached/initialized.

audioSystem.updatedComponent(entity)

Called when the entity component is updated

Kind: instance method of AudioSystem

Param	Type	Description
entity	object	the entity being updated based on the component.

audioSystem.detachedComponent(entity)

Called when the entity component is detached

Kind: instance method of AudioSystem

Param	Type	Description
entity	object	the entity being updated based on the component being detached.

audioSystem.setAudioState(entity, comp)

Updates the Audio State based on the user passed ‘state’ variable.

Kind: instance method of AudioSystem

Param	Type	Description
entity	object	the entity being updated based on the component being detached.
comp	object	component that contains the value of ‘action’