GamingIsLove.ORKFramework.Combatants.CombatantAnimations Class Reference

Public Member Functions
	CombatantAnimations (Combatant owner)
virtual AudioClip	GetAudioClip (SoundTypeAsset soundType)
	Gets a combatant's audio clip assigned to a sound type. More...
AnimInfo	Play (AnimationTypeAsset animationType)
	Plays the specified animation type. More...
void	StopMovement ()
void	Stop (AnimationTypeAsset animationType)
	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	CheckUpdateAnimations ()
	Checks if the animations need to be updated due to status effects or equipment with custom animations. 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

CheckUpdateAnimations()

void GamingIsLove.ORKFramework.Combatants.CombatantAnimations.CheckUpdateAnimations

(

)

Checks if the animations need to be updated due to status effects or equipment with custom animations.

GetAudioClip()

virtual AudioClip GamingIsLove.ORKFramework.Combatants.CombatantAnimations.GetAudioClip ( SoundTypeAsset  soundType )

virtual

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

Returns

The audio clip.

Parameters

soundType

The ID (index) of the sound type.

LegacyFade()

void GamingIsLove.ORKFramework.Combatants.CombatantAnimations.LegacyFade	(	string	name,
		float	fadeLength
	)

Fades a legacy animation.

Parameters

name	The name of the animation.
fadeLength	The fade length in seconds.

LegacyRemoveStop()

void GamingIsLove.ORKFramework.Combatants.CombatantAnimations.LegacyRemoveStop

(

string

name

)

Removes a legacy animation currently marked as stopping.

Parameters

name	The name of the animation.

Play()

AnimInfo GamingIsLove.ORKFramework.Combatants.CombatantAnimations.Play

(

AnimationTypeAsset

animationType

)

Plays the specified animation type.

Returns

An AnimInfo containing information on the used animation.

Parameters

animationType

The ID (index) of the animation type.

Stop()

void GamingIsLove.ORKFramework.Combatants.CombatantAnimations.Stop

(

AnimationTypeAsset

animationType

)

Stops playing the specified animation type.

Parameters

animationType

The ID (index) of the animation type.

StopAll()

void GamingIsLove.ORKFramework.Combatants.CombatantAnimations.StopAll

(

)

Stops all animation types.

Tick()

void GamingIsLove.ORKFramework.Combatants.CombatantAnimations.Tick

(

)

Update function called each frame.

UpdateAnimations()

void GamingIsLove.ORKFramework.Combatants.CombatantAnimations.UpdateAnimations

(

)

Updates the animations.

UpdateGameObject()

void GamingIsLove.ORKFramework.Combatants.CombatantAnimations.UpdateGameObject

(

)

Gets the combatant's animation components.