SetValueAction

This defines an action responsible to set a property of the target to a desired value once triggered.

see

http://doc.babylonjs.com/how_to/how_to_use_actions

Hierarchy

Index

Constructors

constructor

  • new SetValueAction(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition): SetValueAction
  • Instantiate the action

    Parameters

    • triggerOptions: any

      defines the trigger options

    • target: any

      defines the object containing the property

    • propertyPath: string

      defines the path of the property to set in the target

    • value: any

      defines the value to set in the property

    • Optional condition: Condition

      defines the trigger related conditions

    Returns SetValueAction

Properties

onBeforeExecuteObservable

onBeforeExecuteObservable: Observable<Action>

An event triggered prior to action being executed.

propertyPath

propertyPath: string

The path of the property to set in the target.

trigger

trigger: number

Trigger for the action

triggerOptions

triggerOptions: any

the trigger, with or without parameters, for the action

value

value: any

The value to set in the property

Methods

execute

  • execute(): void
  • Execute the action and set the targetted property to the desired value.

    Returns void

getTriggerParameter

  • getTriggerParameter(): any

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

skipToNextActiveAction

  • skipToNextActiveAction(): void

then

Generated using TypeDoc