Corgi Engine  v8.8
MoreMountains.CorgiEngine.LevelMapPathElement Class Reference

A component to add on level maps path points More...

Inheritance diagram for MoreMountains.CorgiEngine.LevelMapPathElement:
MoreMountains.CorgiEngine.CorgiMonoBehaviour

Public Member Functions

virtual bool CanGoUp ()
 Determines whether this instance can go up. More...
 
virtual bool CanGoRight ()
 Determines whether this instance can go right. More...
 
virtual bool CanGoDown ()
 Determines whether this instance can go down. More...
 
virtual bool CanGoLeft ()
 Determines whether this instance can go left. More...
 
virtual void OnTriggerStay2D (Collider2D collider)
 Triggered when a character enters our path element More...
 
virtual void OnTriggerExit2D (Collider2D collider)
 Triggered when a character exits our path element More...
 
virtual void OnTriggerEnter2D (Collider2D collider)
 Triggered when a character enters our path element More...
 

Public Attributes

bool AutomaticMovement =false
 should the character automatically move to the next point when reaching this one More...
 
LevelMapPathElement Up
 the path element the character should go to when going up More...
 
LevelMapPathElement Right
 the path element the character should go to when going right More...
 
LevelMapPathElement Down
 the path element the character should go to when going down More...
 
LevelMapPathElement Left
 the path element the character should go to when going left More...
 

Protected Member Functions

virtual void Start ()
 Initialization More...
 
virtual void OnDrawGizmos ()
 On scene view, draws a line between a path element and the other path elements it's connected to if the connection goes both ways (you can go from A to B and from B to A using opposite directions) the line will be blue, otherwise it'll be red (useful to make sure you've connected all dots the way you wanted to More...
 

Detailed Description

A component to add on level maps path points

Member Function Documentation

◆ CanGoDown()

virtual bool MoreMountains.CorgiEngine.LevelMapPathElement.CanGoDown ( )
virtual

Determines whether this instance can go down.

Returns
true if this instance can go down; otherwise, false.

◆ CanGoLeft()

virtual bool MoreMountains.CorgiEngine.LevelMapPathElement.CanGoLeft ( )
virtual

Determines whether this instance can go left.

Returns
true if this instance can go left; otherwise, false.

◆ CanGoRight()

virtual bool MoreMountains.CorgiEngine.LevelMapPathElement.CanGoRight ( )
virtual

Determines whether this instance can go right.

Returns
true if this instance can go right; otherwise, false.

◆ CanGoUp()

virtual bool MoreMountains.CorgiEngine.LevelMapPathElement.CanGoUp ( )
virtual

Determines whether this instance can go up.

Returns
true if this instance can go up; otherwise, false.

◆ OnDrawGizmos()

virtual void MoreMountains.CorgiEngine.LevelMapPathElement.OnDrawGizmos ( )
protectedvirtual

On scene view, draws a line between a path element and the other path elements it's connected to if the connection goes both ways (you can go from A to B and from B to A using opposite directions) the line will be blue, otherwise it'll be red (useful to make sure you've connected all dots the way you wanted to

◆ OnTriggerEnter2D()

virtual void MoreMountains.CorgiEngine.LevelMapPathElement.OnTriggerEnter2D ( Collider2D  collider)
virtual

Triggered when a character enters our path element

Parameters
colliderCollider.

◆ OnTriggerExit2D()

virtual void MoreMountains.CorgiEngine.LevelMapPathElement.OnTriggerExit2D ( Collider2D  collider)
virtual

Triggered when a character exits our path element

Parameters
colliderCollider.

◆ OnTriggerStay2D()

virtual void MoreMountains.CorgiEngine.LevelMapPathElement.OnTriggerStay2D ( Collider2D  collider)
virtual

Triggered when a character enters our path element

Parameters
colliderCollider.

◆ Start()

virtual void MoreMountains.CorgiEngine.LevelMapPathElement.Start ( )
protectedvirtual

Initialization

Member Data Documentation

◆ AutomaticMovement

bool MoreMountains.CorgiEngine.LevelMapPathElement.AutomaticMovement =false

should the character automatically move to the next point when reaching this one

◆ Down

LevelMapPathElement MoreMountains.CorgiEngine.LevelMapPathElement.Down

the path element the character should go to when going down

◆ Left

LevelMapPathElement MoreMountains.CorgiEngine.LevelMapPathElement.Left

the path element the character should go to when going left

◆ Right

LevelMapPathElement MoreMountains.CorgiEngine.LevelMapPathElement.Right

the path element the character should go to when going right

◆ Up

LevelMapPathElement MoreMountains.CorgiEngine.LevelMapPathElement.Up

the path element the character should go to when going up


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