TopDown Engine  v4.2
MoreMountains.TopDownEngine.CheckPoint Class Reference

Checkpoint class. Will make the player respawn at this point if it dies. More...

Inheritance diagram for MoreMountains.TopDownEngine.CheckPoint:
MoreMountains.TopDownEngine.TopDownMonoBehaviour MoreMountains.Tools.MMMonoBehaviour

Public Member Functions

virtual void SpawnPlayer (Character player)
 Spawns the player at the checkpoint. More...
 
virtual void AssignObjectToCheckPoint (Respawnable listener)
 Assigns the Respawnable to this checkpoint More...
 

Public Attributes

Character.FacingDirections FacingDirection = Character.FacingDirections.East
 the facing direction the character should face when spawning from this checkpoint More...
 
bool ForceAssignation = false
 whether or not this checkpoint should override any order and assign itself on entry More...
 
int CheckPointOrder
 the order of the checkpoint More...
 

Protected Member Functions

virtual void Awake ()
 Initializes the list of listeners More...
 
virtual void OnTriggerEnter2D (Collider2D collider)
 Describes what happens when something enters the checkpoint More...
 
virtual void OnTriggerEnter (Collider collider)
 
virtual void TriggerEnter (GameObject collider)
 
virtual void OnDrawGizmos ()
 On DrawGizmos, we draw lines to show the path the object will follow More...
 

Protected Attributes

List< Respawnable_listeners
 

Detailed Description

Checkpoint class. Will make the player respawn at this point if it dies.

Member Function Documentation

◆ AssignObjectToCheckPoint()

virtual void MoreMountains.TopDownEngine.CheckPoint.AssignObjectToCheckPoint ( Respawnable  listener)
virtual

Assigns the Respawnable to this checkpoint

Parameters
listener

◆ Awake()

virtual void MoreMountains.TopDownEngine.CheckPoint.Awake ( )
protectedvirtual

Initializes the list of listeners

◆ OnDrawGizmos()

virtual void MoreMountains.TopDownEngine.CheckPoint.OnDrawGizmos ( )
protectedvirtual

On DrawGizmos, we draw lines to show the path the object will follow

◆ OnTriggerEnter()

virtual void MoreMountains.TopDownEngine.CheckPoint.OnTriggerEnter ( Collider  collider)
protectedvirtual

◆ OnTriggerEnter2D()

virtual void MoreMountains.TopDownEngine.CheckPoint.OnTriggerEnter2D ( Collider2D  collider)
protectedvirtual

Describes what happens when something enters the checkpoint

Parameters
colliderSomething colliding with the water.

◆ SpawnPlayer()

virtual void MoreMountains.TopDownEngine.CheckPoint.SpawnPlayer ( Character  player)
virtual

Spawns the player at the checkpoint.

Parameters
playerPlayer.

◆ TriggerEnter()

virtual void MoreMountains.TopDownEngine.CheckPoint.TriggerEnter ( GameObject  collider)
protectedvirtual

Member Data Documentation

◆ _listeners

List<Respawnable> MoreMountains.TopDownEngine.CheckPoint._listeners
protected

◆ CheckPointOrder

int MoreMountains.TopDownEngine.CheckPoint.CheckPointOrder

the order of the checkpoint

◆ FacingDirection

Character.FacingDirections MoreMountains.TopDownEngine.CheckPoint.FacingDirection = Character.FacingDirections.East

the facing direction the character should face when spawning from this checkpoint

◆ ForceAssignation

bool MoreMountains.TopDownEngine.CheckPoint.ForceAssignation = false

whether or not this checkpoint should override any order and assign itself on entry


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