Planeshift
psWeatherGameEvent Class Reference

When a weather event is created, it goes here. More...

#include <weathermanager.h>

Public Member Functions

const char * GetType ()
 
 psWeatherGameEvent (WeatherManager *mgr, int delayticks, int eventtype, int eventvalue, int duration, int fade, const char *sector, psSectorInfo *si, uint client, int r=0, int g=0, int b=0)
 
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 ()
 

Public Attributes

int cb
 
int cg
 
uint clientnum
 
int cr
 
int duration
 
int fade
 
csString sector
 
psSectorInfosi
 
int type
 
int value
 
- 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...
 

Protected Attributes

WeatherManagerweathermanager
 

Additional Inherited Members

- Static Public Attributes inherited from psGameEvent
static EventManagereventmanager
 
static int nextid
 id counter sequence More...
 

Detailed Description

When a weather event is created, it goes here.

Definition at line 137 of file weathermanager.h.

Constructor & Destructor Documentation

psWeatherGameEvent::psWeatherGameEvent ( WeatherManager mgr,
int  delayticks,
int  eventtype,
int  eventvalue,
int  duration,
int  fade,
const char *  sector,
psSectorInfo si,
uint  client,
int  r = 0,
int  g = 0,
int  b = 0 
)

Member Function Documentation

const char* psWeatherGameEvent::GetType ( )
virtual void psWeatherGameEvent::Trigger ( )
virtual

Abstract event processing function.

Implements psGameEvent.

Member Data Documentation

int psWeatherGameEvent::cb

Definition at line 157 of file weathermanager.h.

int psWeatherGameEvent::cg

Definition at line 157 of file weathermanager.h.

uint psWeatherGameEvent::clientnum

Definition at line 161 of file weathermanager.h.

int psWeatherGameEvent::cr

Definition at line 157 of file weathermanager.h.

int psWeatherGameEvent::duration

Definition at line 158 of file weathermanager.h.

int psWeatherGameEvent::fade

Definition at line 158 of file weathermanager.h.

csString psWeatherGameEvent::sector

Definition at line 159 of file weathermanager.h.

psSectorInfo* psWeatherGameEvent::si

Definition at line 160 of file weathermanager.h.

int psWeatherGameEvent::type

Definition at line 158 of file weathermanager.h.

int psWeatherGameEvent::value

Definition at line 158 of file weathermanager.h.

WeatherManager* psWeatherGameEvent::weathermanager
protected

Definition at line 165 of file weathermanager.h.


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