Corgi Engine v9.4
Loading...
Searching...
No Matches
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.
override void SetupConfiner ()
 Creates and sets up the camera's confiner.
virtual void CopyCollider ()
 Copies the initial collider to the composite.
virtual void OnTriggerEnter (Collider collider)
 On enter, enables the camera and triggers the enter event.
virtual void OnTriggerExit (Collider collider)
 On exit, disables the camera and invokes the exit event.
Protected Member Functions inherited from MoreMountains.Tools.MMCinemachineZone
virtual void Awake ()
 On Awake we proceed to init if app is playing.
virtual void AlwaysInitialization ()
 On Awake we initialize our collider.
virtual void Initialization ()
 On init we grab our virtual camera.
virtual void Start ()
 On Start we setup the confiner.
void InitializeCollider ()
 Describes what happens when initializing the collider.
void SetupConfiner ()
 Describes what happens when setting up the confiner.
virtual void ManualSetupConfiner ()
 A method used to manually create a confiner.
virtual void SetupConfinerGameObject ()
 Creates an object to host the confiner.
virtual bool TestCollidingGameObject (GameObject collider)
 An extra test you can override to add extra collider conditions.
virtual IEnumerator EnableCamera (bool state, int frames)
 Enables the camera, either via enabled state or priority.
virtual void EnterZone ()
virtual void ExitZone ()
virtual void Reset ()
 On Reset we initialize our gizmo color.

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

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 ( )
protected

Gets and sets up the colliders.

◆ 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 ( )
protected

Creates and sets up the camera's confiner.

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:
  • Assets/CorgiEngine/ThirdParty/MoreMountains/MMTools/Accessories/MMCinemachine/MMCinemachineZone/MMCinemachineZone3D.cs