Scripting API

CinemachineVirtualCameraBase

class in Unity.Cinemachine · Unity.Cinemachine · inherits from MonoBehaviour

39 of 49 of Unity's members
In Tassix

A virtual camera: a pose and lens computed each frame by its pipeline (body, aim and noise components, then extensions), which a brain shows when it's the highest-priority one.

Fields 5

float FollowTargetAttachment
float LookAtTargetAttachment
OutputChannels OutputChannel
StandbyUpdateMode StandbyUpdate

Properties 13

virtual string Description { get; }
abstract Transform? Follow { get; set; }
CinemachineVirtualCameraBase? FollowTargetAsVcam { get; }
bool FollowTargetChanged { get; }
bool IsLive { get; }
virtual bool IsValid { get; }
abstract Transform? LookAt { get; set; }
CinemachineVirtualCameraBase? LookAtTargetAsVcam { get; }
bool LookAtTargetChanged { get; }
string Name { get; }
ICinemachineMixer? ParentCamera { get; }
bool PreviousStateIsValid { get; set; }

False until the camera has a state to damp from (after an update, unless reset).

abstract CameraState State { get; }

Methods 16

void CancelDamping(bool updateNow = false)
float DetachedFollowTargetDamp(float initial, float dampTime, float deltaTime)
Vector3 DetachedFollowTargetDamp(Vector3 initial, Vector3 dampTime, float deltaTime)
Vector3 DetachedFollowTargetDamp(Vector3 initial, float dampTime, float deltaTime)
float DetachedLookAtTargetDamp(float initial, float dampTime, float deltaTime)
Vector3 DetachedLookAtTargetDamp(Vector3 initial, Vector3 dampTime, float deltaTime)
Vector3 DetachedLookAtTargetDamp(Vector3 initial, float dampTime, float deltaTime)
virtual void ForceCameraPosition(Vector3 pos, Quaternion rot)
virtual CinemachineComponentBase? GetCinemachineComponent(CinemachineCore.Stage stage)
virtual float GetMaxDampTime()
abstract void InternalUpdateCameraState(Vector3 worldUp, float deltaTime)
bool IsParticipatingInBlend()
void MoveToTopOfPrioritySubqueue()
virtual void OnTargetObjectWarped(Transform target, Vector3 positionDelta)
virtual void OnTransitionFromCamera(ICinemachineCamera? fromCam, Vector3 worldUp, float deltaTime)

Called when this camera goes live, with the camera it takes over from.

void Prioritize()
virtual Transform? ResolveFollow(Transform? localFollow)
virtual Transform? ResolveLookAt(Transform? localLookAt)
void UpdateCameraState(Vector3 worldUp, float deltaTime)

Updates the state once per frame (per update phase).

void UpdateTargetCache()

Not in Tassix yet 10

FollowTargetAsGroup InvokeOnTransitionInExtensions IsDprecated LookAtTargetAsGroup OnCameraActivated OnDestroy OnTransformParentChanged PerformLegacyUpgrade Start Update