An object that the client knows about. More...

#include <pscelclient.h>

Public Member Functions
virtual void	ChangeName (const char *name)

virtual bool	CheckLoadStatus ()
	Delayed mesh loading. More...

int	Flags ()
	Get the flag bit field. More...

	GEMClientObject ()

	GEMClientObject (psCelClient *cel, EID id)

virtual const csBox3 &	GetBBox () const
	Return the bounding box of this entity. More...

EID	GetEID ()

psEffect *	GetEntityLabel ()

const char *	GetFactName ()

virtual int	GetMasqueradeType ()

iMeshWrapper *	GetMesh () const
	Get the mesh that this object has. More...

virtual const char *	GetName ()

virtual GEMOBJECT_TYPE	GetObjectType ()

virtual csVector3	GetPosition ()
	Get position of entity. More...

virtual float	GetRotation ()
	Get rotation of entity as returned by psWorld::Matrix2YRot. More...

virtual iSector *	GetSector () const
	Get sector of entity. More...

virtual iSectorList *	GetSectors () const
	Get list of sectors that entity is in. More...

psEffect *	GetShadow ()

int	GetType ()

bool	HasLabel () const

bool	HasShadow () const

virtual bool	IsAlive ()
	Indicate if this object is alive. More...

void	LoadMesh ()
	Start loading the mesh. More...

void	Move (const csVector3 &pos, const csVector3 &rotangle, const char *room)
	Set the position of mesh. More...

virtual void	PostLoad (bool)
	Delayed load 'post-process'. More...

float	RangeTo (GEMClientObject *obj, bool ignoreY)

void	Rotate (float xRot, float yRot, float zRot)
	Set the rotation of mesh. More...

void	SetEntityLabel (psEffect *el)

virtual void	SetPosition (const csVector3 &pos, const csVector3 &rot, iSector *sector)
	Set position of entity. More...

void	SetShadow (psEffect *shadow)

void	SubstituteRacialMeshFact ()
	Performs helm group substitutions. More...

virtual void	Update ()

virtual	~GEMClientObject ()

Public Member Functions inherited from DelayedLoader
virtual	~DelayedLoader ()

Static Public Member Functions
static void	UnsetCelClient ()

Public Attributes
csRef< iMeshWrapper >	pcmesh

Protected Attributes
EID	eid

psEffect *	entitylabel

csString	factName

int	flags
	Various flags on the entity. More...

bool	hasLabel

bool	hasShadow

csRef< InstanceObject >	instance

csString	matName

csString	name

csRef< csShaderVariable >	position

psEffect *	shadow

int	type

Static Protected Attributes
static psCelClient *	cel

Detailed Description

An object that the client knows about.

This is the base object for any 'entity' that the client can be sent.

Definition at line 373 of file pscelclient.h.

Constructor & Destructor Documentation

GEMClientObject::GEMClientObject ( )

GEMClientObject::GEMClientObject	(	psCelClient *	cel,
		EID	id
	)

virtual GEMClientObject::~GEMClientObject ( )

virtual

Member Function Documentation

virtual void GEMClientObject::ChangeName ( const char * name )

virtual

virtual bool GEMClientObject::CheckLoadStatus ( )

inlinevirtual

Delayed mesh loading.

Implements DelayedLoader.

Reimplemented in GEMClientItem, and GEMClientActor.

Definition at line 507 of file pscelclient.h.

int GEMClientObject::Flags ( )

inline

Get the flag bit field.

Returns: The bit field that contains the flags on this actor.

Definition at line 480 of file pscelclient.h.

virtual const csBox3& GEMClientObject::GetBBox ( ) const

virtual

Return the bounding box of this entity.

EID GEMClientObject::GetEID ( )

inline

Definition at line 427 of file pscelclient.h.

psEffect* GEMClientObject::GetEntityLabel ( )

inline

Definition at line 451 of file pscelclient.h.

const char* GEMClientObject::GetFactName ( )

inline

Definition at line 446 of file pscelclient.h.

virtual int GEMClientObject::GetMasqueradeType ( )

virtual

Reimplemented in GEMClientActor.

iMeshWrapper* GEMClientObject::GetMesh ( ) const

Get the mesh that this object has.

Returns: The iMeshWrapper or 0 if no mesh.

virtual const char* GEMClientObject::GetName ( )

inlinevirtual

Definition at line 440 of file pscelclient.h.

virtual GEMOBJECT_TYPE GEMClientObject::GetObjectType ( )

