API Reference

This section is generated from the public Creature Kit Beast runtime and animation APIs.

The main animation entry point is CreatureKit.Beasts.Animation.BeastAnimator. CharacterController ground adaptation uses CreatureKit.Beasts.BeastCharacterGroundAlignment.

For authoring ranges and usage guidance, see Channel Animation, Clip Animation, No-Code Integration, and Beast Ground Alignment.

Ground Alignment

BeastCharacterGroundAlignment

• Controller
• FitControllerToBeast()
• GetDesiredGroundUp(float)
• ProjectVelocityOnGround(Vector3, Vector3)
• RotateControllerTowards(Vector3, float, float)
• AlignVisualToGround(Vector3, Vector3, float, float)
• DrawGroundProbeDebugLines()

Beast Animation

BeastAnimator

Component Basics

• BeastAnimator()
• CurrentAnimation
• ClipIsPlaying
• ResetPose()

Clip Control

Clip methods start and stop high-level Beast actions. They use BeastAnimationClip.

• Play(BeastAnimationClip)
• Stop()
• PlayIdle()
• PlayWalk()
• PlayRush()
• PlaySearchRun()
• PlayWait()
• PlayStunned()
• PlayTakeoff()
• PlayLanding()
• SetWalkSpeed(float)
• SetRushSpeed(float)
• SetSearchRunSpeed(float)
• Idle
• Walk
• Rush
• SearchRun
• Wait
• Stunned
• Takeoff
• Landing

Channel Control

Channel methods drive or release one animated part family. Channel selection uses BeastAnimationChannels.

• ResetChannels(BeastAnimationChannels)
• ClaimChannels(BeastAnimationChannels)
• ReleaseChannels(BeastAnimationChannels)
• AnimateEyeLookSideToSide(float, float, float, float)
• SetEyeLookPose(float, float, float)
• SetEyeLookPose(int, float, float, float)
• ResetEyeLookPose(int)
• SetEyeOpeningPose(float)
• SetEyeOpeningPose(int, float)
• ResetEyeOpeningPose(int)
• GetLastEyeIndex()
• StopEyeAnimation()
• AnimateEarFlap(float, float, float, float, float, float)
• SetEarPose(float, float, float, float)
• SetEarPose(int, float, float, float, float)
• ResetEarPose(int)
• GetLastEarIndex()
• StopEarAnimation()
• AnimateBodyMotion(float, float, float, float, float, float, float, float, float, float)
• SetBodyPose(float, float, float, float, float)
• ResetBodyPose()
• StopBodyAnimation()
• AnimateHeadMotion(float, float, float, float, float, float, float, bool, float, float, float, float)
• SetHeadPose(float, float, float, float, float)
• ResetHeadPose()
• StopHeadAnimation()
• AnimateTailSway(float, float, float, float, float, float)
• SetTailPose(float, float, float, float)
• SetTailPose(int, float, float, float, float)
• ResetTailPose(int)
• GetLastTailIndex()
• StopTailAnimation()
• AnimateMouthOpenClose(float, float, float, float)
• SetMouthOpeningPose(float, float)
• ResetMouthOpeningPose()
• StopMouthAnimation()
• AnimateNeckMotion(float, float, float, float, float, float, float, bool, float, float)
• SetNeckPose(float, float, float, float)
• ResetNeckPose()
• StopNeckAnimation()
• SetLegPose(int, float, float, float, float)
• ResetLegPose(int)
• GetLastLegIndex()

Supporting Types

• BeastAnimationClip
• BeastAnimationChannels

No-Code Bridge

• BeastAnimationBridge
• BeastClipStateBehaviour

Clip Settings

• BeastIdleSettings
• BeastWalkSettings
• BeastRushSettings
• BeastSearchRunSettings
• BeastWaitSettings
• BeastStunnedSettings
• BeastTakeoffSettings
• BeastLandingSettings

Namespace

• CreatureKit.Beasts.Animation