AnimationNodeAnimation — C# API

class AnimationNodeAnimationReckfellSharpInherits AnimationRootNode

An input animation for an AnimationNodeBlendTree.

A resource to add to an AnimationNodeBlendTree. Only has one output port using the AnimationNodeAnimation.Animation property. Used as an input for AnimationNodes that blend animations together.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

AnimationNodeAnimationConstructor

# AnimationNodeAnimation

C#
public AnimationNodeAnimation();

Properties8

AdvanceOnStartProperty

# AdvanceOnStart

C#
public bool AdvanceOnStart { get; set; }

If true, on receiving a request to play an animation from the start, the first frame is not drawn, but only processed, and playback starts from the next frame. See also the notes of AnimationPlayer.Play.

AnimationProperty

# Animation

C#
public StringName Animation { get; set; }

Animation to use as an output. It is one of the animations provided by AnimationTree.AnimPlayer.

LoopModeProperty

# LoopMode

C#
public Animation.LoopModeEnum LoopMode { get; set; }

If AnimationNodeAnimation.UseCustomTimeline is true, override the loop settings of the original Animation resource with the value. Note: If the Animation.LoopMode isn't set to looping, the Animation.TrackSetInterpolationLoopWrap option will not be respected. If you cannot get the expected behavior, consider duplicating the Animation resource and changing the loop settings.

PlayModeProperty

# PlayMode

C#
public AnimationNodeAnimation.PlayModeEnum PlayMode { get; set; }

Determines the playback direction of the animation.

StartOffsetProperty

# StartOffset

C#
public double StartOffset { get; set; }

If AnimationNodeAnimation.UseCustomTimeline is true, offset the start position of the animation. This is useful for adjusting which foot steps first in 3D walking animations.

StretchTimeScaleProperty

# StretchTimeScale

C#
public bool StretchTimeScale { get; set; }

If true, scales the time so that the length specified in AnimationNodeAnimation.TimelineLength is one cycle. This is useful for matching the periods of walking and running animations. If false, the original animation length is respected. If you set the loop to AnimationNodeAnimation.LoopMode, the animation will loop in AnimationNodeAnimation.TimelineLength.

TimelineLengthProperty

# TimelineLength

C#
public double TimelineLength { get; set; }

The length of the custom timeline. If AnimationNodeAnimation.StretchTimeScale is true, scales the animation to this length.

UseCustomTimelineProperty

# UseCustomTimeline

C#
public bool UseCustomTimeline { get; set; }

If true, AnimationNode provides an animation based on the Animation resource with some parameters adjusted.

Methods16

GetAnimationStringName

# GetAnimation

C#
public StringName GetAnimation();

Returns StringName

GetLoopModeAnimation.LoopModeEnum

# GetLoopMode

C#
public Animation.LoopModeEnum GetLoopMode();

Returns Animation.LoopModeEnum

GetPlayModeAnimationNodeAnimation.PlayModeEnum

# GetPlayMode

C#
public AnimationNodeAnimation.PlayModeEnum GetPlayMode();

Returns AnimationNodeAnimation.PlayModeEnum

GetStartOffsetdouble

# GetStartOffset

C#
public double GetStartOffset();

Returns double

GetTimelineLengthdouble

# GetTimelineLength

C#
public double GetTimelineLength();

Returns double

IsAdvanceOnStartbool

# IsAdvanceOnStart

C#
public bool IsAdvanceOnStart();

Returns bool

IsStretchingTimeScalebool

# IsStretchingTimeScale

C#
public bool IsStretchingTimeScale();

Returns bool

IsUsingCustomTimelinebool

# IsUsingCustomTimeline

C#
public bool IsUsingCustomTimeline();

Returns bool

SetAdvanceOnStartvoid

# SetAdvanceOnStart

C#
public void SetAdvanceOnStart(bool advanceOnStart);

Parameters
Name	Type	Default
`advanceOnStart`	`bool`	—

SetAnimationvoid

# SetAnimation

C#
public void SetAnimation(StringName name);

Parameters
Name	Type	Default
`name`	`StringName`	—

SetLoopModevoid

# SetLoopMode

C#
public void SetLoopMode(Animation.LoopModeEnum loopMode);

Parameters
Name	Type	Default
`loopMode`	`Animation.LoopModeEnum`	—

SetPlayModevoid

# SetPlayMode

C#
public void SetPlayMode(AnimationNodeAnimation.PlayModeEnum mode);

Parameters
Name	Type	Default
`mode`	`AnimationNodeAnimation.PlayModeEnum`	—

SetStartOffsetvoid

# SetStartOffset

C#
public void SetStartOffset(double startOffset);

Parameters
Name	Type	Default
`startOffset`	`double`	—

SetStretchTimeScalevoid

# SetStretchTimeScale

C#
public void SetStretchTimeScale(bool stretchTimeScale);

Parameters
Name	Type	Default
`stretchTimeScale`	`bool`	—

SetTimelineLengthvoid

# SetTimelineLength

C#
public void SetTimelineLength(double timelineLength);

Parameters
Name	Type	Default
`timelineLength`	`double`	—

SetUseCustomTimelinevoid

# SetUseCustomTimeline

C#
public void SetUseCustomTimeline(bool useCustomTimeline);

Parameters
Name	Type	Default
`useCustomTimeline`	`bool`	—

AnimationNodeAnimation.PlayModeEnum

Value	Description
`Backward = 1`	Plays animation in backward direction.
`Forward = 0`	Plays animation in forward direction.