inlinevirtual

Reimplemented in GEMClientActionLocation, GEMClientItem, and GEMClientActor.

Definition at line 380 of file pscelclient.h.

virtual csVector3 GEMClientObject::GetPosition ( )

virtual

Get position of entity.

virtual float GEMClientObject::GetRotation ( )

virtual

Get rotation of entity as returned by psWorld::Matrix2YRot.

Returns: rotation about y axis

See also: psWorld::Matrix2Yrot

virtual iSector* GEMClientObject::GetSector ( ) const

virtual

Get sector of entity.

Reimplemented in GEMClientActor.

virtual iSectorList* GEMClientObject::GetSectors ( ) const

virtual

Get list of sectors that entity is in.

psEffect* GEMClientObject::GetShadow ( )

inline

Definition at line 460 of file pscelclient.h.

int GEMClientObject::GetType ( )

inline

Definition at line 435 of file pscelclient.h.

bool GEMClientObject::HasLabel ( ) const

inline

Definition at line 499 of file pscelclient.h.

bool GEMClientObject::HasShadow ( ) const

inline

Definition at line 494 of file pscelclient.h.

virtual bool GEMClientObject::IsAlive ( )

inlinevirtual

Indicate if this object is alive.

Reimplemented in GEMClientActor.

Definition at line 472 of file pscelclient.h.

void GEMClientObject::LoadMesh ( )

Start loading the mesh.

void GEMClientObject::Move	(	const csVector3 &	pos,
		const csVector3 &	rotangle,
		const char *	room
	)

Set the position of mesh.

Parameters

pos	the coordinates of the mesh
rotangle	the y axis rotation of the mesh
room	the sector in which the mesh is moved to

virtual void GEMClientObject::PostLoad ( bool )

inlinevirtual

Delayed load 'post-process'.

Definition at line 515 of file pscelclient.h.

float GEMClientObject::RangeTo	(	GEMClientObject *	obj,
		bool	ignoreY
	)

void GEMClientObject::Rotate	(	float	xRot,
		float	yRot,
		float	zRot
	)

Set the rotation of mesh.

Parameters

xRot	the variable used to set the x rotation of the item
yRot	the variable used to set the x rotation of the item
zRot	the variable used to set the z rotation of the item

void GEMClientObject::SetEntityLabel ( psEffect * el )

inline

Definition at line 455 of file pscelclient.h.

virtual void GEMClientObject::SetPosition	(	const csVector3 &	pos,
		const csVector3 &	rot,
		iSector *	sector
	)

virtual

Set position of entity.

void GEMClientObject::SetShadow ( psEffect * shadow )

inline

Definition at line 464 of file pscelclient.h.

void GEMClientObject::SubstituteRacialMeshFact ( )

Performs helm group substitutions.

static void GEMClientObject::UnsetCelClient ( )

inlinestatic

Definition at line 520 of file pscelclient.h.

virtual void GEMClientObject::Update ( )

virtual

Reimplemented in GEMClientActor.

Member Data Documentation

psCelClient* GEMClientObject::cel

staticprotected

Definition at line 526 of file pscelclient.h.

EID GEMClientObject::eid

protected

Definition at line 531 of file pscelclient.h.

psEffect* GEMClientObject::entitylabel

protected

Definition at line 535 of file pscelclient.h.

csString GEMClientObject::factName

protected

Definition at line 529 of file pscelclient.h.

int GEMClientObject::flags

protected

Various flags on the entity.

Definition at line 534 of file pscelclient.h.

bool GEMClientObject::hasLabel

protected

Definition at line 537 of file pscelclient.h.

bool GEMClientObject::hasShadow

protected

Definition at line 538 of file pscelclient.h.

csRef<InstanceObject> GEMClientObject::instance

protected

Definition at line 540 of file pscelclient.h.

csString GEMClientObject::matName

protected

Definition at line 530 of file pscelclient.h.

csString GEMClientObject::name

protected

Definition at line 528 of file pscelclient.h.

csRef<iMeshWrapper> GEMClientObject::pcmesh

Definition at line 431 of file pscelclient.h.

csRef<csShaderVariable> GEMClientObject::position

protected

Definition at line 541 of file pscelclient.h.

psEffect* GEMClientObject::shadow

protected

Definition at line 536 of file pscelclient.h.

int GEMClientObject::type

protected

Definition at line 532 of file pscelclient.h.

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

client/pscelclient.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation