psMechanismActivateMessage Class Reference

This message is used by the server to activate one mechanism client side. More...

#include <messages.h>

Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psMechanismActivateMessage (uint32_t client, const char *meshName, const char *move, const char *rot)
	Constructor. More...
	psMechanismActivateMessage (MsgEntry *me)
	Constructor from a MsgEntry. More...
virtual csString	ToString (NetBase::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	meshName
csString	move
csString	rot
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

This message is used by the server to activate one mechanism client side.

Definition at line 6097 of file messages.h.

Constructor & Destructor Documentation

psMechanismActivateMessage::psMechanismActivateMessage	(	uint32_t	client,
		const char *	meshName,
		const char *	move,
		const char *	rot
	)

Constructor.

Parameters

client	the client's ID.
sectorname	the sector where the mechanism resides.
meshName	the name of the mesh to activate.
mechanismScript	the script to run on the selected mesh.

psMechanismActivateMessage::psMechanismActivateMessage

(

MsgEntry *

me

)

Constructor from a MsgEntry.

Parameters

me	the message entry.

Member Function Documentation

psMechanismActivateMessage::PSF_DECLARE_MSG_FACTORY

(

)

virtual csString psMechanismActivateMessage::ToString ( NetBase::AccessPointers *  accessPointers )

inlinevirtual

Converts the message into human readable string.

Used when a message is Logged. Every message should implement a version of this function that print all data that was decoded when the message was initiated from a NetEntry. See psDRMessage::ToString for an example.

Parameters

accessPointers

A struct to a number of access pointers.

Returns

Return a human readable string for the message.

Implements psMessageCracker.

Definition at line 6119 of file messages.h.

Member Data Documentation

csString psMechanismActivateMessage::meshName

Definition at line 6124 of file messages.h.

csString psMechanismActivateMessage::move

Definition at line 6125 of file messages.h.

csString psMechanismActivateMessage::rot

Definition at line 6126 of file messages.h.

---

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

• common/net/messages.h