psLocationMessage Class Reference

Handle Location changes from server to superclient. More...

#include <npcmessages.h>

List of all members.

Public Types
enum	Command {   LOCATION_ADJUSTED, LOCATION_CREATED, LOCATION_DELETED, LOCATION_INSERTED,   LOCATION_RADIUS, LOCATION_RENAME, LOCATION_SET_FLAG, LOCATION_TYPE_ADD,   LOCATION_TYPE_REMOVE }
Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psLocationMessage (Command command, const Location *location)
	Generic message to do a command where input is a Location.
	psLocationMessage (Command command, const LocationType *locationType)
	Generic message to do a command where input is a Location type.
	psLocationMessage (MsgEntry *message)
	Crack incoming psMessageBytes struct for inbound use.
	psLocationMessage (Command command, const csString &name)
	Generic message to do a command where input is a string.
virtual csString	ToString (NetBase::AccessPointers *accessPointers)
	Convert the message into human readable string.
Public Attributes
Command	command
bool	enable
	Enable or disable flags.
csString	flags
	String with flags.
uint32_t	id
	ID of the location/location type.
csString	name
	Name.
csVector3	position
	The position for new or adjusted elements.
uint32_t	prevID
	ID of previous point in a region.
float	radius
	The radius.
float	rotationAngle
	The rotation angle for this element.
iSector *	sector
	The sector for new or adjusted elements.
csString	typeName
	Type name.

---

Detailed Description

Handle Location changes from server to superclient.

Definition at line 580 of file npcmessages.h.

---

Member Enumeration Documentation

enum psLocationMessage::Command

Enumerator:

LOCATION_ADJUSTED
LOCATION_CREATED
LOCATION_DELETED
LOCATION_INSERTED
LOCATION_RADIUS
LOCATION_RENAME
LOCATION_SET_FLAG
LOCATION_TYPE_ADD
LOCATION_TYPE_REMOVE

Definition at line 584 of file npcmessages.h.

---

Constructor & Destructor Documentation

psLocationMessage::psLocationMessage	(	Command	command,
		const Location *	location
	)

Generic message to do a command where input is a Location.

psLocationMessage::psLocationMessage	(	Command	command,
		const LocationType *	locationType
	)

Generic message to do a command where input is a Location type.

psLocationMessage::psLocationMessage	(	Command	command,
		const csString &	name
	)

Generic message to do a command where input is a string.

psLocationMessage::psLocationMessage

(

MsgEntry *

message

)

Crack incoming psMessageBytes struct for inbound use.

---

Member Function Documentation

psLocationMessage::PSF_DECLARE_MSG_FACTORY

(

)

virtual csString psLocationMessage::ToString

(

NetBase::AccessPointers *

accessPointers

)

[virtual]

Convert 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

Command psLocationMessage::command

Definition at line 597 of file npcmessages.h.

bool psLocationMessage::enable

Enable or disable flags.

Definition at line 601 of file npcmessages.h.

csString psLocationMessage::flags

String with flags.

Definition at line 604 of file npcmessages.h.

uint32_t psLocationMessage::id

ID of the location/location type.

Definition at line 598 of file npcmessages.h.

csString psLocationMessage::name

Name.

Definition at line 606 of file npcmessages.h.

csVector3 psLocationMessage::position

The position for new or adjusted elements.

Definition at line 599 of file npcmessages.h.

uint32_t psLocationMessage::prevID

ID of previous point in a region.

Definition at line 607 of file npcmessages.h.

float psLocationMessage::radius

The radius.

Definition at line 602 of file npcmessages.h.

float psLocationMessage::rotationAngle

The rotation angle for this element.

Definition at line 603 of file npcmessages.h.

iSector* psLocationMessage::sector

The sector for new or adjusted elements.

Definition at line 600 of file npcmessages.h.

csString psLocationMessage::typeName

Type name.

Definition at line 605 of file npcmessages.h.

---

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

• common/net/npcmessages.h