Planeshift
psEntityEvent Class Reference

#include <entitymanager.h>

Public Types

enum  EventType { DESTROY = 0 }
 

Public Member Functions

 psEntityEvent (EntityManager *entitymanager, EventType type, gemObject *object)
 
virtual void Trigger ()
 Abstract event processing function. More...
 
- Public Member Functions inherited from psGameEvent
virtual bool CheckTrigger ()
 Called right before a Trigger is called. More...
 
const char * GetType ()
 Return the type that this event where created with. More...
 
virtual bool IsValid ()
 Return the valid flag. More...
 
bool operator< (const psGameEvent &other) const
 
bool operator== (const psGameEvent &other) const
 
bool operator> (const psGameEvent &other) const
 
 psGameEvent (csTicks ticks, int offsetticks, const char *newType)
 Construct a new game event. More...
 
void QueueEvent ()
 Publish the game event to the local program. More...
 
virtual void SetValid (bool valid)
 Set the valid flag. More...
 
virtual csString ToString () const
 Return a string with information about the event. More...
 
virtual ~psGameEvent ()
 

Additional Inherited Members

- Public Attributes inherited from psGameEvent
csTicks delayticks
 delay before the event starts More...
 
int id
 id value combined with ticks ensures uniqueness for tree More...
 
csTicks triggerticks
 ticks value when event should be triggered. More...
 
bool valid
 Set this to false if the trigger should not be fired. More...
 
- Static Public Attributes inherited from psGameEvent
static EventManagereventmanager
 
static int nextid
 id counter sequence More...
 

Detailed Description

Definition at line 204 of file entitymanager.h.

Member Enumeration Documentation

Enumerator
DESTROY 

Definition at line 207 of file entitymanager.h.

Constructor & Destructor Documentation

psEntityEvent::psEntityEvent ( EntityManager entitymanager,
EventType  type,
gemObject object 
)
inline

Definition at line 212 of file entitymanager.h.

Member Function Documentation

virtual void psEntityEvent::Trigger ( )
inlinevirtual

Abstract event processing function.

This functino have to be overridden and will be called if CheckTrigger is ok at the time given in the constructor.

Implements psGameEvent.

Definition at line 218 of file entitymanager.h.


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