Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.AnimNodePlayCustomAnim

Extends
AnimNodeBlend
Modifiers
DependsOn ( AnimNodeSequence ) native ( Anim )

Gives code control to override an AnimTree branch, with a custom animation. . Normal branch is the normal tree branch (for example Human upper body). . Custom branch must be connected to an AnimNodeSequence. This node can then take over the upper body to play a cutom animation given various parameters. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.AnimNode
   |   
   +-- Engine.AnimNodeBlendBase
      |   
      +-- Engine.AnimNodeBlend
         |   
         +-- Engine.AnimNodePlayCustomAnim

Variables Summary
boolbIsPlayingCustomAnim
floatCustomPendingBlendOutTime
Inherited Variables from Engine.AnimNodeBlend
BlendTimeToGo, Child2Weight, Child2WeightTarget
Inherited Variables from Engine.AnimNodeBlendBase
bFixNumChildren, Children

Structures Summary
Inherited Structures from Engine.AnimNodeBlendBase
AnimBlendChild

Functions Summary
functionAnimNodeSequence GetCustomAnimNodeSeq ()))
functionfloat PlayCustomAnim (name AnimName, float Rate, optional float BlendInTime, optional float BlendOutTime, optional bool bLooping, optional bool bOverride)
function PlayCustomAnimByDuration (name AnimName, float Duration, optional float BlendInTime, optional float BlendOutTime, optional bool bLooping, optional bool bOverride)
function SetActorAnimEndNotification (bool bNewStatus))
function SetCustomAnim (Name AnimName))
function SetRootBoneAxisOption (optional ERootBoneAxis AxisX = RBA_Default, optional ERootBoneAxis AxisY = RBA_Default, optional ERootBoneAxis AxisZ = RBA_Default ))
function StopCustomAnim (float BlendOutTime)
Inherited Functions from Engine.AnimNodeBlend
SetBlendTarget
Inherited Functions from Engine.AnimNodeBlendBase
PlayAnim, StopAnim


Variables Detail

bIsPlayingCustomAnim Source code

var bool bIsPlayingCustomAnim;
True, when we're playing a custom animation

CustomPendingBlendOutTime Source code

var float CustomPendingBlendOutTime;
save blend out time when playing a one shot animation.


Functions Detail

GetCustomAnimNodeSeq Source code

final function AnimNodeSequence GetCustomAnimNodeSeq ( ) )
Returns AnimNodeSequence playing the custom animation

PlayCustomAnim Source code

final native function float PlayCustomAnim ( name AnimName, float Rate, optional float BlendInTime, optional float BlendOutTime, optional bool bLooping, optional bool bOverride )
Play a custom animation. Supports many features, including blending in and out.
@param AnimName Name of animation to play.
@param Rate Rate animation should be played at.
@param BlendInTime Blend duration to play anim.
@param BlendOutTime Time before animation ends (in seconds) to blend out. -1.f means no blend out. 0.f = instant switch, no blend. otherwise it's starting to blend out at AnimDuration - BlendOutTime seconds.
@param bLooping Should the anim loop? (and play forever until told to stop)
@param bOverride play same animation over again only if bOverride is set to true.
@return PlayBack length of animation.

PlayCustomAnimByDuration Source code

final native function PlayCustomAnimByDuration ( name AnimName, float Duration, optional float BlendInTime, optional float BlendOutTime, optional bool bLooping, optional bool bOverride )
Play a custom animation. Auto adjusts the animation's rate to match a given duration in seconds. Supports many features, including blending in and out.
@param AnimName Name of animation to play.
@param Duration duration in seconds the animation should be played.
@param BlendInTime Blend duration to play anim.
@param BlendOutTime Time before animation ends (in seconds) to blend out. -1.f means no blend out. 0.f = instant switch, no blend. otherwise it's starting to blend out at AnimDuration - BlendOutTime seconds.
@param bLooping Should the anim loop? (and play forever until told to stop)
@param bOverride play same animation over again only if bOverride is set to true.

SetActorAnimEndNotification Source code

final function SetActorAnimEndNotification ( bool bNewStatus) )
Set bCauseActorAnimEnd flag

SetCustomAnim Source code

final function SetCustomAnim ( Name AnimName) )
Set Custom animation.

SetRootBoneAxisOption Source code

final function SetRootBoneAxisOption ( optional ERootBoneAxis AxisX = RBA_Default, optional ERootBoneAxis AxisY = RBA_Default, optional ERootBoneAxis AxisZ = RBA_Default ) )
Set custom animation root bone options.

StopCustomAnim Source code

final native function StopCustomAnim ( float BlendOutTime )
Stop playing a custom animation. Used for blending out of a looping custom animation.


Defaultproperties

defaultproperties
{
   Children(0)=(Name="Normal")
   Children(1)=(Name="Custom")
   NodeName="CustomAnim"
   Name="Default__AnimNodePlayCustomAnim"
   ObjectArchetype=AnimNodeBlend'Engine.Default__AnimNodeBlend'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:34.959 - Created with UnCodeX