Planeshift
psCmdBase Class Referenceabstract

#include <cmdbase.h>

Public Member Functions

virtual const char * HandleCommand (const char *cmd)=0
 Interprets a received message and executes the command. More...
 
virtual void HandleMessage (MsgEntry *msg, Client *)
 Interprets a received message and executes the command. More...
 
virtual void HandleMessage (MsgEntry *msg)=0
 
 psCmdBase (ClientMsgHandler *mh, CmdHandler *ch, iObjectRegistry *obj)
 
void Report (int severity, const char *msgtype, const char *description,...)
 
virtual bool Setup (ClientMsgHandler *mh, CmdHandler *ch)
 
virtual bool Verify (MsgEntry *, unsigned int, Client *&)
 
virtual ~psCmdBase ()
 

Protected Attributes

CmdHandlercmdsource
 
ClientMsgHandlermsgqueue
 
iObjectRegistry * objreg
 

Detailed Description

Definition at line 42 of file cmdbase.h.

Constructor & Destructor Documentation

psCmdBase::psCmdBase ( ClientMsgHandler mh,
CmdHandler ch,
iObjectRegistry *  obj 
)
virtual psCmdBase::~psCmdBase ( )
inlinevirtual

Definition at line 52 of file cmdbase.h.

Member Function Documentation

virtual const char* psCmdBase::HandleCommand ( const char *  cmd)
pure virtual

Interprets a received message and executes the command.

char * returned can be an error message to display.

Implements iCmdSubscriber.

Implemented in pawsChatWindow, psMainWidget, psCamera, pawsQuestListWindow, pawsPetitionGMWindow, pawsPetitionWindow, pawsGmGUIWindow, psGroupCommands, pawsLootWindow, psUserCommands, GUIHandler, psAdminCommands, psUtilityCommands, psGuildCommands, and pawsQuestRewardWindow.

virtual void psCmdBase::HandleMessage ( MsgEntry msg,
Client client 
)
inlinevirtual

Interprets a received message and executes the command.

Implements iNetSubscriber.

Definition at line 59 of file cmdbase.h.

void psCmdBase::Report ( int  severity,
const char *  msgtype,
const char *  description,
  ... 
)
virtual bool psCmdBase::Setup ( ClientMsgHandler mh,
CmdHandler ch 
)
virtual
virtual bool psCmdBase::Verify ( MsgEntry ,
unsigned int  ,
Client *&   
)
inlinevirtual

Implements iNetSubscriber.

Definition at line 61 of file cmdbase.h.

Member Data Documentation

CmdHandler* psCmdBase::cmdsource
protected

Definition at line 46 of file cmdbase.h.

ClientMsgHandler* psCmdBase::msgqueue
protected

Definition at line 45 of file cmdbase.h.

iObjectRegistry* psCmdBase::objreg
protected

Definition at line 47 of file cmdbase.h.


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