Worst-case scenario: the UEd Goblin wipes the map and burns down your house.

UE3:AnimNodePlayCustomAnim (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Revision as of 16:11, 17 May 2008 by Wormbo (Talk | contribs)
(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UT3 Object >> AnimNode >> AnimNodeBlendBase >> AnimNodeBlend >> AnimNodePlayCustomAnim

Contents
Package: 
Engine
This class in other games:
UDK
This is an auto-generated page and may need human attention.
Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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-2007 Epic Games, Inc. All Rights Reserved.

[edit] Properties

[edit] bIsPlayingCustomAnim

Type: bool

True, when we're playing a custom animation

[edit] CustomPendingBlendOutTime

Type: float

save blend out time when playing a one shot animation.

[edit] Default values

Property Value
Children[0]
Member Value
Name 'Normal'
Children[1]
Member Value
Name 'Custom'
NodeName 'CustomAnim'

[edit] Functions

[edit] Native functions

[edit] PlayCustomAnim

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.

Parameters:

  • AnimName - Name of animation to play.
  • Rate - Rate animation should be played at.
  • BlendInTime - Blend duration to play anim.
  • 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.
  • bLooping - Should the anim loop? (and play forever until told to stop)
  • bOverride - play same animation over again only if bOverride is set to true.

Returns:

PlayBack length of animation.

[edit] PlayCustomAnimByDuration

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.

Parameters:

  • AnimName - Name of animation to play.
  • Duration - duration in seconds the animation should be played.
  • BlendInTime - Blend duration to play anim.
  • 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.
  • bLooping - Should the anim loop? (and play forever until told to stop)
  • bOverride - play same animation over again only if bOverride is set to true.

[edit] StopCustomAnim

final native function StopCustomAnim (float BlendOutTime)

Stop playing a custom animation. Used for blending out of a looping custom animation.

[edit] Other instance functions

[edit] GetCustomAnimNodeSeq

final function AnimNodeSequence GetCustomAnimNodeSeq ()

Returns AnimNodeSequence playing the custom animation

[edit] SetActorAnimEndNotification

final function SetActorAnimEndNotification (bool bNewStatus)

Set bCauseActorAnimEnd flag

[edit] SetCustomAnim

final function SetCustomAnim (name AnimName)

Set Custom animation.

[edit] SetRootBoneAxisOption

final function SetRootBoneAxisOption (optional AnimNodeSequence.ERootBoneAxis AxisX, optional AnimNodeSequence.ERootBoneAxis AxisY, optional AnimNodeSequence.ERootBoneAxis AxisZ)

Set custom animation root bone options.

Retrieved from "http://wiki.beyondunreal.com/UE3:AnimNodePlayCustomAnim_(UT3)"