An abstract class that lets you define a zone that, when entered, enables a virtual camera, and takes care of all the boilerplate setup
More...
An abstract class that lets you define a zone that, when entered, enables a virtual camera, and takes care of all the boilerplate setup
◆ Modes
Enumerator |
---|
Enable | |
Priority | |
◆ AlwaysInitialization()
virtual void MoreMountains.Tools.MMCinemachineZone.AlwaysInitialization |
( |
| ) |
|
|
protectedvirtual |
On Awake we initialize our collider
◆ Awake()
virtual void MoreMountains.Tools.MMCinemachineZone.Awake |
( |
| ) |
|
|
protectedvirtual |
On Awake we proceed to init if app is playing
◆ EnableCamera()
virtual IEnumerator MoreMountains.Tools.MMCinemachineZone.EnableCamera |
( |
bool |
state, |
|
|
int |
frames |
|
) |
| |
|
protectedvirtual |
Enables the camera, either via enabled state or priority
- Parameters
-
- Returns
◆ EnterZone()
virtual void MoreMountains.Tools.MMCinemachineZone.EnterZone |
( |
| ) |
|
|
protectedvirtual |
◆ ExitZone()
virtual void MoreMountains.Tools.MMCinemachineZone.ExitZone |
( |
| ) |
|
|
protectedvirtual |
◆ Initialization()
virtual void MoreMountains.Tools.MMCinemachineZone.Initialization |
( |
| ) |
|
|
protectedvirtual |
On init we grab our virtual camera
◆ InitializeCollider()
abstract void MoreMountains.Tools.MMCinemachineZone.InitializeCollider |
( |
| ) |
|
|
protectedpure virtual |
◆ ManualSetupConfiner()
virtual void MoreMountains.Tools.MMCinemachineZone.ManualSetupConfiner |
( |
| ) |
|
|
protectedvirtual |
A method used to manually create a confiner
◆ Reset()
virtual void MoreMountains.Tools.MMCinemachineZone.Reset |
( |
| ) |
|
|
protectedvirtual |
On Reset we initialize our gizmo color
◆ SetupConfiner()
abstract void MoreMountains.Tools.MMCinemachineZone.SetupConfiner |
( |
| ) |
|
|
protectedpure virtual |
◆ SetupConfinerGameObject()
virtual void MoreMountains.Tools.MMCinemachineZone.SetupConfinerGameObject |
( |
| ) |
|
|
protectedvirtual |
Creates an object to host the confiner
◆ Start()
virtual void MoreMountains.Tools.MMCinemachineZone.Start |
( |
| ) |
|
|
protectedvirtual |
On Start we setup the confiner
◆ TestCollidingGameObject()
virtual bool MoreMountains.Tools.MMCinemachineZone.TestCollidingGameObject |
( |
GameObject |
collider | ) |
|
|
protectedvirtual |
An extra test you can override to add extra collider conditions
- Parameters
-
- Returns
◆ _confinerGameObject
GameObject MoreMountains.Tools.MMCinemachineZone._confinerGameObject |
|
protected |
◆ _gizmoSize
Vector3 MoreMountains.Tools.MMCinemachineZone._gizmoSize |
|
protected |
◆ ActivationList
List<GameObject> MoreMountains.Tools.MMCinemachineZone.ActivationList |
a list of gameobjects to enable when entering the zone, and disable when exiting it
◆ CameraStartsActive
bool MoreMountains.Tools.MMCinemachineZone.CameraStartsActive = false |
whether or not the camera in this zone should start active
◆ CurrentRoom
bool MoreMountains.Tools.MMCinemachineZone.CurrentRoom = false |
whether this room is the current room or not
◆ DisabledPriority
int MoreMountains.Tools.MMCinemachineZone.DisabledPriority = 0 |
when in priority mode, the priority this camera should have when the zone is inactive
◆ DrawGizmos
bool MoreMountains.Tools.MMCinemachineZone.DrawGizmos = true |
whether or not to draw shape gizmos to help visualize the zone's bounds
◆ EnabledPriority
int MoreMountains.Tools.MMCinemachineZone.EnabledPriority = 10 |
when in priority mode, the priority this camera should have when the zone is active
◆ GenerateConfinerSetup
bool MoreMountains.Tools.MMCinemachineZone.GenerateConfinerSetup |
a debug button used to setup the confiner on click
◆ GizmosColor
Color MoreMountains.Tools.MMCinemachineZone.GizmosColor |
the color of the gizmos to draw in edit mode
◆ Mode
whether to enable/disable virtual cameras, or to play on their priority for transitions
◆ OnEnterZoneEvent
UnityEvent MoreMountains.Tools.MMCinemachineZone.OnEnterZoneEvent |
a UnityEvent to trigger when entering the zone
◆ OnEnterZoneForTheFirstTimeEvent
UnityEvent MoreMountains.Tools.MMCinemachineZone.OnEnterZoneForTheFirstTimeEvent |
a UnityEvent to trigger when entering the zone for the first time
◆ OnExitZoneEvent
UnityEvent MoreMountains.Tools.MMCinemachineZone.OnExitZoneEvent |
a UnityEvent to trigger when exiting the zone
◆ RoomVisited
bool MoreMountains.Tools.MMCinemachineZone.RoomVisited = false |
whether this room has already been visited or not
◆ SetupConfinerOnStart
bool MoreMountains.Tools.MMCinemachineZone.SetupConfinerOnStart = false |
whether or not the zone should auto setup its camera's confiner on start - alternative is to manually click the ManualSetupConfiner, or do your own setup
◆ TriggerMask
LayerMask MoreMountains.Tools.MMCinemachineZone.TriggerMask |
a layermask containing all the layers that should activate this zone
The documentation for this class was generated from the following file:
- F:/Github/Store/TopDownEngine/Assets/TopDownEngine/ThirdParty/MoreMountains/MMTools/Accessories/MMCinemachine/MMCinemachineZone/MMCinemachineZone.cs