EventTrigger Class Reference

#include <gameeventsystem.h>

Inheritance diagram for EventTrigger:

[legend]List of all members.

Public Types
enum	State { unfulfilled, fulfilled, finally_fulfilled, finally_failed }
Public Member Functions
State	state (int player)
	takes the inversion into account, which getState(int) does not
virtual void	readData (tnstream &stream)=0
virtual void	writeData (tnstream &stream)=0
virtual ASCString	getDetailledName () const=0
virtual ASCString	getTypeName () const=0
virtual void	setup ()=0
virtual void	arm ()
void	setMap (GameMap *gamemap_)
void	setEvent (Event *ev)
EventTriggerID	getTriggerID ()
virtual	~EventTrigger ()
Public Attributes
bool	invert
Protected Member Functions
	EventTrigger (EventTriggerID id)
virtual State	getState (int player)=0
bool	isFulfilled ()
Protected Attributes
GameMap *	gamemap
Event *	event

---

Detailed Description

Definition at line 59 of file gameeventsystem.h.

---

Member Enumeration Documentation

enum EventTrigger::State

Enumerator:

unfulfilled
fulfilled
finally_fulfilled
finally_failed

Definition at line 62 of file gameeventsystem.h.

---

Constructor & Destructor Documentation

EventTrigger::EventTrigger

(

EventTriggerID

id

)

[inline, protected]

Definition at line 64 of file gameeventsystem.h.

virtual EventTrigger::~EventTrigger

(

)

[inline, virtual]

Definition at line 89 of file gameeventsystem.h.

---

Member Function Documentation

virtual State EventTrigger::getState

(

int

player

)

[protected, pure virtual]

Implemented in TriggerNothingTrue, TriggerNothingFalse, TurnPassed, UnitLost, UnitConquered, UnitDestroyed, AllBuildingsLost, AllUnitsLost, BuildingConquered, BuildingLost, BuildingDestroyed, BuildingSeen, EventTriggered, AllEnemyUnitsDestroyed, AllEnemyBuildingsDestroyed, SpecificUnitEntersPolygon, AnyUnitEntersPolygon, and ResourceTribute.

Referenced by state().

bool EventTrigger::isFulfilled

(

)

[protected]

Definition at line 126 of file gameeventsystem.cpp.

References event, finally_fulfilled, fulfilled, Event::playerBitmap, and state().

Referenced by ResourceTribute::triggered(), AnyUnitEntersPolygon::triggered(), SpecificUnitEntersPolygon::triggered(), BuildingSeen::triggered(), and BuildingConquered::triggered().

EventTrigger::State EventTrigger::state

(

int

player

)

takes the inversion into account, which getState(int) does not

Definition at line 98 of file gameeventsystem.cpp.

References finally_failed, finally_fulfilled, fulfilled, getState(), invert, and unfulfilled.

Referenced by isFulfilled(), EventTriggered::triggered(), and UnitTrigger::triggered().

virtual void EventTrigger::readData

(

tnstream &

stream

)

[pure virtual]

Implemented in TriggerNothing, TurnPassed, UnitTrigger, AllBuildingsLost, AllUnitsLost, PositionTrigger, EventTriggered, AllEnemyUnitsDestroyed, AllEnemyBuildingsDestroyed, SpecificUnitEntersPolygon, AnyUnitEntersPolygon, and ResourceTribute.

virtual void EventTrigger::writeData

(

tnstream &

stream

)

[pure virtual]

Implemented in TriggerNothing, TurnPassed, UnitTrigger, AllBuildingsLost, AllUnitsLost, PositionTrigger, EventTriggered, AllEnemyUnitsDestroyed, AllEnemyBuildingsDestroyed, SpecificUnitEntersPolygon, AnyUnitEntersPolygon, and ResourceTribute.

virtual ASCString EventTrigger::getDetailledName

(

)

const [pure virtual]

