TopDown Engine  v4.2
MoreMountains.Tools.MMCinemachineZone Class Referenceabstract

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 MoreMountains.TopDownEngine.TopDownCinemachineZone2D MoreMountains.TopDownEngine.TopDownCinemachineZone3D

Public Types

enum  Modes { Modes.Enable, Modes.Priority }
 

Public Attributes

Modes Mode = Modes.Priority
 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 Member Functions

virtual void Awake ()
 On Awake we proceed to init if app is playing More...
 
virtual void AlwaysInitialization ()
 On Awake we initialize our collider More...
 
virtual void Initialization ()
 On init we grab our virtual camera More...
 
virtual void Start ()
 On Start we setup the confiner More...
 
abstract void InitializeCollider ()
 Describes what happens when initializing the collider More...
 
abstract void SetupConfiner ()
 Describes what happens when setting up the confiner More...
 
virtual void ManualSetupConfiner ()
 A method used to manually create a confiner More...
 
virtual void SetupConfinerGameObject ()
 Creates an object to host the confiner More...
 
virtual bool TestCollidingGameObject (GameObject collider)
 An extra test you can override to add extra collider conditions More...
 
virtual IEnumerator EnableCamera (bool state, int frames)
 Enables the camera, either via enabled state or priority More...
 
virtual void EnterZone ()
 
virtual void ExitZone ()
 
virtual void Reset ()
 On Reset we initialize our gizmo color 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 Function Documentation

◆ 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
state
frames
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

Describes what happens when initializing the collider

Implemented in MoreMountains.Tools.MMCinemachineZone2D, and MoreMountains.Tools.MMCinemachineZone3D.

◆ 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

Describes what happens when setting up the confiner

Implemented in MoreMountains.Tools.MMCinemachineZone2D, and MoreMountains.Tools.MMCinemachineZone3D.

◆ 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
collider
Returns

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

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: