@babylonjs/core|

PlaySoundAction

Class PlaySoundAction

This defines an action helpful to play a defined sound on a triggered action.

Hierarchy (View Summary)

Action
- PlaySoundAction

Index

Constructors

Properties

onBeforeExecuteObservable trigger triggerOptions

Methods

execute getTriggerParameter serialize setTriggerParameter skipToNextActiveAction then

Constructors

constructor

new PlaySoundAction(
    triggerOptions: any,
    sound: Sound,
    condition?: Condition,
): PlaySoundAction
Instantiate the action
Parameters
- triggerOptions: any
  defines the trigger options
- sound: Sound
  defines the sound to play
- Optionalcondition: Condition
  defines the trigger related conditions
Returns PlaySoundAction
Overrides Action.constructor
- Defined in packages/dev/core/src/Actions/directAudioActions.pure.ts:20

Properties

onBeforeExecuteObservable

onBeforeExecuteObservable: Observable<Action> = ...

An event triggered prior to action being executed.

trigger

trigger: number

Trigger for the action

triggerOptions

triggerOptions: any

the trigger, with or without parameters, for the action

Methods

execute

execute(): void
Execute the action and play the sound.

Returns void
Overrides Action.execute
- Defined in packages/dev/core/src/Actions/directAudioActions.pure.ts:31

getTriggerParameter

getTriggerParameter(): any
Gets the trigger parameter

Returns any
the trigger parameter
Inherited from Action.getTriggerParameter
- Defined in packages/dev/core/src/Actions/action.pure.ts:137

serialize

serialize(parent: any): any
Serializes the actions and its related information.
Parameters
- parent: any
  defines the object to serialize in
Returns any
the serialized object
Overrides Action.serialize
- Defined in packages/dev/core/src/Actions/directAudioActions.pure.ts:42

setTriggerParameter

setTriggerParameter(value: any): void
Sets the trigger parameter
Parameters
- value: any
  defines the new trigger parameter
Returns void
Inherited from Action.setTriggerParameter
- Defined in packages/dev/core/src/Actions/action.pure.ts:145

skipToNextActiveAction

skipToNextActiveAction(): void
Skips to next active action

Returns void
Inherited from Action.skipToNextActiveAction
- Defined in packages/dev/core/src/Actions/action.pure.ts:196

then

then(action: Action): Action
Adds action to chain of actions, may be a DoNothingAction
Parameters
- action: Action
  defines the next action to execute
Returns Action
The action passed in

See
https://www.babylonjs-playground.com/#1T30HR#0
Inherited from Action.then
- Defined in packages/dev/core/src/Actions/action.pure.ts:214