Class ValueAccumulatorMetadata

Defines properties and message types for ValueAccumulator.

Inherits properties and message types from NodeComponentMetadata.

Property Types

See also PropertyType
ValueAccumulatorMetadata.AutoplayProperty

Sets whether the Value Accumulator starts automatically when it is attached to the node.

ValueAccumulatorMetadata.BoundTypeProperty

Sets how the Value Accumulator limits the total accumulated value between the minimum and maximum value boundaries.

ValueAccumulatorMetadata.IncrementTimeIntervalProperty

Sets the frequency of increments in milliseconds. This property is only used when Increment Mode is set to Time Based.

ValueAccumulatorMetadata.IncrementModeProperty

Sets how the Value Accumulator increments the accumulated value.:

  • Time Based increments at fixed time intervals. This is the default.
  • Per Frame increments once every frame, ignoring time.

Message Types

See also MessageType
ValueAccumulatorMetadata.StartMessage

Starts the animation applied by a Value Accumulator to its target property value.

Arguments: ValueAccumulatorMetadata.StartMessageArguments

ValueAccumulatorMetadata.StopMessage

Stops the animation applied by a Value Accumulator to its target property value.

Arguments: ValueAccumulatorMetadata.StopMessageArguments

ValueAccumulatorMetadata.PauseMessage

Pauses the animation applied by a Value Accumulator to its target property value.

Arguments: ValueAccumulatorMetadata.PauseMessageArguments

ValueAccumulatorMetadata.ResumeMessage

Resumes the paused animation applied by a Value Accumulator to its target property value.

Arguments: ValueAccumulatorMetadata.ResumeMessageArguments

Message Arguments

Message arguments classes define message arguments used for different message types. Each class defines a number of property types - arguments - together with getter and setter functions for them.

ValueAccumulatorMetadata.PauseMessageArguments

TargetNameProperty

Sets the name of the node component that receives this message. To send this message to every node component in this node, use an empty string.

Example
local value = arguments:getTargetNameProperty()
arguments:setTargetNameProperty(value)

ValueAccumulatorMetadata.ResumeMessageArguments

TargetNameProperty

Sets the name of the node component that receives this message. To send this message to every node component in this node, use an empty string.

Example
local value = arguments:getTargetNameProperty()
arguments:setTargetNameProperty(value)

ValueAccumulatorMetadata.StartMessageArguments

TargetNameProperty

Sets the name of the node component that receives this message. To send this message to every node component in this node, use an empty string.

Example
local value = arguments:getTargetNameProperty()
arguments:setTargetNameProperty(value)

ValueAccumulatorMetadata.StopMessageArguments

TargetNameProperty

Sets the name of the node component that receives this message. To send this message to every node component in this node, use an empty string.

Example
local value = arguments:getTargetNameProperty()
arguments:setTargetNameProperty(value)