ORK Framework  2.24.0
API Documentation
ORKFramework.Combatants.CombatantAnimations Class Reference

Public Member Functions

 CombatantAnimations (Combatant owner)
 
AudioClip GetAudioClip (int typeID)
 Gets a combatant's audio clip assigned to a sound type. More...
 
AnimInfo Play (int typeID)
 Plays the specified animation type. More...
 
void Stop (int typeID)
 Stops playing the specified animation type. More...
 
void StopAll ()
 Stops all animation types. More...
 
void Tick ()
 Update function called each frame. More...
 
void UpdateGameObject ()
 Gets the combatant's animation components. More...
 
void UpdateAnimations ()
 Updates the animations. More...
 
void LegacyFade (string name, float fadeLength)
 Fades a legacy animation. More...
 
void LegacyRemoveStop (string name)
 Removes a legacy animation currently marked as stopping. More...
 

Public Attributes

bool autoMoveAnimation = false
 
MecanimAutoRotationParameter mecanimXRotation
 
MecanimAutoRotationParameter mecanimYRotation
 
MecanimAutoRotationParameter mecanimZRotation
 

Member Function Documentation

AudioClip ORKFramework.Combatants.CombatantAnimations.GetAudioClip ( int  typeID)

Gets a combatant's audio clip assigned to a sound type.

Returns
The audio clip.
Parameters
typeIDThe ID (index) of the sound type.
void ORKFramework.Combatants.CombatantAnimations.LegacyFade ( string  name,
float  fadeLength 
)

Fades a legacy animation.

Parameters
nameThe name of the animation.
fadeLengthThe fade length in seconds.
void ORKFramework.Combatants.CombatantAnimations.LegacyRemoveStop ( string  name)

Removes a legacy animation currently marked as stopping.

Parameters
nameThe name of the animation.
AnimInfo ORKFramework.Combatants.CombatantAnimations.Play ( int  typeID)

Plays the specified animation type.

Returns
An AnimInfo containing information on the used animation.
Parameters
typeIDThe ID (index) of the animation type.
void ORKFramework.Combatants.CombatantAnimations.Stop ( int  typeID)

Stops playing the specified animation type.

Parameters
typeIDThe ID (index) of the animation type.
void ORKFramework.Combatants.CombatantAnimations.StopAll ( )

Stops all animation types.

void ORKFramework.Combatants.CombatantAnimations.Tick ( )

Update function called each frame.

void ORKFramework.Combatants.CombatantAnimations.UpdateAnimations ( )

Updates the animations.

void ORKFramework.Combatants.CombatantAnimations.UpdateGameObject ( )

Gets the combatant's animation components.