TopDown Engine  v4.4
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
MoreMountains.TopDownEngine.DungeonDoor Class Reference

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

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

Public Types

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

Public Member Functions

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

Public Attributes

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

Protected Member Functions

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

Detailed Description

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

Member Enumeration Documentation

◆ DoorStates

enum MoreMountains.TopDownEngine.DungeonDoor.DoorStates
strong

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: