Api Sandbox AnimGraphDirectPlayback
class

AnimGraphDirectPlayback

public abstract class AnimGraphDirectPlayback

For communicating with a Direct Playback Anim Node, which allows code to tell it to play a given sequence

Properties

Name Type Description
StartTime virtual Single Set the time at which the currently playing sequence should have had a cycle of zero. This will adjust the current cycle of the sequence to match.
TimeNormalized virtual Single Get the cycle of the currently playing sequence. Will return 0 if no sequence is playing.
Duration virtual Single The duration of the currently playing sequence (seconds)
Time virtual Single The elapsed time of the currently playing animation sequence (seconds)
Name virtual String Returns the currently playing sequence.
AnimationCount virtual Int32 Get the number of animations that can be used.
Animations virtual IEnumerable<String> Get the list of animations that can be used.
Sequences virtual IReadOnlyList<String> Get the list of sequences that can be used.

Methods

virtual Void Play(String name)

Play the given sequence until it ends, then blend back. Calling this function with a new sequence while another one is playing will immediately start blending from the old one to the new one.

virtual Void Play(String name, Vector3 target, Single heading, Single interpTime)

Same as the other Play function, but also sets a target position and heading for the sequence. Over interpTime seconds, the entity's root motion will be augmented to move it to target and rotate it to heading.

virtual Void Cancel()

Stop playing the override sequence.

Assembly: Sandbox.Engine Namespace: Sandbox Full Name: Sandbox.AnimGraphDirectPlayback