Scripting API

CinemachineBrain

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

29 of 34 of Unity's members
In Tassix

Drives a Unity camera from the virtual cameras: shows the highest priority one, blending when that changes.

Fields 10

BrainUpdateMethods BlendUpdateMethod
OutputChannels ChannelMask
bool IgnoreTimeScale
LensModeOverrideSettings LensModeOverride
bool ShowCameraFrustum
bool ShowDebugText
UpdateMethods UpdateMethod
Transform? WorldUpOverride

Properties 12

CinemachineBlend? ActiveBlend { get; set; }
static int ActiveBrainCount { get; }
ICinemachineCamera? ActiveVirtualCamera { get; }
GameObject ControlledObject { get; set; }
Vector3 DefaultWorldUp { get; }
string Description { get; }
bool IsBlending { get; }
bool IsValid { get; }
string Name { get; }
Camera? OutputCamera { get; }
ICinemachineMixer? ParentCamera { get; }
CameraState State { get; }

Methods 6

static CinemachineBrain GetActiveBrain(int index)
bool IsLiveChild(ICinemachineCamera vcam, bool dominantChildOnly = false)

Whether the camera is the live one or part of the blend.

bool IsLiveInBlend(ICinemachineCamera vcam)
bool IsValidChannel(CinemachineVirtualCameraBase vcam)
void ManualUpdate()
void ManualUpdate(int currentFrame, float deltaTime)
void ResetState()

Not in Tassix yet 5

OnCameraActivated ReleaseCameraOverride SetCameraOverride TopCameraFromPriorityQueue UpdateCameraState