Feel  3.16
The best way to improve your game's feel and make it extra juicy
MoreMountains.Tools.MMCinemachineZone Class Reference

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...

Inheritance diagram for MoreMountains.Tools.MMCinemachineZone:
MoreMountains.Tools.MMCinemachineZone2D MoreMountains.Tools.MMCinemachineZone3D

Public Types

enum  Modes { Modes.Enable, Modes.Priority }
 

Public Attributes

Modes Mode = Modes.Enable
 whether to enable/disable virtual cameras, or to play on their priority for transitions More...
 
bool CameraStartsActive = false
 whether or not the camera in this zone should start active More...
 
int EnabledPriority = 10
 when in priority mode, the priority this camera should have when the zone is active More...
 
int DisabledPriority = 0
 when in priority mode, the priority this camera should have when the zone is inactive More...
 
LayerMask TriggerMask
 a layermask containing all the layers that should activate this zone More...
 
bool 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 More...
 
bool GenerateConfinerSetup
 a debug button used to setup the confiner on click More...
 
bool CurrentRoom = false
 whether this room is the current room or not More...
 
bool RoomVisited = false
 whether this room has already been visited or not More...
 
UnityEvent OnEnterZoneForTheFirstTimeEvent
 a UnityEvent to trigger when entering the zone for the first time More...
 
UnityEvent OnEnterZoneEvent
 a UnityEvent to trigger when entering the zone More...
 
UnityEvent OnExitZoneEvent
 a UnityEvent to trigger when exiting the zone More...
 
List< GameObject > ActivationList
 a list of gameobjects to enable when entering the zone, and disable when exiting it More...
 
bool DrawGizmos = true
 whether or not to draw shape gizmos to help visualize the zone's bounds More...
 
Color GizmosColor
 the color of the gizmos to draw in edit mode More...
 

Protected Attributes

GameObject _confinerGameObject
 
Vector3 _gizmoSize
 

Detailed Description

An abstract class that lets you define a zone that, when entered, enables a virtual camera, and takes care of all the boilerplate setup

Member Enumeration Documentation

◆ Modes

Enumerator
Enable 
Priority 

Member Data Documentation

◆ _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

Modes MoreMountains.Tools.MMCinemachineZone.Mode = Modes.Enable

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: