Planeshift
psGMEventInfoMessage Class Reference

Sends messages to the client listing the assigned events for the player. More...

#include <messages.h>

Public Types

enum  { CMD_QUERY, CMD_INFO, CMD_DISCARD, CMD_EVAL }
 

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psGMEventInfoMessage (int cnum, int cmd, int id, const char *name, const char *info, bool Evaluatable=false)
 
 psGMEventInfoMessage (MsgEntry *message)
 
virtual csString ToString (NetBase::AccessPointers *accessPointers)
 Converts 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 command
 
bool Evaluatable
 Stores if an event can be evaluated. More...
 
int id
 
csString xml
 Stores an xml string (various uses) More...
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntry > msg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandler * msghandler
 

Detailed Description

Sends messages to the client listing the assigned events for the player.

Definition at line 5794 of file messages.h.

Member Enumeration Documentation

anonymous enum
Enumerator
CMD_QUERY 

command to request the list of events

CMD_INFO 

command to get informations on the specific event (description, evaluatable status)

CMD_DISCARD 

command to discard an event

CMD_EVAL 

command to send an evaluation of the event

Definition at line 5797 of file messages.h.

Constructor & Destructor Documentation

psGMEventInfoMessage::psGMEventInfoMessage ( int  cnum,
int  cmd,
int  id,
const char *  name,
const char *  info,
bool  Evaluatable = false 
)
psGMEventInfoMessage::psGMEventInfoMessage ( MsgEntry *  message)

Member Function Documentation

psGMEventInfoMessage::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psGMEventInfoMessage::ToString ( NetBase::AccessPointers *  accessPointers)
virtual

Converts 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 psGMEventInfoMessage::command

Definition at line 5817 of file messages.h.

bool psGMEventInfoMessage::Evaluatable

Stores if an event can be evaluated.

Definition at line 5818 of file messages.h.

int psGMEventInfoMessage::id

Definition at line 5817 of file messages.h.

csString psGMEventInfoMessage::xml

Stores an xml string (various uses)

Definition at line 5819 of file messages.h.


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