Planeshift
psPETCommandMessage Class Reference

The message sent from client to server to control the players pet. More...

#include <npcmessages.h>

Public Types

enum  PetCommand_t {
  CMD_FOLLOW, CMD_STAY, CMD_DISMISS, CMD_SUMMON,
  CMD_ATTACK, CMD_GUARD, CMD_ASSIST, CMD_STOPATTACK,
  CMD_NAME, CMD_TARGET, CMD_RUN, CMD_WALK,
  CMD_LAST
}
 

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psPETCommandMessage (uint32_t clientToken, int cmd, const char *target, const char *options)
 Create psMessageBytes struct for outbound use. More...
 
 psPETCommandMessage (MsgEntry *message)
 Crack incoming psMessageBytes struct for inbound use. More...
 
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 command
 
psString options
 
psString target
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Static Public Attributes

static const char * petCommandString []
 
- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

The message sent from client to server to control the players pet.

Definition at line 415 of file npcmessages.h.

Member Enumeration Documentation

Enumerator
CMD_FOLLOW 
CMD_STAY 
CMD_DISMISS 
CMD_SUMMON 
CMD_ATTACK 
CMD_GUARD 
CMD_ASSIST 
CMD_STOPATTACK 
CMD_NAME 
CMD_TARGET 
CMD_RUN 
CMD_WALK 
CMD_LAST 

Definition at line 419 of file npcmessages.h.

Constructor & Destructor Documentation

psPETCommandMessage::psPETCommandMessage ( uint32_t  clientToken,
int  cmd,
const char *  target,
const char *  options 
)

Create psMessageBytes struct for outbound use.

psPETCommandMessage::psPETCommandMessage ( MsgEntry message)

Crack incoming psMessageBytes struct for inbound use.

Member Function Documentation

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

Definition at line 438 of file npcmessages.h.

psString psPETCommandMessage::options

Definition at line 440 of file npcmessages.h.

const char* psPETCommandMessage::petCommandString[]
static

Definition at line 436 of file npcmessages.h.

psString psPETCommandMessage::target

Definition at line 439 of file npcmessages.h.


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