MoreMountains.TopDownEngine.CinemachineCameraController Class Reference

A class that handles camera follow for Cinemachine powered cameras. More...

Inheritance diagram for MoreMountains.TopDownEngine.CinemachineCameraController:

Public Member Functions
virtual void	SetTarget (Character character)
virtual void	StartFollowing ()
	Starts following the LevelManager's main player.
virtual void	StopFollowing ()
	Stops following any target.
virtual void	OnMMEvent (MMCameraEvent cameraEvent)
virtual void	OnMMEvent (TopDownEngineEvent topdownEngineEvent)
Public Member Functions inherited from MoreMountains.Tools.MMEventListener< T >
void	OnMMEvent (T eventType)

Public Attributes
bool	FollowsAPlayer = true
	Whether or not this camera should follow a player.
bool	ConfineCameraToLevelBounds = true
	Whether to confine this camera to the level bounds, as defined in the LevelManager.
bool	ListenToSetConfinerEvents = true
	If this is true, this confiner will listen to set confiner events.
Character	TargetCharacter
	the target character this camera should follow

Protected Member Functions
virtual void	Awake ()
	On Awake we grab our components.
virtual void	Start ()
	On Start we assign our bounding volume.
virtual IEnumerator	StartFollowingCo ()
virtual IEnumerator	RefreshPosition ()
virtual void	OnEnable ()
virtual void	OnDisable ()

Protected Attributes
int	_lastStopFollow = -1

Properties
virtual bool	FollowsPlayer [get, set]
	True if the camera should follow the player.

Detailed Description

A class that handles camera follow for Cinemachine powered cameras.

Member Function Documentation

Awake()

virtual void MoreMountains.TopDownEngine.CinemachineCameraController.Awake ( )

protectedvirtual

On Awake we grab our components.

OnDisable()

virtual void MoreMountains.TopDownEngine.CinemachineCameraController.OnDisable ( )

protectedvirtual

OnEnable()

virtual void MoreMountains.TopDownEngine.CinemachineCameraController.OnEnable ( )

protectedvirtual

OnMMEvent() [1/2]

virtual void MoreMountains.TopDownEngine.CinemachineCameraController.OnMMEvent ( MMCameraEvent cameraEvent )

virtual

OnMMEvent() [2/2]

virtual void MoreMountains.TopDownEngine.CinemachineCameraController.OnMMEvent ( TopDownEngineEvent topdownEngineEvent )

virtual

RefreshPosition()

virtual IEnumerator MoreMountains.TopDownEngine.CinemachineCameraController.RefreshPosition ( )

protectedvirtual

SetTarget()

virtual void MoreMountains.TopDownEngine.CinemachineCameraController.SetTarget ( Character character )

virtual

Start()

virtual void MoreMountains.TopDownEngine.CinemachineCameraController.Start ( )

protectedvirtual

On Start we assign our bounding volume.

StartFollowing()

virtual void MoreMountains.TopDownEngine.CinemachineCameraController.StartFollowing ( )

virtual

Starts following the LevelManager's main player.

StartFollowingCo()

virtual IEnumerator MoreMountains.TopDownEngine.CinemachineCameraController.StartFollowingCo ( )

protectedvirtual

StopFollowing()

virtual void MoreMountains.TopDownEngine.CinemachineCameraController.StopFollowing ( )

virtual

Stops following any target.

Member Data Documentation

_lastStopFollow

int MoreMountains.TopDownEngine.CinemachineCameraController._lastStopFollow = -1

protected

ConfineCameraToLevelBounds

bool MoreMountains.TopDownEngine.CinemachineCameraController.ConfineCameraToLevelBounds = true

Whether to confine this camera to the level bounds, as defined in the LevelManager.

FollowsAPlayer

bool MoreMountains.TopDownEngine.CinemachineCameraController.FollowsAPlayer = true

Whether or not this camera should follow a player.

ListenToSetConfinerEvents

bool MoreMountains.TopDownEngine.CinemachineCameraController.ListenToSetConfinerEvents = true

If this is true, this confiner will listen to set confiner events.

TargetCharacter

Character MoreMountains.TopDownEngine.CinemachineCameraController.TargetCharacter

the target character this camera should follow

Property Documentation

FollowsPlayer

virtual bool MoreMountains.TopDownEngine.CinemachineCameraController.FollowsPlayer

getset

True if the camera should follow the player.

---

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

• H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/Common/ScriptsCinemachine/Camera/CinemachineCameraController.cs