This class stores all the properties of an action location Entrance, return location, name, response type, trigger. More...

#include <psactionlocationinfo.h>

Public Types
enum	TriggerType { TRIGGERTYPE_NONE, TRIGGERTYPE_SELECT, TRIGGERTYPE_PROXIMITY }

Public Member Functions
bool	Delete ()

const csString &	GetDescription () const
	Returns action location description. More...

MathExpression *	GetEnterScript () const
	Returns the enter script in entrance action location response string. More...

const InstanceID	GetEntranceInstance () const
	Set entrace Instance in the world if not defined number of the action location. More...

csVector3	GetEntrancePosition () const
	Returns or sets entrance location memebers. More...

float	GetEntranceRotation () const

const csString &	GetEntranceSector () const

const csString &	GetEntranceType () const
	Returns the entrance type in entrance action location response string. More...

gemActionLocation *	GetGemObject (void)

InstanceID	GetInstance ()

InstanceID	GetInstanceID () const
	Returns instance ID of referenced in action location response string This is either a container ID or a lock ID. More...

const csVector3 &	GetPosition ()

gemItem *	GetRealItem ()

const InstanceID	GetReturnInstance () const
	Set return Instance in the world if not defined 0. More...

csVector3	GetReturnPosition () const
	Returns or sets return location memebers. More...

float	GetReturnRotation () const

const csString &	GetReturnSector () const

csString	GetScriptParameters ()

csString	GetScriptToRun ()
	Get script to run. More...

const csString &	GetSectorName ()

TriggerType	GetTriggerType () const

const char *	GetTriggerTypeAsString () const

bool	IsActive () const
	Returns true if this action location is actaive. More...

bool	IsContainer () const
	Returns true if this action location is a container. More...

bool	IsEntrance () const
	Returns true if this action location is an entrance. More...

bool	IsExamineScript () const
	Returns true if this action location will run a script and can be examined. More...

bool	IsGameBoard () const
	Returns true if this action location is a minigame board. More...

bool	IsLockable () const
	Returns true if this action location is an lockable entrance. More...

int	IsMatch (psActionLocation *compare)

bool	IsReturn () const
	Returns true if this action location has return tag. More...

bool	Load (iResultRow &row)

bool	Load (csRef< iDocumentNode > root)

void	operator delete (void *)
	The delete operator is overriden to call PoolAllocator template functions. More...

void *	operator new (size_t)
	The new operator is overriden to call PoolAllocator template functions. More...

bool	ParseResponse ()

	psActionLocation ()

bool	Save ()

void	Send (int clientnum)

void	SetActive (bool flag)

void	SetDescription (const csString &newDescription)

void	SetEntranceInstance (const InstanceID newInstance)

void	SetEntrancePosition (csVector3 newPosition)

void	SetEntranceRotation (float newRot)

void	SetEntranceSector (const csString &newSector)
	Get entrace Instance in the world if not defined number of the action location. More...

void	SetEntranceType (const csString &newType)

void	SetGemObject (gemActionLocation *gemAction)

void	SetInstance (const InstanceID instance)
	Sets the instance in the world of this action location, default INSTANCE_ALL. More...

void	SetInstanceID (InstanceID newID)

void	SetIsEntrance (bool flag)

void	SetIsLockable (bool flag)

void	SetMeshName (const csString &newmeshname)

void	SetName (const csString &newname)
	Sets. More...

void	SetPosition (csVector3 newposition)

void	SetRadius (float newradius)

void	SetResponse (const csString &newresponse)

void	SetResponseType (const csString &newresponsetype)

void	SetReturnInstance (const InstanceID newInstance)

void	SetReturnPosition (csVector3 newPosition)

void	SetReturnRotation (float newRot)

void	SetReturnSector (const csString &newSector)
	Get return Instance in the world if not defined 0. More...

void	SetSectorName (const csString &newsector)

void	SetTriggerType (const TriggerType &newtrigger)

csString	ToXML () const

	~psActionLocation ()

Public Attributes
gemActionLocation *	gemAction

uint32	id

size_t	master_id

csString	meshname
	Mesh name. More...

csString	name

csString	polygon
	Required if multiple mesh of same name in area. More...

InstanceID	pos_instance
	The instance from where this action location will be accesible. More...

csVector3	position
	x,y,z coordinates required for entrances More...

float	radius

csString	response

csString	responsetype

csString	sectorname
	Sector Where item is located. More...

TriggerType	triggertype

Static Public Attributes
static const char *	TriggerTypeStr []

Detailed Description

This class stores all the properties of an action location Entrance, return location, name, response type, trigger.

Definition at line 58 of file psactionlocationinfo.h.

Member Enumeration Documentation

enum psActionLocation::TriggerType

Enumerator
TRIGGERTYPE_NONE
TRIGGERTYPE_SELECT	Default initial value, should not exist after loaded.
TRIGGERTYPE_PROXIMITY

