Planeshift
psGenericCmdMessage Class Reference

Generic commands. More...

#include <messages.h>

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psGenericCmdMessage (const char *cmd)
 
 psGenericCmdMessage (const char *cmd, uint32_t client=0)
 
 psGenericCmdMessage (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

csString cmd
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

Generic commands.

Those are processed by the GenericCommandManager.

Definition at line 1333 of file messages.h.

Constructor & Destructor Documentation

psGenericCmdMessage::psGenericCmdMessage ( const char *  cmd)
psGenericCmdMessage::psGenericCmdMessage ( const char *  cmd,
uint32_t  client = 0 
)
psGenericCmdMessage::psGenericCmdMessage ( MsgEntry message)

Member Function Documentation

psGenericCmdMessage::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psGenericCmdMessage::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

csString psGenericCmdMessage::cmd

Definition at line 1336 of file messages.h.


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