Planeshift
psOverrideActionMessage Class Reference

Indicates that an OverrideAction is being done and not a loop as covered in DR msgs. More...

#include <messages.h>

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psOverrideActionMessage (int client, EID entity, const char *action, int duration=0)
 
 psOverrideActionMessage (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 action
 
int duration
 
EID entity_id
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

Indicates that an OverrideAction is being done and not a loop as covered in DR msgs.

Definition at line 1922 of file messages.h.

Constructor & Destructor Documentation

psOverrideActionMessage::psOverrideActionMessage ( int  client,
EID  entity,
const char *  action,
int  duration = 0 
)
psOverrideActionMessage::psOverrideActionMessage ( MsgEntry message)

Member Function Documentation

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

Definition at line 1939 of file messages.h.

int psOverrideActionMessage::duration

Definition at line 1940 of file messages.h.

EID psOverrideActionMessage::entity_id

Definition at line 1938 of file messages.h.


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