Definition at line 61 of file psactionlocationinfo.h.

Constructor & Destructor Documentation

psActionLocation::psActionLocation ( )

psActionLocation::~psActionLocation ( )

Member Function Documentation

bool psActionLocation::Delete ( )

const csString& psActionLocation::GetDescription ( ) const

inline

Returns action location description.

Definition at line 183 of file psactionlocationinfo.h.

MathExpression* psActionLocation::GetEnterScript ( ) const

inline

Returns the enter script in entrance action location response string.

Definition at line 113 of file psactionlocationinfo.h.

const InstanceID psActionLocation::GetEntranceInstance ( ) const

inline

Set entrace Instance in the world if not defined number of the action location.

Definition at line 218 of file psactionlocationinfo.h.

csVector3 psActionLocation::GetEntrancePosition ( ) const

inline

Returns or sets entrance location memebers.

Definition at line 193 of file psactionlocationinfo.h.

float psActionLocation::GetEntranceRotation ( ) const

inline

Definition at line 201 of file psactionlocationinfo.h.

const csString& psActionLocation::GetEntranceSector ( ) const

inline

Definition at line 209 of file psactionlocationinfo.h.

const csString& psActionLocation::GetEntranceType ( ) const

inline

Returns the entrance type in entrance action location response string.

Definition at line 119 of file psactionlocationinfo.h.

gemActionLocation* psActionLocation::GetGemObject ( void )

InstanceID psActionLocation::GetInstance ( )

inline

Definition at line 309 of file psactionlocationinfo.h.

InstanceID psActionLocation::GetInstanceID ( ) const

inline

Returns instance ID of referenced in action location response string This is either a container ID or a lock ID.

Definition at line 103 of file psactionlocationinfo.h.

const csVector3& psActionLocation::GetPosition ( )

inline

Definition at line 86 of file psactionlocationinfo.h.

gemItem* psActionLocation::GetRealItem ( )

const InstanceID psActionLocation::GetReturnInstance ( ) const

inline

Set return Instance in the world if not defined 0.

Definition at line 254 of file psactionlocationinfo.h.

csVector3 psActionLocation::GetReturnPosition ( ) const

inline

Returns or sets return location memebers.

Definition at line 229 of file psactionlocationinfo.h.

float psActionLocation::GetReturnRotation ( ) const

inline

Definition at line 237 of file psactionlocationinfo.h.

const csString& psActionLocation::GetReturnSector ( ) const

inline

Definition at line 245 of file psactionlocationinfo.h.

csString psActionLocation::GetScriptParameters ( )

inline

Definition at line 328 of file psactionlocationinfo.h.

csString psActionLocation::GetScriptToRun ( )

inline

Get script to run.

Definition at line 324 of file psactionlocationinfo.h.

const csString& psActionLocation::GetSectorName ( )

inline

Definition at line 90 of file psactionlocationinfo.h.

TriggerType psActionLocation::GetTriggerType ( ) const

inline

Definition at line 281 of file psactionlocationinfo.h.

const char* psActionLocation::GetTriggerTypeAsString ( ) const

inline

Definition at line 285 of file psactionlocationinfo.h.

bool psActionLocation::IsActive ( ) const

inline

Returns true if this action location is actaive.

Definition at line 173 of file psactionlocationinfo.h.

bool psActionLocation::IsContainer ( ) const

inline

Returns true if this action location is a container.

Definition at line 161 of file psactionlocationinfo.h.

bool psActionLocation::IsEntrance ( ) const

inline

Returns true if this action location is an entrance.

Definition at line 141 of file psactionlocationinfo.h.

bool psActionLocation::IsExamineScript ( ) const

inline

Returns true if this action location will run a script and can be examined.

Definition at line 135 of file psactionlocationinfo.h.

bool psActionLocation::IsGameBoard ( ) const

inline

Returns true if this action location is a minigame board.

Definition at line 129 of file psactionlocationinfo.h.

bool psActionLocation::IsLockable ( ) const

inline

Returns true if this action location is an lockable entrance.

Definition at line 151 of file psactionlocationinfo.h.

int psActionLocation::IsMatch ( psActionLocation * compare )

bool psActionLocation::IsReturn ( ) const

inline

Returns true if this action location has return tag.

Definition at line 167 of file psactionlocationinfo.h.

bool psActionLocation::Load ( iResultRow & row )

bool psActionLocation::Load ( csRef< iDocumentNode > root )

void psActionLocation::operator delete ( void * )

The delete operator is overriden to call PoolAllocator template functions.

void* psActionLocation::operator new ( size_t )

The new operator is overriden to call PoolAllocator template functions.

bool psActionLocation::ParseResponse ( )

bool psActionLocation::Save ( )

void psActionLocation::Send ( int clientnum )

void psActionLocation::SetActive ( bool flag )

inline

Definition at line 177 of file psactionlocationinfo.h.

void psActionLocation::SetDescription ( const csString & newDescription )

inline

Definition at line 187 of file psactionlocationinfo.h.

void psActionLocation::SetEntranceInstance ( const InstanceID newInstance )

inline

Definition at line 223 of file psactionlocationinfo.h.

void psActionLocation::SetEntrancePosition ( csVector3 newPosition )

inline

Definition at line 197 of file psactionlocationinfo.h.

void psActionLocation::SetEntranceRotation ( float newRot )

inline

Definition at line 205 of file psactionlocationinfo.h.

void psActionLocation::SetEntranceSector ( const csString & newSector )

inline

Get entrace Instance in the world if not defined number of the action location.

Definition at line 213 of file psactionlocationinfo.h.

void psActionLocation::SetEntranceType ( const csString & newType )

inline

Definition at line 123 of file psactionlocationinfo.h.

void psActionLocation::SetGemObject ( gemActionLocation * gemAction )

void psActionLocation::SetInstance ( const InstanceID instance )

inline

Sets the instance in the world of this action location, default INSTANCE_ALL.

Parameters

instance The instance where this action location will be located

Definition at line 305 of file psactionlocationinfo.h.

void psActionLocation::SetInstanceID ( InstanceID newID )

inline

Definition at line 107 of file psactionlocationinfo.h.

void psActionLocation::SetIsEntrance ( bool flag )

inline

Definition at line 145 of file psactionlocationinfo.h.

void psActionLocation::SetIsLockable ( bool flag )

inline

Definition at line 155 of file psactionlocationinfo.h.

void psActionLocation::SetMeshName ( const csString & newmeshname )

inline

Definition at line 273 of file psactionlocationinfo.h.

void psActionLocation::SetName ( const csString & newname )

inline

Sets.

Definition at line 265 of file psactionlocationinfo.h.

void psActionLocation::SetPosition ( csVector3 newposition )

inline

Definition at line 297 of file psactionlocationinfo.h.

void psActionLocation::SetRadius ( float newradius )

inline

Definition at line 313 of file psactionlocationinfo.h.

void psActionLocation::SetResponse ( const csString & newresponse )

inline

Definition at line 293 of file psactionlocationinfo.h.

void psActionLocation::SetResponseType ( const csString & newresponsetype )

inline

Definition at line 289 of file psactionlocationinfo.h.

void psActionLocation::SetReturnInstance ( const InstanceID newInstance )

inline

Definition at line 259 of file psactionlocationinfo.h.

void psActionLocation::SetReturnPosition ( csVector3 newPosition )

inline

Definition at line 233 of file psactionlocationinfo.h.

void psActionLocation::SetReturnRotation ( float newRot )

inline

Definition at line 241 of file psactionlocationinfo.h.

void psActionLocation::SetReturnSector ( const csString & newSector )

inline

Get return Instance in the world if not defined 0.

Definition at line 249 of file psactionlocationinfo.h.

void psActionLocation::SetSectorName ( const csString & newsector )

inline

Definition at line 269 of file psactionlocationinfo.h.

void psActionLocation::SetTriggerType ( const TriggerType & newtrigger )

inline

Definition at line 277 of file psactionlocationinfo.h.

csString psActionLocation::ToXML ( ) const

Member Data Documentation

gemActionLocation* psActionLocation::gemAction

Definition at line 347 of file psactionlocationinfo.h.

uint32 psActionLocation::id

Definition at line 333 of file psactionlocationinfo.h.

size_t psActionLocation::master_id

Definition at line 334 of file psactionlocationinfo.h.

csString psActionLocation::meshname

Mesh name.

Definition at line 338 of file psactionlocationinfo.h.

csString psActionLocation::name

Definition at line 336 of file psactionlocationinfo.h.

csString psActionLocation::polygon

Required if multiple mesh of same name in area.

Definition at line 339 of file psactionlocationinfo.h.

InstanceID psActionLocation::pos_instance

The instance from where this action location will be accesible.

Definition at line 341 of file psactionlocationinfo.h.

csVector3 psActionLocation::position

x,y,z coordinates required for entrances

Definition at line 340 of file psactionlocationinfo.h.

float psActionLocation::radius

Definition at line 342 of file psactionlocationinfo.h.

csString psActionLocation::response

Definition at line 345 of file psactionlocationinfo.h.

csString psActionLocation::responsetype

Definition at line 344 of file psactionlocationinfo.h.

csString psActionLocation::sectorname

Sector Where item is located.

Definition at line 337 of file psactionlocationinfo.h.

TriggerType psActionLocation::triggertype

Definition at line 343 of file psactionlocationinfo.h.

const char* psActionLocation::TriggerTypeStr[]

static

Definition at line 68 of file psactionlocationinfo.h.

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

server/bulkobjects/psactionlocationinfo.h

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation