Feel  4.3
The best way to improve your game's feel and make it extra juicy
Protected Member Functions | Protected Attributes | List of all members
MoreMountains.Tools.MMCinemachineZone3D Class Reference

3D Implementation of the CinemachineZone abstract class More...

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

Protected Member Functions

override void InitializeCollider ()
 Gets and sets up the colliders More...
 
override void SetupConfiner ()
 Creates and sets up the camera's confiner More...
 
virtual void CopyCollider ()
 Copies the initial collider to the composite More...
 
virtual void OnTriggerEnter (Collider collider)
 On enter, enables the camera and triggers the enter event More...
 
virtual void OnTriggerExit (Collider collider)
 On exit, disables the camera and invokes the exit event More...
 
- Protected Member Functions inherited from MoreMountains.Tools.MMCinemachineZone
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...
 
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

Collider _collider
 
Collider _confinerCollider
 
Rigidbody _confinerRigidbody
 
BoxCollider _boxCollider
 
SphereCollider _sphereCollider
 
- Protected Attributes inherited from MoreMountains.Tools.MMCinemachineZone
GameObject _confinerGameObject
 
Vector3 _gizmoSize
 

Additional Inherited Members

- Public Types inherited from MoreMountains.Tools.MMCinemachineZone
enum  Modes { Modes.Enable, Modes.Priority }
 
- Public Attributes inherited from MoreMountains.Tools.MMCinemachineZone
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...
 

Detailed Description

3D Implementation of the CinemachineZone abstract class

Member Function Documentation

◆ CopyCollider()

virtual void MoreMountains.Tools.MMCinemachineZone3D.CopyCollider ( )
protectedvirtual

Copies the initial collider to the composite

◆ InitializeCollider()

override void MoreMountains.Tools.MMCinemachineZone3D.InitializeCollider ( )
protectedvirtual

Gets and sets up the colliders

Implements MoreMountains.Tools.MMCinemachineZone.

◆ OnTriggerEnter()

virtual void MoreMountains.Tools.MMCinemachineZone3D.OnTriggerEnter ( Collider  collider)
protectedvirtual

On enter, enables the camera and triggers the enter event

Parameters
collider

◆ OnTriggerExit()

virtual void MoreMountains.Tools.MMCinemachineZone3D.OnTriggerExit ( Collider  collider)
protectedvirtual

On exit, disables the camera and invokes the exit event

Parameters
collider

◆ SetupConfiner()

override void MoreMountains.Tools.MMCinemachineZone3D.SetupConfiner ( )
protectedvirtual

Creates and sets up the camera's confiner

Implements MoreMountains.Tools.MMCinemachineZone.

Member Data Documentation

◆ _boxCollider

BoxCollider MoreMountains.Tools.MMCinemachineZone3D._boxCollider
protected

◆ _collider

Collider MoreMountains.Tools.MMCinemachineZone3D._collider
protected

◆ _confinerCollider

Collider MoreMountains.Tools.MMCinemachineZone3D._confinerCollider
protected

◆ _confinerRigidbody

Rigidbody MoreMountains.Tools.MMCinemachineZone3D._confinerRigidbody
protected

◆ _sphereCollider

SphereCollider MoreMountains.Tools.MMCinemachineZone3D._sphereCollider
protected
The documentation for this class was generated from the following file: