Class AnimationPlayerMetadata

Defines properties and message types for AnimationPlayer.

Inherits properties and message types from NodeComponentMetadata.

Property Types

See also PropertyType
AnimationPlayerMetadata.TimelineProperty

The target animation timeline.

AnimationPlayerMetadata.AutoplayEnabledProperty

Specifies whether animation player should start playback of its timeline automatically when it is attached to the node.

AnimationPlayerMetadata.RelativePlaybackProperty

Specifies whether animations are played in relative manner by adding animated value to target property value instead of replacing the property value.

AnimationPlayerMetadata.RestoreOriginalValuesAfterPlaybackProperty

Specifies whether animated properties return to their initial values after playback of the timeline ends.

AnimationPlayerMetadata.PlaybackModeProperty

Specifies the mode of timeline playback (normal, reverse, pingpong).

AnimationPlayerMetadata.DurationScaleProperty

Specifies how much duration of the timeline is scaled during its playback.

AnimationPlayerMetadata.RepeatCountProperty

Specifies how many times the timeline is played during its playback (1 for one time playback, 0 for infinite amount of repeats).

Message Types

See also MessageType
AnimationPlayerMetadata.PlayMessage

Instructs an Animation Player to start animation playback with new parameters.

Arguments: AnimationPlayerMetadata.PlayMessageArguments

AnimationPlayerMetadata.ResumeMessage

Instructs an Animation Player to resume animation playback if it is paused or to start the playback if it is stopped.

Arguments: AnimationPlayerMetadata.ResumeMessageArguments

AnimationPlayerMetadata.PauseMessage

Instructs an Animation Player to pause animation playback.

Arguments: AnimationPlayerMetadata.PauseMessageArguments

AnimationPlayerMetadata.StopMessage

Instructs an Animation Player to stop animation playback.

Arguments: AnimationPlayerMetadata.StopMessageArguments

AnimationPlayerMetadata.StartedMessage

Occurs when an Animation Player starts animation playback.

Arguments: AnimationPlayerMetadata.StartedMessageArguments

AnimationPlayerMetadata.StoppedMessage

Occurs when an Animation Player stops animation playback.

Arguments: AnimationPlayerMetadata.StoppedMessageArguments

AnimationPlayerMetadata.CompletedMessage

Occurs when an Animation Player completes animation playback.

Arguments: AnimationPlayerMetadata.CompletedMessageArguments

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.

AnimationPlayerMetadata.CompletedMessageArguments

AnimationPlayerMetadata.PauseMessageArguments

AnimationPlayerMetadata.PlayMessageArguments

PlaybackModeProperty

Specifies the mode of timeline playback (normal, reverse, pingpong). This mode is applied on top of player's mode property.

Example
local value = arguments:getPlaybackModeProperty()
arguments:setPlaybackModeProperty(value)
DurationScaleProperty

Specifies how much duration of the timeline is scaled during its playback. This scale is applied on top of player's duration scale property.

Example
local value = arguments:getDurationScaleProperty()
arguments:setDurationScaleProperty(value)
RepeatCountProperty

Specifies how many times the timeline is played during its playback (1 for one time playback, 0 for infinite amount of repeats). This repeat count is applied on top of player's repeact count property.

Example
local value = arguments:getRepeatCountProperty()
arguments:setRepeatCountProperty(value)

AnimationPlayerMetadata.ResumeMessageArguments

AnimationPlayerMetadata.StartedMessageArguments

AnimationPlayerMetadata.StopMessageArguments

AnimationPlayerMetadata.StoppedMessageArguments