MoreMountains.TopDownEngine.DungeonDoor Class Reference

A class used in the Koala demo to handle the dungeon doors. More...

Inheritance diagram for MoreMountains.TopDownEngine.DungeonDoor:

Public Types
enum	DoorStates { Open , Closed }
	the possible states of the door More...

Public Member Functions
virtual void	OpenDoor ()
	Opens the door.
virtual void	CloseDoor ()
	Closes the door.
virtual void	ToggleDoor ()
	Opens or closes the door based on its current status.

Public Attributes
GameObject	OpenDoorTop
	the top part of the door
GameObject	OpenDoorBottom
	the bottom part of the door
GameObject	ClosedDoor
	the object to show when the door is closed
DoorStates	DoorState = DoorStates.Open
	the current state of the door
bool	ToogleDoorButton
	a test button to toggle the door open or closed
bool	OpenDoorButton
	a test button to open the door
bool	CloseDoorButton
	a test button to close the door

Protected Member Functions
virtual void	Start ()
	On Start we initialize our door based on its initial status.
virtual void	Update ()
	On Update, we open or close the door if needed.
virtual void	SetDoorClosed ()
	Closes the door.
virtual void	SetDoorOpen ()
	Opens the door.

Detailed Description

A class used in the Koala demo to handle the dungeon doors.

Member Enumeration Documentation

DoorStates

enum MoreMountains.TopDownEngine.DungeonDoor.DoorStates

the possible states of the door

Enumerator
Open
Closed

Member Function Documentation

CloseDoor()

virtual void MoreMountains.TopDownEngine.DungeonDoor.CloseDoor ( )

virtual

Closes the door.

OpenDoor()

virtual void MoreMountains.TopDownEngine.DungeonDoor.OpenDoor ( )

virtual

Opens the door.

SetDoorClosed()

virtual void MoreMountains.TopDownEngine.DungeonDoor.SetDoorClosed ( )

protectedvirtual

Closes the door.

SetDoorOpen()

virtual void MoreMountains.TopDownEngine.DungeonDoor.SetDoorOpen ( )

protectedvirtual

Opens the door.

Start()

virtual void MoreMountains.TopDownEngine.DungeonDoor.Start ( )

protectedvirtual

On Start we initialize our door based on its initial status.

ToggleDoor()

virtual void MoreMountains.TopDownEngine.DungeonDoor.ToggleDoor ( )

virtual

Opens or closes the door based on its current status.

Update()

virtual void MoreMountains.TopDownEngine.DungeonDoor.Update ( )

protectedvirtual

On Update, we open or close the door if needed.

Member Data Documentation

ClosedDoor

GameObject MoreMountains.TopDownEngine.DungeonDoor.ClosedDoor

the object to show when the door is closed

CloseDoorButton

bool MoreMountains.TopDownEngine.DungeonDoor.CloseDoorButton

a test button to close the door

DoorState

DoorStates MoreMountains.TopDownEngine.DungeonDoor.DoorState = DoorStates.Open

the current state of the door

OpenDoorBottom

GameObject MoreMountains.TopDownEngine.DungeonDoor.OpenDoorBottom

the bottom part of the door

OpenDoorButton

bool MoreMountains.TopDownEngine.DungeonDoor.OpenDoorButton

a test button to open the door

OpenDoorTop

GameObject MoreMountains.TopDownEngine.DungeonDoor.OpenDoorTop

the top part of the door

ToogleDoorButton

bool MoreMountains.TopDownEngine.DungeonDoor.ToogleDoorButton

a test button to toggle the door open or closed

---

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

• H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/Demos/Koala2D/Scripts/DungeonDoor.cs