Class Cinemachine3rdPersonFollow
Third-person follower, with complex pivoting: horizontal about the origin, vertical about the shoulder.
Inheritance
Implements
Inherited Members
Namespace: Unity.Cinemachine
Assembly: solution.dll
Syntax
[Obsolete("Cinemachine3rdPersonFollow has been deprecated. Use CinemachineThirdPersonFollow instead")]
[CameraPipeline(CinemachineCore.Stage.Body)]
[AddComponentMenu("")]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.cinemachine@3.0/manual/Cinemachine3rdPersonFollow.html")]
public class Cinemachine3rdPersonFollow : CinemachineComponentBase, CinemachineFreeLookModifier.IModifierValueSource, CinemachineFreeLookModifier.IModifiablePositionDamping, CinemachineFreeLookModifier.IModifiableDistance
Fields
Name | Description |
---|---|
CameraDistance | How far behind the hand the camera will be placed. |
CameraSide | Specifies which shoulder (left, right, or in-between) the camera is on. |
Damping | How responsively the camera tracks the target. Each axis (camera-local) can have its own setting. Value is the approximate time it takes the camera to catch up to the target's new position. Smaller values give a more rigid effect, larger values give a squishier one. |
ShoulderOffset | Position of the shoulder pivot relative to the Follow target origin. |
VerticalArmLength | Vertical offset of the hand in relation to the shoulder. |
Properties
Name | Description |
---|---|
IsValid | True if component is enabled and has a Follow target defined |
Stage | Get the Cinemachine Pipeline stage that this component implements. Always returns the Aim stage |
Methods
Name | Description |
---|---|
GetRigPositions(out Vector3, out Vector3, out Vector3) | Internal use only. Public for the inspector gizmo |
MutateCameraState(ref CameraState, float) | Orients the camera to match the Follow target's orientation |
OnTargetObjectWarped(Transform, Vector3) | This is called to notify the user that a target got warped, so that we can update its internal state to make the camera also warp seamlessly. |