Planeshift
psPersistActor Class Reference

#include <messages.h>

Public Types

enum  Flags {
  NONE = 0, INVISIBLE = 1 << 0, INVINCIBLE = 1 << 1, NPC = 1 << 2,
  NAMEKNOWN = 1 << 3, IS_ALIVE = 1 << 4
}
 

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psPersistActor (uint32_t clientnum, int type, int masqueradeType, bool control, const char *name, const char *guild, const char *factname, const char *matname, const char *race, const char *mountFactname, const char *MounterAnim, unsigned short int gender, float scale, float mountscale, const char *helmGroup, const char *BracerGroup, const char *BeltGroup, const char *CloakGroup, csVector3 collTop, csVector3 collBottom, csVector3 collOffset, const char *texParts, const char *equipmentParts, uint8_t counter, EID mappedid, csStringSet *msgstrings, psLinearMovement *linmove, uint8_t movementMode, uint8_t serverMode, PID playerID=0, uint32_t groupID=0, EID ownerEID=0, uint32_t flags=NONE, PID masterID=0, bool forNPClient=false)
 
 psPersistActor (MsgEntry *me, NetBase::AccessPointers *accessPointers, bool forNPClient=false)
 
void SetInstance (InstanceID instance)
 Used to insert instance into the message buffer after creation. More...
 
virtual csString ToString (NetBase::AccessPointers *accessPointers)
 Converts the message into human readable string. More...
 
- Public Member Functions inherited from psDRMessage
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 ()
 
- 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 ()
 

Static Public Member Functions

static uint32_t PeekEID (MsgEntry *me)
 Used to extract just the entity EID from the message. More...
 

Public Attributes

csString beltGroup
 Used for belt groupings. More...
 
csVector3 bottom
 
csString bracerGroup
 Used for bracers groupings. More...
 
csString cloakGroup
 Used for cloak groupings. More...
 
bool control
 
csString equipment
 
csString factname
 
uint32_t flags
 
unsigned short int gender
 
uint32_t groupID
 
csString guild
 
csString helmGroup
 Used for helm groupings. More...
 
InstanceID instance
 
int masqueradeType
 
PID masterID
 
csString matname
 
csString MounterAnim
 The anim to be used by the mounter. More...
 
csString mountFactname
 
float mountScale
 Stores the scale of the mounted actor. More...
 
csString name
 
csVector3 offset
 
EID ownerEID
 
PID playerID
 
int posInstance
 Remember the position of the instance field in the generated message. More...
 
int posPlayerID
 Remember the position the playerID in the generated message. More...
 
csString race
 
float scale
 Stores the scale of the actor. Total model scale. More...
 
uint8_t serverMode
 
csString texParts
 
csVector3 top
 
int type
 
- Public Attributes inherited from psDRMessage
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
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 
- Protected Types inherited from psDRMessage
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 inherited from psDRMessage
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 inherited from psDRMessage
static uint8_t GetDataFlags (const csVector3 &v, const csVector3 &wv, float yrv, uint8_t mode)
 

Detailed Description

Definition at line 3355 of file messages.h.

Member Enumeration Documentation

Enumerator
NONE 
INVISIBLE 

Used to inform super client. Clients will not get this < since actor is removed when invisible.

INVINCIBLE 

Used to inform super client.

NPC 

Set for NPCs.

NAMEKNOWN 

Used to tell the client if he knows this actor.

IS_ALIVE 

Used to tell the clients that this actor is alive.

Definition at line 3358 of file messages.h.

Constructor & Destructor Documentation

