Mezzanine::WorldTrigger Class Reference

This is an abstract class for creating in-game triggers. More...

#include <worldtrigger.h>

Collaboration diagram for Mezzanine::WorldTrigger:

Public Member Functions
	WorldTrigger (const String &name)
	Class constructor. More...
virtual	~WorldTrigger ()
	Class destructor.
virtual void	ApplyTrigger ()=0
	Applies the effects of this trigger.
virtual bool	ConditionsAreMet ()=0
	Checks for the condition for the trigger. More...
virtual String	GetName ()
	Gets the name of this trigger. More...

Protected Attributes
String	Name

Detailed Description

This is an abstract class for creating in-game triggers.

Definition at line 53 of file worldtrigger.h.

Constructor & Destructor Documentation

Mezzanine::WorldTrigger::WorldTrigger

(

const String &

name)

Class constructor.

Parameters

name	The unique name to be given to this trigger.

Definition at line 47 of file worldtrigger.cpp.

Member Function Documentation

virtual bool Mezzanine::WorldTrigger::ConditionsAreMet ( )

pure virtual

Checks for the condition for the trigger.

Returns

Returns a bool indicating whether or not the condition(s) has been met.

String Mezzanine::WorldTrigger::GetName ( )

virtual

Gets the name of this trigger.

Returns

Returns a string containing the name of this trigger.

Definition at line 56 of file worldtrigger.cpp.

---

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

• /home/sqeaky/Code/Mezzanine/Mezzanine/src/worldtrigger.h
• /home/sqeaky/Code/Mezzanine/Mezzanine/src/worldtrigger.cpp