Planeshift
psServerConsoleCommand Class Reference

#include <serverconsole.h>

Public Member Functions

 psServerConsoleCommand (const char *command)
 
virtual csString ToString () const
 Return a string with information about the event. More...
 
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 ~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 122 of file serverconsole.h.

Constructor & Destructor Documentation

psServerConsoleCommand::psServerConsoleCommand ( const char *  command)
inline

Definition at line 128 of file serverconsole.h.

Member Function Documentation

virtual csString psServerConsoleCommand::ToString ( ) const
inlinevirtual

Return a string with information about the event.

Used for debugging to be able to identify things like way did this event take so long to execute.

TODO: Make this function abstract. But for now return "".

Reimplemented from psGameEvent.

Definition at line 134 of file serverconsole.h.

void psServerConsoleCommand::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 129 of file serverconsole.h.


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