psPathNetworkMessage Class Reference

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

#include <npcmessages.h>

List of all members.

Public Types
enum	Command {   PATH_ADD_POINT, PATH_CREATE, PATH_RENAME, PATH_REMOVE_POINT,   PATH_SET_FLAG, POINT_ADJUSTED, WAYPOINT_ADJUSTED, WAYPOINT_ALIAS_ADD,   WAYPOINT_ALIAS_REMOVE, WAYPOINT_ALIAS_ROTATION_ANGLE, WAYPOINT_CREATE, WAYPOINT_RADIUS,   WAYPOINT_RENAME, WAYPOINT_SET_FLAG }
Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psPathNetworkMessage (Command command, const psPath *path)
	Generic message to do a command where input is a path.
	psPathNetworkMessage (Command command, const psPathPoint *point)
	Generic message to do a command where input is a path point.
	psPathNetworkMessage (MsgEntry *message)
	Crack incoming psMessageBytes struct for inbound use.
	psPathNetworkMessage (Command command, const Waypoint *waypoint, const csString &string, bool enable)
	Generic message to do a command where input is a string for a waypoint.
	psPathNetworkMessage (Command command, const psPath *path, const csString &string, bool enable)
	Generic message to do a command where input is a string and a bool for a path.
	psPathNetworkMessage (Command command, const Waypoint *waypoint, const WaypointAlias *alias)
	Generic message to do a command where input is a waypoint and an alias.
	psPathNetworkMessage (Command command, const Waypoint *waypoint)
	Generic message to do a command where input is a waypoint.
	psPathNetworkMessage (Command command, const psPath *path, const psPathPoint *point)
	Generic message to do a command where input is a point for a path.
	psPathNetworkMessage (Command command, const Waypoint *waypoint, const csString &string)
	Generic message to do a command where input is a waypoint and an string.
	psPathNetworkMessage (Command command, const psPath *path, int secondId)
	Generic message to do a command where input is a point for a path.
virtual csString	ToString (NetBase::AccessPointers *accessPointers)
	Convert the message into human readable string.
Public Attributes
uint32_t	aliasID
	The id of aliases.
Command	command
bool	enable
	Enable or disable flags.
csString	flags
	String with flags.
uint32_t	id
	ID of waypoint/point/segment.
csVector3	position
	The position for new or adjusted elements.
float	radius
	The radius.
float	rotationAngle
	The rotation angle for aliases.
uint32_t	secondId
iSector *	sector
	The sector for new or adjusted elements.
uint32_t	startId
uint32_t	stopId
csString	string
	The string for add alias/flag set.

---

Detailed Description

Handle PathNetwork changes from server to superclient.

Definition at line 488 of file npcmessages.h.

---

Member Enumeration Documentation

enum psPathNetworkMessage::Command

Enumerator:

PATH_ADD_POINT
PATH_CREATE
PATH_RENAME
PATH_REMOVE_POINT
PATH_SET_FLAG
POINT_ADJUSTED
WAYPOINT_ADJUSTED
WAYPOINT_ALIAS_ADD
WAYPOINT_ALIAS_REMOVE
WAYPOINT_ALIAS_ROTATION_ANGLE
WAYPOINT_CREATE
WAYPOINT_RADIUS
WAYPOINT_RENAME
WAYPOINT_SET_FLAG

Definition at line 492 of file npcmessages.h.

---

Constructor & Destructor Documentation

psPathNetworkMessage::psPathNetworkMessage	(	Command	command,
		const psPath *	path
	)

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

psPathNetworkMessage::psPathNetworkMessage	(	Command	command,
		const psPath *	path,
		const psPathPoint *	point
	)

Generic message to do a command where input is a point for a path.

psPathNetworkMessage::psPathNetworkMessage	(	Command	command,
		const psPath *	path,
		int	secondId
	)

Generic message to do a command where input is a point for a path.

psPathNetworkMessage::psPathNetworkMessage	(	Command	command,
		const psPath *	path,
		const csString &	string,
		bool	enable
	)

Generic message to do a command where input is a string and a bool for a path.

psPathNetworkMessage::psPathNetworkMessage	(	Command	command,
		const psPathPoint *	point
	)

Generic message to do a command where input is a path point.

psPathNetworkMessage::psPathNetworkMessage	(	Command	command,
		const Waypoint *	waypoint
	)

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

psPathNetworkMessage::psPathNetworkMessage	(	Command	command,
		const Waypoint *	waypoint,
		const WaypointAlias *	alias
	)

Generic message to do a command where input is a waypoint and an alias.

psPathNetworkMessage::psPathNetworkMessage	(	Command	command,
		const Waypoint *	waypoint,
		const csString &	string
	)

Generic message to do a command where input is a waypoint and an string.

psPathNetworkMessage::psPathNetworkMessage	(	Command	command,
		const Waypoint *	waypoint,
		const csString &	string,
		bool	enable
	)

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

psPathNetworkMessage::psPathNetworkMessage

(

MsgEntry *

message

)

Crack incoming psMessageBytes struct for inbound use.

---

Member Function Documentation

psPathNetworkMessage::PSF_DECLARE_MSG_FACTORY

(

)

virtual csString psPathNetworkMessage::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

uint32_t psPathNetworkMessage::aliasID

The id of aliases.

Definition at line 522 of file npcmessages.h.

Command psPathNetworkMessage::command

Definition at line 510 of file npcmessages.h.

bool psPathNetworkMessage::enable

Enable or disable flags.

Definition at line 515 of file npcmessages.h.

csString psPathNetworkMessage::flags

String with flags.

Definition at line 517 of file npcmessages.h.

uint32_t psPathNetworkMessage::id

ID of waypoint/point/segment.

Definition at line 511 of file npcmessages.h.

csVector3 psPathNetworkMessage::position

The position for new or adjusted elements.

Definition at line 512 of file npcmessages.h.

float psPathNetworkMessage::radius

The radius.

Definition at line 516 of file npcmessages.h.

float psPathNetworkMessage::rotationAngle

The rotation angle for aliases.

Definition at line 521 of file npcmessages.h.

uint32_t psPathNetworkMessage::secondId

Definition at line 520 of file npcmessages.h.

iSector* psPathNetworkMessage::sector

The sector for new or adjusted elements.

Definition at line 513 of file npcmessages.h.

uint32_t psPathNetworkMessage::startId

Definition at line 518 of file npcmessages.h.

uint32_t psPathNetworkMessage::stopId

Definition at line 519 of file npcmessages.h.

csString psPathNetworkMessage::string

The string for add alias/flag set.

Definition at line 514 of file npcmessages.h.

---

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

• common/net/npcmessages.h