CCommon Class Reference

The base class for CPlayer and CObject classes. More...

#include <ObjectModule.h>

Inheritance diagram for CCommon:

List of all members.

Public Member Functions
	CCommon (CObjectModule *m, int id)
virtual	~CCommon ()
	Destructor.
bool	NeedSynch ()
	Returns whether this CCommon instance requires synchronization.
int &	SynchMode ()
	Returns the current synchronization mode of this instance.
virtual void	Serialize (CPacket *packet)=0
	Serializes the CCommon into a packet.
virtual void	Deserialize (CPacket *packet)=0
	Deserializes the CCommon from a packet.
int	GetId ()
	"id" property getter. See OPSIMUS Scenario Scripting Guide for details.
string	GetName ()
	"name" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetName (string name)
	"name" property setter. See OPSIMUS Scenario Scripting Guide for details.
string	GetMesh ()
	"mesh" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetMesh (string mesh)
	"mesh" property setter. See OPSIMUS Scenario Scripting Guide for details.
Vector3	GetOrigin ()
	"origin" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetOrigin (Vector3 origin)
	"origin" property setter. See OPSIMUS Scenario Scripting Guide for details.
virtual Vector3	GetDirection ()
	"dir" property getter. See OPSIMUS Scenario Scripting Guide for details.
virtual void	SetDirection (Vector3 dir)
	"dir" property setter. See OPSIMUS Scenario Scripting Guide for details.
Vector3	GetVelocity ()
	"vel" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetVelocity (Vector3 vel)
	"vel" property setter. See OPSIMUS Scenario Scripting Guide for details.
void	SetVisible (bool visible)
	"visible" property setter. See OPSIMUS Scenario Scripting Guide for details.
bool	GetVisible ()
	"visible" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetShowBody (bool show)
	"showbody" property setter. See OPSIMUS Scenario Scripting Guide for details.
bool	GetShowBody ()
	"showbody" property getter. See OPSIMUS Scenario Scripting Guide for details.
float	GetTimer ()
	"timer" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetTimer (float timer)
	"timer" property setter. See OPSIMUS Scenario Scripting Guide for details.
string	GetTimerCB ()
	"timerCB" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetTimerCB (string cb)
	"timerCB" property setter. See OPSIMUS Scenario Scripting Guide for details.
string	GetWav ()
	"wav" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetWav (string wav)
	"wav" property setter. See OPSIMUS Scenario Scripting Guide for details.
void	SetWavDist (float dist)
	"wavdist" property setter. See OPSIMUS Scenario Scripting Guide for details.
float	GetWavDist ()
	"wavdist" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetMaterial (string mat)
	"material" property setter. See OPSIMUS Scenario Scripting Guide for details.
string	GetMaterial ()
	"material" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetAFactor (float factor)
	"afactor" property setter. See OPSIMUS Scenario Scripting Guide for details.
float	GetAFactor ()
	"afactor" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetPFactor (float factor)
	"pfactor" property setter. See OPSIMUS Scenario Scripting Guide for details.
float	GetPFactor ()
	"pfactor" property getter. See OPSIMUS Scenario Scripting Guide for details.
int	GetStick ()
	"stick" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetStick (int id)
	"stick" property setter. See OPSIMUS Scenario Scripting Guide for details.
Vector3	GetStickPos ()
	"stickpos" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetStickPos (Vector3 pos)
	"stickpos" property setter. See OPSIMUS Scenario Scripting Guide for details.
Vector3	GetStickDir ()
	"stickdir" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetStickDir (Vector3 dir)
	"stickdir" property setter. See OPSIMUS Scenario Scripting Guide for details.
float	GetOrder ()
	"order" property getter. See OPSIMUS Scenario Scripting Guide for details.
virtual void	SetOrder (float speed)
	"order" property setter. See OPSIMUS Scenario Scripting Guide for details.
void	SetOrderPos (Vector3 pos)
	"orderpos" property setter. See OPSIMUS Scenario Scripting Guide for details.
Vector3	GetOrderPos ()
	"orderpos" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetOrderCB (string cb)
	"orderCB" property setter. See OPSIMUS Scenario Scripting Guide for details.
string	GetOrderCB ()
	"orderCB" property getter. See OPSIMUS Scenario Scripting Guide for details.
float	GetOrderCheck ()
	"ordercheck" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetOrderCheck (float check)
	"ordercheck" property setter. See OPSIMUS Scenario Scripting Guide for details.
void	SetOvermapMesh (string mesh)
	"ommesh" property setter. See OPSIMUS Scenario Scripting Guide for details.
string	GetOvermapMesh ()
	"ommesh" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	SetSelectable (bool selectable)
	"selectable" property setter. See OPSIMUS Scenario Scripting Guide for details.
bool	GetSelectable ()
	"selectable" property getter. See OPSIMUS Scenario Scripting Guide for details.
void	ShowSelectionBox (bool tf)
void	SetParticle (string ptl)
	"particle" property setter. See OPSIMUS Scenario Scripting Guide for details.
string	GetParticle ()
	"particle" property getter. See OPSIMUS Scenario Scripting Guide for details.
virtual int	GetType ()=0
	Returns the type identifier of this instance. Used to denote whether this commons is a CPlayer or CObject.
virtual void	Update (float seconds)
	Executes the CCommon for a number of seconds.
void	UpdateFromThing ()
	Updates the CCommons physical properties.
virtual void	SetFromString (const char *prop, const char *value)
virtual void	CloneInto (CCommon *c)
	Clones this CCommon into another one.
virtual void	Set (const char *prop, object value)
virtual object	Get (const char *prop)

---

Detailed Description

The base class for CPlayer and CObject classes.

---

Constructor & Destructor Documentation

CCommon::CCommon	(	CObjectModule *	m,
		int	id
	)

Constructor.

Parameters:

	m	The object module that this instance will be bounded to.
	id	The id of this instance.

---

Member Function Documentation

void CCommon::ShowSelectionBox

(

bool

tf

)

Enables or disables the selection box around this CCommon in the simulation.

Parameters:

tf

Pass true to enable, false to disable.

virtual void CCommon::SetFromString	(	const char *	prop,
		const char *	value
	)			[virtual]

Sets a property from a string.

Parameters:

	prop	The name of the property.
	value	The value of the property.

Reimplemented in CPlayer, and CObject.

virtual void CCommon::Set	(	const char *	prop,
		object	value
	)			[virtual]

Lua property setter.

Parameters:

	prop	The lua property name.
	value	The lua property value.

Reimplemented in CPlayer, and CObject.

virtual object CCommon::Get

(

const char *

prop

)

[virtual]

Lua property getter.

Parameters:

prop

The lua property name.

Returns:

The lua property value.

Reimplemented in CPlayer, and CObject.

---

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

• ObjectModule.h