Skip to content

Animator bindings

SDraw edited this page Jun 14, 2023 · 8 revisions

Refer to Unity's Animator documentation for properties and methods description.

Properties

  • angularVelocity: get, Vector3
  • applyRootMotion: ges/set, boolean
  • bodyPosition: get, Vector3
  • bodyRotation: get, Quaternion
  • cullingMode: get/set, string as enum
  • deltaPosition: get, Vector3
  • deltaRotation: get, Quaternion
  • feetPivotActive: get/set, boolean
  • fireEvents: get/set, boolean
  • gravityWeight: get, float
  • hasBoundPlayables: get, boolean
  • hasRootMotion: get, boolean
  • hasTransformHierarchy: get, boolean
  • humanScale: get, float
  • isHuman: get, boolean
  • isInitialized: get, boolean
  • isMatchingTarget: get, boolean
  • isOptimizable: get, boolean
  • keepAnimatorControllerStateOnDisable: get/set, boolean
  • layerCount: get, integer
  • layersAffectMassCenter: get/set, boolean
  • leftFeetBottomHeight: get, float
  • parameterCount: get, integer
  • pivotPosition: get, Vector3
  • pivotWeight: get, float
  • playbackTime: get/set, float
  • recorderMode: get, string as enum
  • recorderStartTime: get/set, float
  • recorderStopTime: get/set, float
  • rightFeetBottomHeight: get, float
  • rootPosition: get, Vector3
  • rootRotation: get, Quaternion
  • speed: get/set, float
  • stabilizeFeet: get/set, boolean
  • targetPosition: get, Vector3
  • targetRotation: get, Quaternion
  • updateMode: get/set, string as enum
  • velocity: get, Vector3

Methods

  • bool ApplyBuiltinRootMotion()
  • bool CrossFade(string state, float duration, int layer = -1, float offset = NegativeInfinity, float transition = 0)
  • bool CrossFadeInFixedTime(string state, float duration, int layer = -1, float offset = NegativeInfinity, float transition = 0)
  • Transform GetBoneTransform(string humanBone)
  • bool GetBool(string param)
  • int GetCurrentAnimatorClipInfoCount(int layer)
  • float GetFloat(string param)
  • Vector3 GetIKHintPosition(string hint)
  • float GetIKHintPositionWeight(string hint)
  • Vector3 GetIKPosition(string goal)
  • float GetIKPositionWeight(string goal)
  • Quaternion GetIKRotation(string goal)
  • float GetIKRotationWeight(string goal)
  • int GetInteger(string param)
  • int GetLayerIndex(string name)
  • string GetLayerName(int index)
  • float GetLayerWeight(int index)
  • int GetNextAnimatorClipInfoCount(int layer)
  • bool HasState(int layer, int state)
  • bool InterruptMatchTarget()
  • bool IsInTransition(int layer)
  • bool IsParameterControlledByCurve(string param)
  • bool Play(string state, int layer = -1, float time = NegativeInfinity)
  • bool PlayInFixedTime(string state, int layer = -1, float time = NegativeInfinity)
  • bool Rebind()
  • bool ResetTrigger(string param)
  • bool SetBoneLocalRotation(string humanBone, Quaternion rot)
  • bool SetBool(string param, bool value)
  • bool SetFloat(string param, float value)
  • bool SetIKHintPosition(string hint, Vector3 pos)
  • bool SetIKHintPositionWeight(string hint, float weight)
  • bool SetIKPosition(string goal, Vector3 pos)
  • bool SetIKPositionWeight(string goal, float weight)
  • bool SetIKRotation(string goal, Quaternion rot)
  • bool SetIKRotationWeight(string goal, float weight)
  • bool SetInteger(string param, int value)
  • bool SetLayerWeight(int layer, float weight)
  • bool SetLookAtPosition(Vector3 pos)
  • bool SetLookAtWeight(float weight)
  • bool SetTarget(string avatarTarget)
  • bool SetTrigger(string param)
  • bool StartPlayback()
  • bool StartRecording()
  • bool StopPlayback()
  • bool StopRecording()
  • bool Update(float delta)
  • bool WriteDefaultValues()

Static methods

  • int StringToHash(string name)

Utility functions

  • bool IsAnimator(object): checks if provided value is type of Animator.

Notes

  • Inherits properties and methods from Behaviour.