Implemented in TriggerNothingTrue, TriggerNothingFalse, TurnPassed, UnitLost, UnitConquered, UnitDestroyed, AllBuildingsLost, AllUnitsLost, BuildingConquered, BuildingLost, BuildingDestroyed, BuildingSeen, EventTriggered, AllEnemyUnitsDestroyed, AllEnemyBuildingsDestroyed, SpecificUnitEntersPolygon, AnyUnitEntersPolygon, and ResourceTribute.

virtual ASCString EventTrigger::getTypeName

(

)

const [pure virtual]

Implemented in TriggerNothingTrue, TriggerNothingFalse, TurnPassed, UnitLost, UnitConquered, UnitDestroyed, AllBuildingsLost, AllUnitsLost, BuildingConquered, BuildingLost, BuildingDestroyed, BuildingSeen, EventTriggered, AllEnemyUnitsDestroyed, AllEnemyBuildingsDestroyed, SpecificUnitEntersPolygon, AnyUnitEntersPolygon, and ResourceTribute.

virtual void EventTrigger::setup

(

)

[pure virtual]

Implemented in TriggerNothing, TurnPassed, UnitTrigger, AllBuildingsLost, AllUnitsLost, BuildingPositionTrigger, EventTriggered, AllEnemyUnitsDestroyed, AllEnemyBuildingsDestroyed, SpecificUnitEntersPolygon, AnyUnitEntersPolygon, and ResourceTribute.

virtual void EventTrigger::arm

(

)

[inline, virtual]

Reimplemented in TurnPassed, UnitLost, UnitConquered, UnitDestroyed, BuildingConquered, BuildingLost, BuildingSeen, EventTriggered, AllEnemyUnitsDestroyed, AllEnemyBuildingsDestroyed, SpecificUnitEntersPolygon, AnyUnitEntersPolygon, and ResourceTribute.

Definition at line 84 of file gameeventsystem.h.

void EventTrigger::setMap

(

GameMap *

gamemap_

)

[inline]

Definition at line 85 of file gameeventsystem.h.

References gamemap.

Referenced by Event::spawnTrigger().

void EventTrigger::setEvent

(

Event *

ev

)

[inline]

Definition at line 86 of file gameeventsystem.h.

References event.

Referenced by Event::spawnTrigger().

EventTriggerID EventTrigger::getTriggerID

(

)

[inline]

Definition at line 87 of file gameeventsystem.h.

---

Member Data Documentation

GameMap* EventTrigger::gamemap [protected]

Definition at line 66 of file gameeventsystem.h.

Referenced by SpecificUnitEntersPolygon::arm(), UnitDestroyed::arm(), UnitConquered::arm(), UnitLost::arm(), BuildingSeen::arm(), BuildingLost::arm(), BuildingConquered::arm(), TurnPassed::arm(), AnyUnitEntersPolygon::fieldOperator(), SpecificUnitEntersPolygon::fieldOperator(), AnyUnitEntersPolygon::getDetailledName(), SpecificUnitEntersPolygon::getDetailledName(), UnitTrigger::getName(), BuildingPositionTrigger::getName(), ResourceTribute::getState(), AllEnemyBuildingsDestroyed::getState(), AllEnemyUnitsDestroyed::getState(), EventTriggered::getState(), UnitDestroyed::getState(), UnitConquered::getState(), UnitLost::getState(), AllUnitsLost::getState(), AllBuildingsLost::getState(), BuildingSeen::getState(), BuildingDestroyed::getState(), BuildingConquered::getState(), TurnPassed::getState(), setMap(), EventTriggered::setup(), ResourceTribute::triggered(), AnyUnitEntersPolygon::triggered(), SpecificUnitEntersPolygon::triggered(), EventTriggered::triggered(), UnitTrigger::triggered(), BuildingSeen::triggered(), and BuildingConquered::triggered().

Event* EventTrigger::event [protected]

Definition at line 67 of file gameeventsystem.h.

Referenced by isFulfilled(), and setEvent().

bool EventTrigger::invert

Definition at line 74 of file gameeventsystem.h.

Referenced by Event::read(), and state().

---

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

• gameeventsystem.h
• gameeventsystem.cpp

---