Planeshift
psViewItemUpdate Class Reference

#include <messages.h>

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psViewItemUpdate (uint32_t to, EID containerID, uint32_t slotID, bool clearSlot, const char *itemName, const char *icon, const char *meshName, const char *materialName, uint32_t stackCount, EID ownerID, csStringSet *msgstrings)
 Constructs a message to go out to a client. More...
 
 psViewItemUpdate (MsgEntry *me, NetBase::AccessPointers *accessPointers)
 Crack out the details from the message. More...
 
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

bool clearSlot
 indicates if the slot should be cleared More...
 
EID containerID
 The EID for the container we're updating. More...
 
csString icon
 
csString materialName
 
csString meshName
 
csString name
 Item info. More...
 
EID ownerID
 
int slotID
 
int stackCount
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

Definition at line 4449 of file messages.h.

Constructor & Destructor Documentation

psViewItemUpdate::psViewItemUpdate ( uint32_t  to,
EID  containerID,
uint32_t  slotID,
bool  clearSlot,
const char *  itemName,
const char *  icon,
const char *  meshName,
const char *  materialName,
uint32_t  stackCount,
EID  ownerID,
csStringSet *  msgstrings 
)

Constructs a message to go out to a client.

Parameters
toThe desitination client.
containerIDThe destination container's entity ID (it's always a world container).
slotIDThe slot in the container where to make the update.
clearSlotBoolean that indicates if the update is to clear out the slot.
itemNameThe name of the item requested.
iconThe 2D gui image to draw for this item.
meshNameThe mesh name.
materialNamethe name of the material to apply to this item when in the 3d world.
stackCountThe number of items in the stack.
ownerIDThe GEM entity ID of the owner
msgstringsA message strings cache.
psViewItemUpdate::psViewItemUpdate ( MsgEntry me,
NetBase::AccessPointers accessPointers 
)

Crack out the details from the message.

Member Function Documentation

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

bool psViewItemUpdate::clearSlot

indicates if the slot should be cleared

Definition at line 4486 of file messages.h.

EID psViewItemUpdate::containerID

The EID for the container we're updating.

Definition at line 4489 of file messages.h.

csString psViewItemUpdate::icon

Definition at line 4493 of file messages.h.

csString psViewItemUpdate::materialName

Definition at line 4495 of file messages.h.

csString psViewItemUpdate::meshName

Definition at line 4494 of file messages.h.

csString psViewItemUpdate::name

Item info.

Definition at line 4492 of file messages.h.

EID psViewItemUpdate::ownerID

Definition at line 4498 of file messages.h.

int psViewItemUpdate::slotID

Definition at line 4496 of file messages.h.

int psViewItemUpdate::stackCount

Definition at line 4497 of file messages.h.


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