Planeshift
psEntranceMessage Class Reference

Message from the server to handle entrances into and out of map instances. More...

#include <messages.h>

Public Member Functions

 psEntranceMessage (EID entranceID)
 Constructor for message for entering. More...
 
 psEntranceMessage (MsgEntry *me)
 
 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

EID entranceID
 The gem entity ID of the entrance object. More...
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

Message from the server to handle entrances into and out of map instances.

Definition at line 5733 of file messages.h.

Constructor & Destructor Documentation

psEntranceMessage::psEntranceMessage ( EID  entranceID)

Constructor for message for entering.

Parameters
entranceIDThe ID of the entrance.
psEntranceMessage::psEntranceMessage ( MsgEntry me)

Member Function Documentation

psEntranceMessage::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psEntranceMessage::ToString ( NetBase::AccessPointers accessPointers)
virtual

Converts the message into human readable string.

Parameters
accessPointersA struct to a number of access pointers
Returns
A human readable string for the message

Implements psMessageCracker.

Member Data Documentation

EID psEntranceMessage::entranceID

The gem entity ID of the entrance object.

Definition at line 5757 of file messages.h.


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