# Sandbox.Citizen.CitizenAnimationHelper

Used to control the Citizen animation state. You don't have to use this to animate your citizen avatar, but our
aim is to put everything you need in this class, so you can easily see what variables are available.

- Kind: class
- Namespace: `Sandbox.Citizen`
- Assembly: `Sandbox.Engine`
- Inherits: [Sandbox.Component](/api/Sandbox.Component)
- Modifiers: sealed

## Constructors

- [`CitizenAnimationHelper`](/api/Sandbox.Citizen.CitizenAnimationHelper/.ctor)

## Properties

- [`AimAngle`](/api/Sandbox.Citizen.CitizenAnimationHelper/AimAngle): Where are we aiming?
- [`AimBodyWeight`](/api/Sandbox.Citizen.CitizenAnimationHelper/AimBodyWeight): The weight of the aim angle, but specifically for the Citizen's body.
- [`AimEyesWeight`](/api/Sandbox.Citizen.CitizenAnimationHelper/AimEyesWeight): The weight of the aim angle, but specifically for the Citizen's eyes.
- [`AimHeadWeight`](/api/Sandbox.Citizen.CitizenAnimationHelper/AimHeadWeight): The weight of the aim angle, but specifically for the Citizen's head.
- [`BodyWeight`](/api/Sandbox.Citizen.CitizenAnimationHelper/BodyWeight)
- [`DuckLevel`](/api/Sandbox.Citizen.CitizenAnimationHelper/DuckLevel): The scale of being ducked (crouched) (0 - 1)
- [`EyeSource`](/api/Sandbox.Citizen.CitizenAnimationHelper/EyeSource): Where are the eyes of our character?
- [`EyesWeight`](/api/Sandbox.Citizen.CitizenAnimationHelper/EyesWeight)
- [`EyeWorldTransform`](/api/Sandbox.Citizen.CitizenAnimationHelper/EyeWorldTransform): The transform of the eyes, in world space. This is worked out from EyeSource is it's set.
- [`FootShuffle`](/api/Sandbox.Citizen.CitizenAnimationHelper/FootShuffle)
- [`Handedness`](/api/Sandbox.Citizen.CitizenAnimationHelper/Handedness): What's the handedness of our weapon? Left handed, right handed, or both hands? This is only supported by some holdtypes, like Pistol, HoldItem.
- [`HeadWeight`](/api/Sandbox.Citizen.CitizenAnimationHelper/HeadWeight)
- [`Height`](/api/Sandbox.Citizen.CitizenAnimationHelper/Height): How tall are we?
- [`HoldType`](/api/Sandbox.Citizen.CitizenAnimationHelper/HoldType): What kind of weapon are we holding?
- [`IkLeftFoot`](/api/Sandbox.Citizen.CitizenAnimationHelper/IkLeftFoot)
- [`IkLeftHand`](/api/Sandbox.Citizen.CitizenAnimationHelper/IkLeftHand): IK will try to place the limb where this GameObject is in the world.
- [`IkRightFoot`](/api/Sandbox.Citizen.CitizenAnimationHelper/IkRightFoot)
- [`IkRightHand`](/api/Sandbox.Citizen.CitizenAnimationHelper/IkRightHand)
- [`IsClimbing`](/api/Sandbox.Citizen.CitizenAnimationHelper/IsClimbing): Are we climbing?
- [`IsGrounded`](/api/Sandbox.Citizen.CitizenAnimationHelper/IsGrounded): Are we on the ground?
- [`IsNoclipping`](/api/Sandbox.Citizen.CitizenAnimationHelper/IsNoclipping): Are we noclipping?
- [`IsSitting`](/api/Sandbox.Citizen.CitizenAnimationHelper/IsSitting): Are we sitting down?
- [`IsSwimming`](/api/Sandbox.Citizen.CitizenAnimationHelper/IsSwimming): Are we swimming?
- [`IsWeaponLowered`](/api/Sandbox.Citizen.CitizenAnimationHelper/IsWeaponLowered): Is the weapon lowered? By default, this'll happen when the character hasn't been shooting for a while.
- [`LookAt`](/api/Sandbox.Citizen.CitizenAnimationHelper/LookAt): Which GameObject should the head/body rotate towards? Eyes will also use this unless a separate eye target is set.
- [`LookAtEnabled`](/api/Sandbox.Citizen.CitizenAnimationHelper/LookAtEnabled): Are we looking at something? Useful for stuff like cutscenes, where you want an NPC to stare at you.
- [`LookAtEyes`](/api/Sandbox.Citizen.CitizenAnimationHelper/LookAtEyes): Optional separate target for eye direction. If not set, the eyes will follow the main Look At target.
- [`MoveRotationSpeed`](/api/Sandbox.Citizen.CitizenAnimationHelper/MoveRotationSpeed): How much the character is rotating in degrees per second, this controls feet shuffling. If rotating clockwise this should be positive, if rotating counter-clockwise this should be negative.
- [`MoveStyle`](/api/Sandbox.Citizen.CitizenAnimationHelper/MoveStyle): We can force the model to walk or run, or let it decide based on the speed.
- [`Sitting`](/api/Sandbox.Citizen.CitizenAnimationHelper/Sitting): How are we sitting down?
- [`SittingOffsetHeight`](/api/Sandbox.Citizen.CitizenAnimationHelper/SittingOffsetHeight): How far up are we sitting down from the floor?
- [`SpecialMove`](/api/Sandbox.Citizen.CitizenAnimationHelper/SpecialMove): We can force the model to have a specific movement state, instead of just running around. [Sandbox.Citizen.CitizenAnimationHelper.SpecialMoveStyle.LedgeGrab](/api/Sandbox.Citizen.CitizenAnimationHelper.SpecialMoveStyle/LedgeGrab) is good for shimmying across a ledge. [Sandbox.Citizen.CitizenAnimationHelper.SpecialMoveStyle.Roll](/api/Sandbox.Citizen.CitizenAnimationHelper.SpecialMoveStyle/Roll) is good for a platformer game where the character is rolling around continuously. [Sandbox.Citizen.CitizenAnimationHelper.SpecialMoveStyle.Slide](/api/Sandbox.Citizen.CitizenAnimationHelper.SpecialMoveStyle/Slide) is good for a shooter game or a platformer where the character is sliding.
- [`Target`](/api/Sandbox.Citizen.CitizenAnimationHelper/Target): The skinned model renderer that we'll apply all parameters to.
- [`VoiceLevel`](/api/Sandbox.Citizen.CitizenAnimationHelper/VoiceLevel): How loud are we talking?

## Methods

- [`ProceduralHitReaction`](/api/Sandbox.Citizen.CitizenAnimationHelper/ProceduralHitReaction)
- [`TriggerDeploy`](/api/Sandbox.Citizen.CitizenAnimationHelper/TriggerDeploy): Triggers a weapon deploy animation
- [`TriggerJump`](/api/Sandbox.Citizen.CitizenAnimationHelper/TriggerJump): Triggers a jump animation
- [`WithLook`](/api/Sandbox.Citizen.CitizenAnimationHelper/WithLook): Have the player look at this point in the world
- [`WithVelocity`](/api/Sandbox.Citizen.CitizenAnimationHelper/WithVelocity): Have the player animate moving with a set velocity (this doesn't move them! Your character controller is responsible for that)
- [`WithWishVelocity`](/api/Sandbox.Citizen.CitizenAnimationHelper/WithWishVelocity): Animates the wish for the character to move in a certain direction. For example, when in the air, your character will swing their arms in that direction.