Planeshift
Public Types | Public Member Functions | Public Attributes | Static Public Attributes

psActionLocation Class Reference

This huge class stores all the properties of any object a player can have in the game. More...

#include <psactionlocationinfo.h>

List of all members.

Public Types

enum  TriggerType { TRIGGERTYPE_NONE, TRIGGERTYPE_SELECT, TRIGGERTYPE_PROXIMITY }

Public Member Functions

bool Delete ()
const csString & GetDescription () const
 Returns action location description.
MathExpressionGetEnterScript () const
 Returns the enter script in entrance action location response string.
const InstanceID GetEntranceInstance () const
 Set entrace Instance in the world if not defined number of the action location.
csVector3 GetEntrancePosition () const
 Returns or sets entrance location memebers.
float GetEntranceRotation () const
const csString & GetEntranceSector () const
const csString & GetEntranceType () const
 Returns the entrance type in entrance action location response string.
gemActionLocationGetGemObject (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.
const csVector3 & GetPosition ()
gemItemGetRealItem ()
const InstanceID GetReturnInstance () const
 Set return Instance in the world if not defined 0.
csVector3 GetReturnPosition () const
 Returns or sets return location memebers.
float GetReturnRotation () const
const csString & GetReturnSector () const
csString GetScriptParameters ()
csString GetScriptToRun ()
 Get script to run.
const csString & GetSectorName ()
TriggerType GetTriggerType () const
const char * GetTriggerTypeAsString () const
bool IsActive () const
 Returns true if this action location is actaive.
bool IsContainer () const
 Returns true if this action location is a container.
bool IsEntrance () const
 Returns true if this action location is an entrance.
bool IsExamineScript () const
 Returns true if this action location will run a script and can be examined.
bool IsGameBoard () const
 Returns true if this action location is a minigame board.
bool IsLockable () const
 Returns true if this action location is an lockable entrance.
int IsMatch (psActionLocation *compare)
bool IsReturn () const
 Returns true if this action location has return tag.
bool Load (csRef< iDocumentNode > root)
bool Load (iResultRow &row)
void operator delete (void *)
 The delete operator is overriden to call PoolAllocator template functions.
void * operator new (size_t)
 The new operator is overriden to call PoolAllocator template functions.
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.
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.
void SetInstanceID (InstanceID newID)
void SetIsEntrance (bool flag)
void SetIsLockable (bool flag)
void SetMeshName (const csString &newmeshname)
void SetName (const csString &newname)
 Sets.
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.
void SetSectorName (const csString &newsector)
void SetTriggerType (const TriggerType &newtrigger)
csString ToXML () const
 ~psActionLocation ()

Public Attributes

gemActionLocationgemAction
uint32 id
size_t master_id
csString meshname
 Mesh name.
csString name
csString polygon
 Required if multiple mesh of same name in area.
InstanceID pos_instance
 The instance from where this action location will be accesible.
csVector3 position
 x,y,z coordinates required for entrances
float radius
csString response
csString responsetype
csString sectorname
 Sector Where item is located.
TriggerType triggertype

Static Public Attributes

static const char * TriggerTypeStr []

Detailed Description

This huge class stores all the properties of any object a player can have in the game.

All stats, bonuses, maluses, magic stat alterations, combat properties, spell effects, and so forth are all stored here.

Definition at line 60 of file psactionlocationinfo.h.


Member Enumeration Documentation

Enumerator:
TRIGGERTYPE_NONE 
TRIGGERTYPE_SELECT 

Default initial value, should not exist after loaded.

TRIGGERTYPE_PROXIMITY 

Definition at line 63 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 185 of file psactionlocationinfo.h.

MathExpression* psActionLocation::GetEnterScript ( ) const [inline]

Returns the enter script in entrance action location response string.

Definition at line 115 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 220 of file psactionlocationinfo.h.

csVector3 psActionLocation::GetEntrancePosition ( ) const [inline]

Returns or sets entrance location memebers.

Definition at line 195 of file psactionlocationinfo.h.

float psActionLocation::GetEntranceRotation ( ) const [inline]

Definition at line 203 of file psactionlocationinfo.h.

const csString& psActionLocation::GetEntranceSector ( ) const [inline]

Definition at line 211 of file psactionlocationinfo.h.

const csString& psActionLocation::GetEntranceType ( ) const [inline]

Returns the entrance type in entrance action location response string.

Definition at line 121 of file psactionlocationinfo.h.

gemActionLocation* psActionLocation::GetGemObject ( void  )
InstanceID psActionLocation::GetInstance ( ) [inline]

Definition at line 311 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 105 of file psactionlocationinfo.h.

const csVector3& psActionLocation::GetPosition ( ) [inline]

Definition at line 88 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 256 of file psactionlocationinfo.h.

csVector3 psActionLocation::GetReturnPosition ( ) const [inline]

Returns or sets return location memebers.

Definition at line 231 of file psactionlocationinfo.h.

float psActionLocation::GetReturnRotation ( ) const [inline]

Definition at line 239 of file psactionlocationinfo.h.

const csString& psActionLocation::GetReturnSector ( ) const [inline]

Definition at line 247 of file psactionlocationinfo.h.

csString psActionLocation::GetScriptParameters ( ) [inline]

Definition at line 330 of file psactionlocationinfo.h.

csString psActionLocation::GetScriptToRun ( ) [inline]

Get script to run.

Definition at line 326 of file psactionlocationinfo.h.

const csString& psActionLocation::GetSectorName ( ) [inline]

Definition at line 92 of file psactionlocationinfo.h.

TriggerType psActionLocation::GetTriggerType ( ) const [inline]

Definition at line 283 of file psactionlocationinfo.h.

const char* psActionLocation::GetTriggerTypeAsString ( ) const [inline]

Definition at line 287 of file psactionlocationinfo.h.

bool psActionLocation::IsActive ( ) const [inline]

Returns true if this action location is actaive.

Definition at line 175 of file psactionlocationinfo.h.

bool psActionLocation::IsContainer ( ) const [inline]

Returns true if this action location is a container.

Definition at line 163 of file psactionlocationinfo.h.

bool psActionLocation::IsEntrance ( ) const [inline]

Returns true if this action location is an entrance.

Definition at line 143 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 137 of file psactionlocationinfo.h.

bool psActionLocation::IsGameBoard ( ) const [inline]

Returns true if this action location is a minigame board.

Definition at line 131 of file psactionlocationinfo.h.

bool psActionLocation::IsLockable ( ) const [inline]

Returns true if this action location is an lockable entrance.

Definition at line 153 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 169 of file psactionlocationinfo.h.

bool psActionLocation::Load ( csRef< iDocumentNode >  root)
bool psActionLocation::Load ( iResultRow &  row)
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 179 of file psactionlocationinfo.h.

void psActionLocation::SetDescription ( const csString &  newDescription) [inline]

Definition at line 189 of file psactionlocationinfo.h.

void psActionLocation::SetEntranceInstance ( const InstanceID  newInstance) [inline]

Definition at line 225 of file psactionlocationinfo.h.

void psActionLocation::SetEntrancePosition ( csVector3  newPosition) [inline]

Definition at line 199 of file psactionlocationinfo.h.

void psActionLocation::SetEntranceRotation ( float  newRot) [inline]

Definition at line 207 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 215 of file psactionlocationinfo.h.

void psActionLocation::SetEntranceType ( const csString &  newType) [inline]

Definition at line 125 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:
instanceThe instance where this action location will be located

Definition at line 307 of file psactionlocationinfo.h.

void psActionLocation::SetInstanceID ( InstanceID  newID) [inline]

Definition at line 109 of file psactionlocationinfo.h.

void psActionLocation::SetIsEntrance ( bool  flag) [inline]

Definition at line 147 of file psactionlocationinfo.h.

void psActionLocation::SetIsLockable ( bool  flag) [inline]

Definition at line 157 of file psactionlocationinfo.h.

void psActionLocation::SetMeshName ( const csString &  newmeshname) [inline]

Definition at line 275 of file psactionlocationinfo.h.

void psActionLocation::SetName ( const csString &  newname) [inline]

Sets.

Definition at line 267 of file psactionlocationinfo.h.

void psActionLocation::SetPosition ( csVector3  newposition) [inline]

Definition at line 299 of file psactionlocationinfo.h.

void psActionLocation::SetRadius ( float  newradius) [inline]

Definition at line 315 of file psactionlocationinfo.h.

void psActionLocation::SetResponse ( const csString &  newresponse) [inline]

Definition at line 295 of file psactionlocationinfo.h.

void psActionLocation::SetResponseType ( const csString &  newresponsetype) [inline]

Definition at line 291 of file psactionlocationinfo.h.

void psActionLocation::SetReturnInstance ( const InstanceID  newInstance) [inline]

Definition at line 261 of file psactionlocationinfo.h.

void psActionLocation::SetReturnPosition ( csVector3  newPosition) [inline]

Definition at line 235 of file psactionlocationinfo.h.

void psActionLocation::SetReturnRotation ( float  newRot) [inline]

Definition at line 243 of file psactionlocationinfo.h.

void psActionLocation::SetReturnSector ( const csString &  newSector) [inline]

Get return Instance in the world if not defined 0.

Definition at line 251 of file psactionlocationinfo.h.

void psActionLocation::SetSectorName ( const csString &  newsector) [inline]

Definition at line 271 of file psactionlocationinfo.h.

void psActionLocation::SetTriggerType ( const TriggerType newtrigger) [inline]

Definition at line 279 of file psactionlocationinfo.h.

csString psActionLocation::ToXML ( ) const

Member Data Documentation

Definition at line 349 of file psactionlocationinfo.h.

Definition at line 335 of file psactionlocationinfo.h.

Definition at line 336 of file psactionlocationinfo.h.

Mesh name.

Definition at line 340 of file psactionlocationinfo.h.

Definition at line 338 of file psactionlocationinfo.h.

Required if multiple mesh of same name in area.

Definition at line 341 of file psactionlocationinfo.h.

The instance from where this action location will be accesible.

Definition at line 343 of file psactionlocationinfo.h.

x,y,z coordinates required for entrances

Definition at line 342 of file psactionlocationinfo.h.

Definition at line 344 of file psactionlocationinfo.h.

Definition at line 347 of file psactionlocationinfo.h.

Definition at line 346 of file psactionlocationinfo.h.

Sector Where item is located.

Definition at line 339 of file psactionlocationinfo.h.

Definition at line 345 of file psactionlocationinfo.h.

const char* psActionLocation::TriggerTypeStr[] [static]

Definition at line 70 of file psactionlocationinfo.h.


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