psEquipmentMessage Class Reference

General Equipment Message. More...

#include <messages.h>

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. More...
	psEquipmentMessage (MsgEntry *message)
	Crack this message off the network. More...
	PSF_DECLARE_MSG_FACTORY ()
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	mesh
csString	part
csString	partMesh
int	player
csString	removedMesh
	Lists the mesh which should be removed when this item is equipped. More...
int	slot
csString	texture
uint8_t	type
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

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

enum psEquipmentMessage::Command

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

clientNum	Client destination.
actorid	The entity that has changed ( target of this message )
type	One of EQUIP or DEEQUIP
slot	The slot that has changed
mesh	The name of the mesh to attach to slot
part	The name of the submesh that the equipment should go on.
texture	The name of the new texture to go onto a part
partMesh	The name of the submesh for the part.
removedMesh	Lists 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

accessPointers

A struct to a number of access pointers.

Returns

Return a human readable string for the message.

Implements psMessageCracker.

Member Data Documentation

csString psEquipmentMessage::mesh

Definition at line 2004 of file messages.h.

csString psEquipmentMessage::part

Definition at line 2006 of file messages.h.

csString psEquipmentMessage::partMesh

Definition at line 2008 of file messages.h.

int psEquipmentMessage::player

Definition at line 2003 of file messages.h.

csString psEquipmentMessage::removedMesh

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

Definition at line 2010 of file messages.h.

int psEquipmentMessage::slot

Definition at line 2005 of file messages.h.

csString psEquipmentMessage::texture

Definition at line 2007 of file messages.h.

uint8_t psEquipmentMessage::type

Definition at line 2002 of file messages.h.

---

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

• common/net/messages.h