Adventure Creator  1.79.1
An adventure game toolkit for Unity, by Chris Burton, ICEBOX Studios 2013-2022
AC.AnimEngine_Mecanim Class Reference
Inheritance diagram for AC.AnimEngine_Mecanim:
AC.AnimEngine

Public Member Functions

override void Declare (AC.Char _character)
 Initialises the engine. More...
 
override void CharSettingsGUI ()
 
override void CharExpressionsGUI ()
 
override PlayerData SavePlayerData (PlayerData playerData, Player player)
 
override void LoadPlayerData (PlayerData playerData, Player player)
 
override NPCData SaveNPCData (NPCData npcData, NPC npc)
 
override void LoadNPCData (NPCData npcData, NPC npc)
 
override void ActionSpeechGUI (ActionSpeech action, Char speaker)
 
override void ActionSpeechRun (ActionSpeech action)
 
override void ActionSpeechSkip (ActionSpeech action)
 
override void ActionCharAnimGUI (ActionCharAnim action, List< ActionParameter > parameters=null)
 
override void ActionCharAnimAssignValues (ActionCharAnim action, List< ActionParameter > parameters)
 
override float ActionCharAnimRun (ActionCharAnim action)
 
override void ActionCharAnimSkip (ActionCharAnim action)
 
override void ActionAnimGUI (ActionAnim action, List< ActionParameter > parameters)
 
override string ActionAnimLabel (ActionAnim action)
 
override void ActionAnimAssignValues (ActionAnim action, List< ActionParameter > parameters)
 
override float ActionAnimRun (ActionAnim action)
 
override void ActionAnimSkip (ActionAnim action)
 
override void ActionCharRenderGUI (ActionCharRender action, List< ActionParameter > parameters)
 
override float ActionCharRenderRun (ActionCharRender action)
 
override void PlayIdle ()
 
override void PlayWalk ()
 
override void PlayRun ()
 
override void PlayTalk ()
 
override void PlayVertical ()
 
override void PlayJump ()
 
override void TurnHead (Vector2 angles)
 Rotates a character's head. More...
 
override void OnSetExpression ()
 Called whenever the character's Expression is changed. It can be read with CurrentExpression. More...
 
override bool RequiresRememberAnimator (ActionCharAnim action)
 
override bool RequiresRememberAnimator (ActionAnim action)
 
override void AddSaveScript (Action _action, GameObject _gameObject)
 Adds any relevent Remember scripts onto a GameObject referenced by an animation-based Action. More...
 
- Public Member Functions inherited from AC.AnimEngine
virtual void ActionCharRenderGUI (ActionCharRender action)
 
virtual void PlayTurnLeft ()
 
virtual void PlayTurnRight ()
 

Protected Member Functions

float ActionCharAnimProcess (ActionCharAnim action, bool isSkipping)
 
float ActionAnimProcess (ActionAnim action, bool isSkipping)
 
void MoveCharacter ()
 
void AnimTalk (Animator animator)
 

Properties

override bool IKEnabled [get]
 
- Properties inherited from AC.AnimEngine
bool updateHeadAlways [get, protected set]
 
virtual bool IKEnabled [get]
 

Additional Inherited Members

- Public Attributes inherited from AC.AnimEngine
TurningStyle turningStyle = TurningStyle.Script
 
bool isSpriteBased = false
 
- Protected Attributes inherited from AC.AnimEngine
AC.Char character
 

Member Function Documentation

◆ AddSaveScript()

override void AC.AnimEngine_Mecanim.AddSaveScript ( Action  _action,
GameObject  _gameObject 
)
virtual

Adds any relevent Remember scripts onto a GameObject referenced by an animation-based Action.

Parameters
_actionThe Action referencing the GameObject
_gameObjectThe GameObject being referenced

Reimplemented from AC.AnimEngine.

◆ Declare()

override void AC.AnimEngine_Mecanim.Declare ( AC.Char  _character)
virtual

Initialises the engine.

Parameters
_characterThe Player/NPC that this instance is controlling.

Reimplemented from AC.AnimEngine.

◆ OnSetExpression()

override void AC.AnimEngine_Mecanim.OnSetExpression ( )
virtual

Called whenever the character's Expression is changed. It can be read with CurrentExpression.

Reimplemented from AC.AnimEngine.

◆ PlayIdle()

override void AC.AnimEngine_Mecanim.PlayIdle ( )
virtual

Plays the character's 'Idle' animation.

Reimplemented from AC.AnimEngine.

◆ PlayJump()

override void AC.AnimEngine_Mecanim.PlayJump ( )
virtual

Plays the character's 'Jump' animation.

Reimplemented from AC.AnimEngine.

◆ PlayRun()

override void AC.AnimEngine_Mecanim.PlayRun ( )
virtual

Plays the character's 'Run' animation.

Reimplemented from AC.AnimEngine.

◆ PlayTalk()

override void AC.AnimEngine_Mecanim.PlayTalk ( )
virtual

Plays the character's 'Talk' animation.

Reimplemented from AC.AnimEngine.

◆ PlayVertical()

override void AC.AnimEngine_Mecanim.PlayVertical ( )
virtual

Called every frame to animate the character based on height change. The character's height change can be found with GetHeightChange ().

Reimplemented from AC.AnimEngine.

◆ PlayWalk()

override void AC.AnimEngine_Mecanim.PlayWalk ( )
virtual

Plays the character's 'Walk' animation.

Reimplemented from AC.AnimEngine.

◆ TurnHead()

override void AC.AnimEngine_Mecanim.TurnHead ( Vector2  angles)
virtual

Rotates a character's head.

Parameters
anglesThe new angles to rotate the head to

Reimplemented from AC.AnimEngine.