Planeshift
psDRMessage Class Reference

#include <messages.h>

Public Member Functions

bool IsNewerThan (uint8_t oldCounter)
 Returns true if this message is newer than the passed DR sequence value. More...
 
void operator= (psDRMessage &other)
 
 psDRMessage ()
 
 psDRMessage (uint32_t client, EID mappedid, uint8_t counter, NetBase::AccessPointers *accessPointers, psLinearMovement *linmove, uint8_t mode=0)
 
 psDRMessage (uint32_t client, EID mappedid, bool on_ground, uint8_t mode, uint8_t counter, const csVector3 &pos, float yrot, iSector *sector, csString sectorName, const csVector3 &vel, csVector3 &worldVel, float ang_vel, NetBase::AccessPointers *accessPointers)
 
 psDRMessage (void *data, int size, NetBase::AccessPointers *accessPointers)
 
 psDRMessage (MsgEntry *me, NetBase::AccessPointers *accessPointers)
 
 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

float ang_vel
 Angular velocity of Yrot member changing. More...
 
uint8_t counter
 sequence checker byte More...
 
EID entityid
 The mapped id of the entity in question. More...
 
uint8_t mode
 Current character mode. More...
 
bool on_ground
 Helps determine whether gravity applies. More...
 
csVector3 pos
 Position vector. More...
 
iSector * sector
 Ptr to sector for mesh. More...
 
csString sectorName
 Name of the sector. More...
 
csVector3 vel
 Body Velocity vector. More...
 
csVector3 worldVel
 World velocity vector. More...
 
float yrot
 Rotation around Y-axis in radians. More...
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Protected Types

enum  { ON_GOUND = 128 }
 
enum  DRDataFlags {
  NOT_MOVING = 0, ACTOR_MODE = 1 << 0, ANG_VELOCITY = 1 << 1, X_VELOCITY = 1 << 2,
  Y_VELOCITY = 1 << 3, Z_VELOCITY = 1 << 4, X_WORLDVELOCITY = 1 << 5, Y_WORLDVELOCITY = 1 << 6,
  Z_WORLDVELOCITY = 1 << 7, ALL_DATA = ~0
}
 Flags indicating what components are packed in this message. More...
 

Protected Member Functions

void CreateMsgEntry (uint32_t client, NetBase::AccessPointers *accessPointers, iSector *sector, csString sectorName)
 
void ReadDRInfo (MsgEntry *me, NetBase::AccessPointers *accessPointers)
 
void WriteDRInfo (uint32_t client, EID mappedid, bool on_ground, uint8_t mode, uint8_t counter, const csVector3 &pos, float yrot, iSector *sector, csString sectorName, const csVector3 &vel, csVector3 &worldVel, float ang_vel, csStringSet *msgstrings, bool donewriting=true)
 

Static Protected Member Functions

static uint8_t GetDataFlags (const csVector3 &v, const csVector3 &wv, float yrv, uint8_t mode)
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

Definition at line 3129 of file messages.h.

Member Enumeration Documentation

anonymous enum
protected
Enumerator
ON_GOUND 

Definition at line 3155 of file messages.h.

enum psDRMessage::DRDataFlags
protected

Flags indicating what components are packed in this message.

Enumerator
NOT_MOVING 
ACTOR_MODE 
ANG_VELOCITY 
X_VELOCITY 
Y_VELOCITY 
Z_VELOCITY 
X_WORLDVELOCITY 
Y_WORLDVELOCITY 
Z_WORLDVELOCITY 
ALL_DATA 

Definition at line 3141 of file messages.h.

Constructor & Destructor Documentation

psDRMessage::psDRMessage ( )
inline

Definition at line 3172 of file messages.h.

psDRMessage::psDRMessage ( uint32_t  client,
EID  mappedid,
uint8_t  counter,
NetBase::AccessPointers accessPointers,
psLinearMovement linmove,
uint8_t  mode = 0 
)
psDRMessage::psDRMessage ( uint32_t  client,
EID  mappedid,
bool  on_ground,
uint8_t  mode,
uint8_t  counter,
const csVector3 &  pos,
float  yrot,
iSector *  sector,
csString  sectorName,
const csVector3 &  vel,
csVector3 &  worldVel,
float  ang_vel,
NetBase::AccessPointers accessPointers 
)
psDRMessage::psDRMessage ( void *  data,
int  size,
NetBase::AccessPointers accessPointers 
)
psDRMessage::psDRMessage ( MsgEntry me,
NetBase::AccessPointers accessPointers 
)

Member Function Documentation

void psDRMessage::CreateMsgEntry ( uint32_t  client,
NetBase::AccessPointers accessPointers,
iSector *  sector,
csString  sectorName 
)
protected
static uint8_t psDRMessage::GetDataFlags ( const csVector3 &  v,
const csVector3 &  wv,
float  yrv,
uint8_t  mode 
)
staticprotected
bool psDRMessage::IsNewerThan ( uint8_t  oldCounter)

Returns true if this message is newer than the passed DR sequence value.

void psDRMessage::operator= ( psDRMessage other)
psDRMessage::PSF_DECLARE_MSG_FACTORY ( )
void psDRMessage::ReadDRInfo ( MsgEntry me,
NetBase::AccessPointers accessPointers 
)
protected
virtual csString psDRMessage::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.

Reimplemented in psPersistActor.

void psDRMessage::WriteDRInfo ( uint32_t  client,
EID  mappedid,
bool  on_ground,
uint8_t  mode,
uint8_t  counter,
const csVector3 &  pos,
float  yrot,
iSector *  sector,
csString  sectorName,
const csVector3 &  vel,
csVector3 &  worldVel,
float  ang_vel,
csStringSet *  msgstrings,
bool  donewriting = true 
)
protected

Member Data Documentation

float psDRMessage::ang_vel

Angular velocity of Yrot member changing.

Definition at line 3169 of file messages.h.

uint8_t psDRMessage::counter

sequence checker byte

Definition at line 3160 of file messages.h.

EID psDRMessage::entityid

The mapped id of the entity in question.

Definition at line 3170 of file messages.h.

uint8_t psDRMessage::mode

Current character mode.

Definition at line 3162 of file messages.h.

bool psDRMessage::on_ground

Helps determine whether gravity applies.

Definition at line 3161 of file messages.h.

csVector3 psDRMessage::pos

Position vector.

Definition at line 3163 of file messages.h.

iSector* psDRMessage::sector

Ptr to sector for mesh.

Definition at line 3167 of file messages.h.

csString psDRMessage::sectorName

Name of the sector.

Definition at line 3168 of file messages.h.

csVector3 psDRMessage::vel

Body Velocity vector.

Definition at line 3163 of file messages.h.

csVector3 psDRMessage::worldVel

World velocity vector.

Definition at line 3163 of file messages.h.

float psDRMessage::yrot

Rotation around Y-axis in radians.

Definition at line 3166 of file messages.h.


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