Planeshift
psSequenceMessage Class Reference

Sends messages to the client to control sequences. More...

#include <messages.h>

Public Types

enum  { CMD_START = 1, CMD_STOP = 2, CMD_LOOP = 3 }
 

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psSequenceMessage (int cnum, const char *name, int cmd, int count)
 
 psSequenceMessage (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
 
int count
 
csString name
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

Sends messages to the client to control sequences.

Definition at line 5873 of file messages.h.

Member Enumeration Documentation

anonymous enum
Enumerator
CMD_START 
CMD_STOP 
CMD_LOOP 

Definition at line 5876 of file messages.h.

Constructor & Destructor Documentation

psSequenceMessage::psSequenceMessage ( int  cnum,
const char *  name,
int  cmd,
int  count 
)
psSequenceMessage::psSequenceMessage ( MsgEntry message)

Member Function Documentation

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

Definition at line 5896 of file messages.h.

int psSequenceMessage::count

Definition at line 5896 of file messages.h.

csString psSequenceMessage::name

Definition at line 5895 of file messages.h.


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