Planeshift
psGenericEvent Class Reference

This message broadcasts several different events to anyone who needs them, namely the TutorialManager. More...

#include <events.h>

Public Types

enum  Type { UNKNOWN =0, QUEST_ASSIGN, SPAWN_MOVE }
 

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psGenericEvent (int clientID, psGenericEvent::Type type)
 
 psGenericEvent (MsgEntry *event)
 
virtual csString ToString (NetBase::AccessPointers *accessPointers)
 Convert the message into human readable string. More...
 
- Public Member Functions inherited from psMessageCracker
void FireEvent ()
 Publishes the message to the local program. More...
 
virtual csString GetMessageTypeName () const =0
 Gets the name of the message type. More...
 
void Multicast (csArray< PublishDestination > &multi, uint32_t except, float range)
 Multicasts the message to all current connections. More...
 
 psMessageCracker ()
 
void SendMessage ()
 Sends the message to the client/server. More...
 
virtual ~psMessageCracker ()
 

Public Attributes

int client_id
 
Type eventType
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

This message broadcasts several different events to anyone who needs them, namely the TutorialManager.

Definition at line 297 of file events.h.

Member Enumeration Documentation

Enumerator
UNKNOWN 
QUEST_ASSIGN 
SPAWN_MOVE 

Definition at line 300 of file events.h.

Constructor & Destructor Documentation

psGenericEvent::psGenericEvent ( int  clientID,
psGenericEvent::Type  type 
)
psGenericEvent::psGenericEvent ( MsgEntry event)

Member Function Documentation

psGenericEvent::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psGenericEvent::ToString ( NetBase::AccessPointers accessPointers)
virtual

Convert the message into human readable string.

Parameters
accessPointersA struct to a number of access pointers.
Returns
Return a human readable string for the message.

Implements psMessageCracker.

Member Data Documentation

int psGenericEvent::client_id

Definition at line 308 of file events.h.

Type psGenericEvent::eventType

Definition at line 307 of file events.h.


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