Mostly Harmless

UE3:UIAnimationSeq (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 11:47, 6 November 2009 by (Talk)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UDK Object >> UIRoot >> UIAnimation >> UIAnimationSeq
Package: 
Engine
This class in other games:
UT3


Properties[edit]

LoopMode[edit]

Type: UIAnimation.EUIAnimationLoopMode

Controls how this animation sequence loops

SeqName[edit]

Type: name

The name of this sequence

Tracks[edit]

Type: array<UIAnimation.UIAnimTrack>

Holds a list of Animation Tracks in this sequence

Native functions[edit]

GetFrameLength[edit]

native final function bool GetFrameLength (int TrackIndex, int FrameIndex, out float out_FrameLength) const

Wrapper for getting the length of a specific frame in one of this animation sequence's tracks.

Parameters:

  • TrackIndex - the index [into the Tracks array] for the track to check
  • FrameIndex - the index [into the KeyFrames array of the track] for the keyframe to check
  • out_FrameLength - receives the remaining seconds for the frame specified

Returns:

TRUE if the call succeeded; FALSE if an invalid track or frame index was specified.

GetSequenceLength[edit]

native final function float GetSequenceLength () const

Wrapper for getting the length of this animation sequence.

Returns:

the total number of seconds in this animation sequence.

GetTrackLength[edit]

native final function bool GetTrackLength (int TrackIndex, out float out_TrackLength) const

Wrapper for getting the length of a specific track in this animation sequence.

Parameters:

  • TrackIndex - the index [into the Tracks array] for the track to check
  • out_TrackLength - receives the remaining number of seconds for the track specified.

Returns:

TRUE if the call succeeded; FALSE if an invalid track index was specified.

IsValidFrameIndex[edit]

native final function bool IsValidFrameIndex (int TrackIndex, int FrameIndex) const

Wrapper for verifying whether the index is a valid index for the track's keyframes array.

Parameters:

  • TrackIndex - the index [into the Tracks array] for the track to check
  • FrameIndex - the index [into the KeyFrames array of the track] for the keyframe to check

Returns:

TRUE if the specified track contains a keyframe at the specified index.