Interface ICameraOverrideStack
This interface is specifically for Timeline. Do not use it.
Namespace: Cinemachine
Assembly: Cinemachine.dll
Syntax
public interface ICameraOverrideStackProperties
DefaultWorldUp
Get the current definition of Up. May be different from Vector3.up.
Declaration
Vector3 DefaultWorldUp { get; }Property Value
| Type | Description |
|---|---|
| Vector3 |
Methods
ReleaseCameraOverride(int)
See SetCameraOverride. Call ReleaseCameraOverride after all overriding is finished, to free the OverrideStack resources.
Declaration
void ReleaseCameraOverride(int overrideId)Parameters
| Type | Name | Description |
|---|---|---|
| int | overrideId | The ID to released. This is the value that was returned by SetCameraOverride |
SetCameraOverride(int, ICinemachineCamera, ICinemachineCamera, float, float)
Override the current camera and current blend. This setting will trump any in-game logic that sets virtual camera priorities and Enabled states. This is the main API for the timeline.
Declaration
int SetCameraOverride(int overrideId, ICinemachineCamera camA, ICinemachineCamera camB, float weightB, float deltaTime)Parameters
| Type | Name | Description |
|---|---|---|
| int | overrideId | Id to represent a specific client. An internal stack is maintained, with the most recent non-empty override taking precenence. This id must be > 0. If you pass -1, a new id will be created, and returned. Use that id for subsequent calls. Don't forget to call ReleaseCameraOverride after all overriding is finished, to free the OverideStack resources. |
| ICinemachine |
camA | The camera to set, corresponding to weight=0. |
| ICinemachine |
camB | The camera to set, corresponding to weight=1. |
| float | weightB | The blend weight. 0=camA, 1=camB. |
| float | deltaTime | Override for deltaTime. Should be Time.FixedDelta for time-based calculations to be included, -1 otherwise. |
Returns
| Type | Description |
|---|---|
| int | The override ID. Don't forget to call ReleaseCameraOverride after all overriding is finished, to free the OverideStack resources. |