Planeshift
Public Types | Public Member Functions | Public Attributes

psEquipmentMessage Class Reference

General Equipment Message. More...

#include <messages.h>

List of all members.

Public Types

enum  Command { EQUIP, DEEQUIP }

Public Member Functions

 psEquipmentMessage (uint32_t clientNum, EID actorid, uint8_t type, int slot, csString &mesh, csString &part, csString &texture, csString &partMesh, csString &removedMesh)
 Constuct a new equipment message to go on the network.
 psEquipmentMessage (MsgEntry *message)
 Crack this message off the network.
 PSF_DECLARE_MSG_FACTORY ()
virtual csString ToString (NetBase::AccessPointers *accessPointers)
 Converts the message into human readable string.

Public Attributes

csString mesh
csString part
csString partMesh
int player
csString removedMesh
 Lists the mesh which should be removed when this item is equipped.
int slot
csString texture
uint8_t type

Detailed Description

General Equipment Message.

This message is used to tell other players about visual changes in equipment. The inventory screen may generate these messages but it is the client/server char managers that will deal with these messages.

Definition at line 1955 of file messages.h.


Member Enumeration Documentation

Enumerator:
EQUIP 
DEEQUIP 

Definition at line 1958 of file messages.h.


Constructor & Destructor Documentation

psEquipmentMessage::psEquipmentMessage ( uint32_t  clientNum,
EID  actorid,
uint8_t  type,
int  slot,
csString &  mesh,
csString &  part,
csString &  texture,
csString &  partMesh,
csString &  removedMesh 
)

Constuct a new equipment message to go on the network.

This will build an equipment message for any player that has changed their equipment. Should only be generated by the server.

Parameters:
clientNumClient destination.
actoridThe entity that has changed ( target of this message )
typeOne of EQUIP or DEEQUIP
slotThe slot that has changed
meshThe name of the mesh to attach to slot
partThe name of the submesh that the equipment should go on.
textureThe name of the new texture to go onto a part
partMeshThe name of the submesh for the part.
removedMeshLists the mesh which should be removed when this item is equiped.
Note:
If the type is DEEQUIP the meshName is ignored and sent as ""
psEquipmentMessage::psEquipmentMessage ( MsgEntry message)

Crack this message off the network.


Member Function Documentation

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

Definition at line 2004 of file messages.h.

Definition at line 2006 of file messages.h.

Definition at line 2008 of file messages.h.

Definition at line 2003 of file messages.h.

Lists the mesh which should be removed when this item is equipped.

Definition at line 2010 of file messages.h.

Definition at line 2005 of file messages.h.

Definition at line 2007 of file messages.h.

Definition at line 2002 of file messages.h.


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