Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncrementValueAction

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

see

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

Hierarchy

Implements

Index

Constructors

constructor

  • 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

onBeforeExecuteObservableSearch playground for onBeforeExecuteObservable

onBeforeExecuteObservable: Observable<Action>

An event triggered prior to action being executed.

propertyPathSearch playground for propertyPath

propertyPath: string

The path of the property to increment in the target.

triggerSearch playground for trigger

trigger: number

Trigger for the action

triggerOptionsSearch playground for triggerOptions

triggerOptions: any

the trigger, with or without parameters, for the action

valueSearch playground for value

value: any

The value we should increment the property by.

Methods

executeSearch playground for execute

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

    Returns void

getTriggerParameterSearch playground for getTriggerParameter

  • getTriggerParameter(): any

serializeSearch playground for 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

setTriggerParameterSearch playground for setTriggerParameter

  • setTriggerParameter(value: any): void
  • Sets the trigger parameter

    Parameters

    • value: any

      defines the new trigger parameter

    Returns void

skipToNextActiveActionSearch playground for skipToNextActiveAction

  • skipToNextActiveAction(): void

thenSearch playground for then

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static method