psPersistActor::psPersistActor ( uint32_t  clientnum,
int  type,
int  masqueradeType,
bool  control,
const char *  name,
const char *  guild,
const char *  factname,
const char *  matname,
const char *  race,
const char *  mountFactname,
const char *  MounterAnim,
unsigned short int  gender,
float  scale,
float  mountscale,
const char *  helmGroup,
const char *  BracerGroup,
const char *  BeltGroup,
const char *  CloakGroup,
csVector3  collTop,
csVector3  collBottom,
csVector3  collOffset,
const char *  texParts,
const char *  equipmentParts,
uint8_t  counter,
EID  mappedid,
csStringSet *  msgstrings,
psLinearMovement linmove,
uint8_t  movementMode,
uint8_t  serverMode,
PID  playerID = 0,
uint32_t  groupID = 0,
EID  ownerEID = 0,
uint32_t  flags = NONE,
PID  masterID = 0,
bool  forNPClient = false 
)
psPersistActor::psPersistActor ( MsgEntry me,
NetBase::AccessPointers accessPointers,
bool  forNPClient = false 
)

Member Function Documentation

static uint32_t psPersistActor::PeekEID ( MsgEntry me)
static

Used to extract just the entity EID from the message.

psPersistActor::PSF_DECLARE_MSG_FACTORY ( )
void psPersistActor::SetInstance ( InstanceID  instance)

Used to insert instance into the message buffer after creation.

virtual csString psPersistActor::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.

Reimplemented from psDRMessage.

Member Data Documentation

csString psPersistActor::beltGroup

Used for belt groupings.

Definition at line 3429 of file messages.h.

csVector3 psPersistActor::bottom

Definition at line 3431 of file messages.h.

csString psPersistActor::bracerGroup

Used for bracers groupings.

Definition at line 3428 of file messages.h.

csString psPersistActor::cloakGroup

Used for cloak groupings.

Definition at line 3430 of file messages.h.

bool psPersistActor::control

Definition at line 3440 of file messages.h.

csString psPersistActor::equipment

Definition at line 3433 of file messages.h.

csString psPersistActor::factname

Definition at line 3421 of file messages.h.

uint32_t psPersistActor::flags

Definition at line 3442 of file messages.h.

unsigned short int psPersistActor::gender

Definition at line 3426 of file messages.h.

uint32_t psPersistActor::groupID

Definition at line 3438 of file messages.h.

csString psPersistActor::guild

Definition at line 3420 of file messages.h.

csString psPersistActor::helmGroup

Used for helm groupings.

Definition at line 3427 of file messages.h.

InstanceID psPersistActor::instance

Definition at line 3443 of file messages.h.

int psPersistActor::masqueradeType

Definition at line 3435 of file messages.h.

PID psPersistActor::masterID

Definition at line 3441 of file messages.h.

csString psPersistActor::matname

Definition at line 3422 of file messages.h.

csString psPersistActor::MounterAnim

The anim to be used by the mounter.

Definition at line 3425 of file messages.h.

csString psPersistActor::mountFactname

Definition at line 3424 of file messages.h.

float psPersistActor::mountScale

Stores the scale of the mounted actor.

Definition at line 3448 of file messages.h.

csString psPersistActor::name

Definition at line 3419 of file messages.h.

csVector3 psPersistActor::offset

Definition at line 3431 of file messages.h.

EID psPersistActor::ownerEID

Definition at line 3439 of file messages.h.

PID psPersistActor::playerID

Definition at line 3437 of file messages.h.

int psPersistActor::posInstance

Remember the position of the instance field in the generated message.

Definition at line 3446 of file messages.h.

int psPersistActor::posPlayerID

Remember the position the playerID in the generated message.

Definition at line 3445 of file messages.h.

csString psPersistActor::race

Definition at line 3423 of file messages.h.

float psPersistActor::scale

Stores the scale of the actor. Total model scale.

Definition at line 3447 of file messages.h.

uint8_t psPersistActor::serverMode

Definition at line 3436 of file messages.h.

csString psPersistActor::texParts

Definition at line 3432 of file messages.h.

csVector3 psPersistActor::top

Definition at line 3431 of file messages.h.

int psPersistActor::type

Definition at line 3434 of file messages.h.


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