Planeshift
Public Types | Public Member Functions | Public Attributes | List of all members
psGUIInteractMessage Class Reference
Messages

Sends messages to the client interaction window. More...

#include <messages.h>

Public Types

enum  guiOptions {
  PICKUP = 0x00000001, EXAMINE = 0x00000002, UNLOCK = 0x00000004, LOOT = 0x00000008,
  BUYSELL = 0x00000010, GIVE = 0x00000020, CLOSE = 0x00000040, USE = 0x00000080,
  PLAYERDESC = 0x00000100, ATTACK = 0x00000200, COMBINE = 0x00000400, EXCHANGE = 0x00000800,
  TRAIN = 0x00001000, NPCTALK = 0x00002000, VIEWSTATS = 0x00004000, DISMISS = 0x00008000,
  MARRIAGE = 0x00010000, DIVORCE = 0x00020000, PLAYGAME = 0x00040000, ENTER = 0x00080000,
  LOCK = 0x00100000, ENTERLOCKED = 0x00200000, BANK = 0x00400000, INTRODUCE = 0x00800000,
  CONSTRUCT = 0x01000000, MOUNT = 0x02000000, UNMOUNT = 0x04000000, STORAGE = 0x08000000,
  GENERIC = 0x10000000
}
 

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psGUIInteractMessage (uint32_t clientnum, uint32_t options, csString command="")
 
 psGUIInteractMessage (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 genericCommand
 
uint32_t options
 Holds the options that the window should display. More...
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntry > msg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandler * msghandler
 

Detailed Description

Sends messages to the client interaction window.

Definition at line 1401 of file messages.h.

Member Enumeration Documentation

enum psGUIInteractMessage::guiOptions
Enumerator
PICKUP 
EXAMINE 
UNLOCK 
LOOT 
BUYSELL 
GIVE 
CLOSE 
USE 
PLAYERDESC 
ATTACK 
COMBINE 
EXCHANGE 
TRAIN 
NPCTALK 
VIEWSTATS 
DISMISS 
MARRIAGE 
DIVORCE 
PLAYGAME 
ENTER 
LOCK 
ENTERLOCKED 
BANK 
INTRODUCE 
CONSTRUCT 
MOUNT 
UNMOUNT 
STORAGE 
GENERIC 

Definition at line 1417 of file messages.h.

Constructor & Destructor Documentation

psGUIInteractMessage::psGUIInteractMessage ( uint32_t  clientnum,
uint32_t  options,
csString  command = "" 
)
psGUIInteractMessage::psGUIInteractMessage ( MsgEntry *  message)

Member Function Documentation

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

Definition at line 1456 of file messages.h.

uint32_t psGUIInteractMessage::options

Holds the options that the window should display.

Definition at line 1455 of file messages.h.

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