Planeshift
psPersistAllEntities Class Reference

#include <messages.h>

Public Member Functions

bool AddEntityMessage (MsgEntry *newEnt)
 Appends the new entity message to the current pending message. More...
 
MsgEntryGetEntityMessage ()
 Creates a new entity persist message from the next slot in the inbound buffer. More...
 
 PSF_DECLARE_MSG_FACTORY ()
 
 psPersistAllEntities (uint32_t client)
 
 psPersistAllEntities (MsgEntry *me)
 
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 ()
 

Additional Inherited Members

- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 
- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

Definition at line 3316 of file messages.h.

Constructor & Destructor Documentation

psPersistAllEntities::psPersistAllEntities ( uint32_t  client)
inline

Definition at line 3319 of file messages.h.

psPersistAllEntities::psPersistAllEntities ( MsgEntry me)

Member Function Documentation

bool psPersistAllEntities::AddEntityMessage ( MsgEntry newEnt)

Appends the new entity message to the current pending message.

Parameters
newEntPointer to psPersistActor message to append.
Returns
Returns true if adding was successful, false if the current msg is full and it fails.
MsgEntry* psPersistAllEntities::GetEntityMessage ( )

Creates a new entity persist message from the next slot in the inbound buffer.

Returns
Returns a psPersistActor MsgEntry structure if one is still in the message, or NULL if this message is complete.
psPersistAllEntities::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psPersistAllEntities::ToString ( NetBase::AccessPointers accessPointers)
virtual

Converts the message into human readable string.

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

Implements psMessageCracker.


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