Planeshift
Public Member Functions | Public Attributes

psMechanismActivateMessage Class Reference

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

#include <messages.h>

List of all members.

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 psMechanismActivateMessage (MsgEntry *me)
 Constructor from a MsgEntry.
 psMechanismActivateMessage (uint32_t client, const char *meshName, const char *move, const char *rot)
 Constructor.
virtual csString ToString (NetBase::AccessPointers *)
 Converts the message into human readable string.

Public Attributes

csString meshName
csString move
csString rot

Detailed Description

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

Definition at line 6090 of file messages.h.


Constructor & Destructor Documentation

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

Constructor.

Parameters:
clientthe client's ID.
sectornamethe sector where the mechanism resides.
meshNamethe name of the mesh to activate.
mechanismScriptthe script to run on the selected mesh.
psMechanismActivateMessage::psMechanismActivateMessage ( MsgEntry me)

Constructor from a MsgEntry.

Parameters:
methe message entry.

Member Function Documentation

psMechanismActivateMessage::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psMechanismActivateMessage::ToString ( NetBase::AccessPointers accessPointers) [inline, virtual]

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:
accessPointersA struct to a number of access pointers.
Returns:
Return a human readable string for the message.

Implements psMessageCracker.

Definition at line 6112 of file messages.h.


Member Data Documentation

Definition at line 6117 of file messages.h.

Definition at line 6118 of file messages.h.

Definition at line 6119 of file messages.h.


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