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:

Public Types
enum	Modes { Enable , Priority }

Public Attributes
CinemachineVirtualCamera	VirtualCamera
	the virtual camera associated to this zone (will try to grab one in children if none is set) More...

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

UnityEvent	OnEnterZoneEvent
	a UnityEvent to trigger when entering the zone More...

UnityEvent	OnExitZoneEvent
	a UnityEvent to trigger when exiting the zone 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 IEnumerator	EnableCamera (bool state, int frames)
	Enables the camera, either via enabled state or priority More...

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

enum MoreMountains.Tools.MMCinemachineZone.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

◆ 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

Member Data Documentation

◆ _confinerGameObject

GameObject MoreMountains.Tools.MMCinemachineZone._confinerGameObject

protected

◆ _gizmoSize

Vector3 MoreMountains.Tools.MMCinemachineZone._gizmoSize

protected

◆ CameraStartsActive

bool MoreMountains.Tools.MMCinemachineZone.CameraStartsActive = false

whether or not the camera in this zone should start active

◆ 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

◆ OnExitZoneEvent

UnityEvent MoreMountains.Tools.MMCinemachineZone.OnExitZoneEvent

a UnityEvent to trigger when exiting the zone

◆ 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

◆ VirtualCamera

CinemachineVirtualCamera MoreMountains.Tools.MMCinemachineZone.VirtualCamera

the virtual camera associated to this zone (will try to grab one in children if none is set)

The documentation for this class was generated from the following file:

E:/Github/Store/HighroadEngine/Assets/HighroadEngine/MMTools/ToolsForCinemachine/MMCinemachineZone/MMCinemachineZone.cs

Public Types

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Modes

Member Function Documentation

◆ AlwaysInitialization()

◆ Awake()

◆ EnableCamera()

◆ Initialization()

◆ InitializeCollider()

◆ ManualSetupConfiner()

◆ Reset()

◆ SetupConfiner()

◆ SetupConfinerGameObject()

◆ Start()

Member Data Documentation

◆ _confinerGameObject

◆ _gizmoSize

◆ CameraStartsActive

◆ DisabledPriority

◆ DrawGizmos

◆ EnabledPriority

◆ GenerateConfinerSetup

◆ GizmosColor

◆ Mode

◆ OnEnterZoneEvent

◆ OnExitZoneEvent

◆ SetupConfinerOnStart

◆ TriggerMask

◆ VirtualCamera