IncrementValueAction

This defines an action responsible to increment the target value to a desired value once triggered.

see

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

Hierarchy

Index

Constructors

constructor

Find examples in Playground
  • 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 increment in the target

    • value: any

      defines the value value we should increment the property by

    • Optional condition: Condition

      defines the trigger related conditions

    Returns IncrementValueAction

Properties

onBeforeExecuteObservable

Find examples in Playground
onBeforeExecuteObservable: Observable<Action>

An event triggered prior to action being executed.

propertyPath

Find examples in Playground
propertyPath: string

The path of the property to increment in the target.

trigger

Find examples in Playground
trigger: number

Trigger for the action

triggerOptions

Find examples in Playground
triggerOptions: any

the trigger, with or without parameters, for the action

value

Find examples in Playground
value: any

The value we should increment the property by.

Methods

execute

Find examples in Playground
  • execute(): void
  • Execute the action and increment the target of the value amount.

    Returns void

getTriggerParameter

Find examples in Playground
  • getTriggerParameter(): any

serialize

Find examples in Playground
  • 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

Find examples in Playground
  • skipToNextActiveAction(): void

then

Find examples in Playground

Generated using TypeDoc