psTradeProcesses Class Reference

This class holds the master list of all trade processes possible in the game. More...

#include <pstrade.h>

List of all members.

Public Member Functions
csString	GetAnimation () const
const char *	GetConstraintString () const
uint32	GetEquipementId () const
uint32	GetGarbageId () const
int	GetGarbageQty () const
unsigned int	GetMaxPrimarySkill () const
unsigned int	GetMaxSecondarySkill () const
unsigned int	GetMinPrimarySkill () const
unsigned int	GetMinSecondarySkill () const
csString	GetName () const
int	GetPrimaryPracticePts () const
int	GetPrimaryQualFactor () const
int	GetPrimarySkillId () const
uint32	GetProcessId () const
csString &	GetRenderEffect ()
MathScript *	GetScript ()
	Gets the script associated to this process.
csString	GetScriptName () const
	Gets the name of the script associated to this process.
int	GetSecondaryPracticePts () const
int	GetSecondaryQualFactor () const
int	GetSecondarySkillId () const
int	GetSubprocessId () const
uint32	GetWorkItemId () const
bool	Load (iResultRow &row)
	psTradeProcesses ()
	~psTradeProcesses ()
iScriptableVar implementation
Functions that implement the iScriptableVar interface.
const char *	ToString ()
	Returns the name of the current process.
double	CalcFunction (MathEnvironment *env, const char *functionName, const double *params)
	Does nothing right now just returns 0 for anything passed.
double	GetProperty (MathEnvironment *env, const char *ptr)
	Returns the requested variable stored in this process.
Protected Attributes
csString	animation
csString	constraints
uint32	equipmentId
uint32	garbageId
int	garbageQty
int	maxPriSkill
int	maxSecSkill
int	minPriSkill
int	minSecSkill
csString	name
int	priPracticePts
int	priQualFactor
int	priSkillId
uint32	processId
csString	renderEffect
MathScript *	script
csString	scriptName
int	secPracticePts
int	secQualFactor
int	secSkillId
int	subprocess
uint32	workItemId

---

Detailed Description

This class holds the master list of all trade processes possible in the game.

This class is read only since it is cached and shared by multiple users.

Definition at line 229 of file pstrade.h.

---

Constructor & Destructor Documentation

psTradeProcesses::psTradeProcesses

(

)

psTradeProcesses::~psTradeProcesses

(

)

---

Member Function Documentation

double psTradeProcesses::CalcFunction	(	MathEnvironment *	env,
		const char *	functionName,
		const double *	params
	)		[virtual]

Does nothing right now just returns 0 for anything passed.

Note:

Needed for iScriptableVar.

Implements iScriptableVar.

csString psTradeProcesses::GetAnimation

(

)

const [inline]

Definition at line 246 of file pstrade.h.

const char* psTradeProcesses::GetConstraintString

(

)

const [inline]

Definition at line 258 of file pstrade.h.

uint32 psTradeProcesses::GetEquipementId

(

)

const [inline]

Definition at line 254 of file pstrade.h.

uint32 psTradeProcesses::GetGarbageId

(

)

const [inline]

Definition at line 262 of file pstrade.h.

int psTradeProcesses::GetGarbageQty

(

)

const [inline]

Definition at line 266 of file pstrade.h.

unsigned int psTradeProcesses::GetMaxPrimarySkill

(

)

const [inline]

Definition at line 282 of file pstrade.h.

unsigned int psTradeProcesses::GetMaxSecondarySkill

(

)

const [inline]

Definition at line 301 of file pstrade.h.

unsigned int psTradeProcesses::GetMinPrimarySkill

(

)

const [inline]

Definition at line 278 of file pstrade.h.

unsigned int psTradeProcesses::GetMinSecondarySkill

(

)

const [inline]

Definition at line 297 of file pstrade.h.

csString psTradeProcesses::GetName

(

)

const [inline]

Definition at line 242 of file pstrade.h.

int psTradeProcesses::GetPrimaryPracticePts

(

)

const [inline]

Definition at line 286 of file pstrade.h.

int psTradeProcesses::GetPrimaryQualFactor

(

)

const [inline]

Definition at line 289 of file pstrade.h.

int psTradeProcesses::GetPrimarySkillId

(

)

const [inline]

Definition at line 270 of file pstrade.h.

uint32 psTradeProcesses::GetProcessId

(

)

const [inline]

Definition at line 237 of file pstrade.h.

double psTradeProcesses::GetProperty	(	MathEnvironment *	env,
		const char *	ptr
	)		[virtual]

Returns the requested variable stored in this process.

Note:

Needed for iScriptableVar.

Parameters:

env	The MathEnviroment.
ptr	A pointer to a char array stating the requested variable.

Returns:

A double with the value of the requested variable.

Implements iScriptableVar.

csString& psTradeProcesses::GetRenderEffect

(

)

[inline]

Definition at line 313 of file pstrade.h.

MathScript* psTradeProcesses::GetScript

(

)

[inline]

Gets the script associated to this process.

This can be set from the users of the class and it's a cache for the mathscript.

Returns:

A pointer to the associated mathscript, if any.

Definition at line 325 of file pstrade.h.

csString psTradeProcesses::GetScriptName

(

)

const [inline]

Gets the name of the script associated to this process.

It will be run after the process is done during the generation of the new item.

Returns:

A csString with the name of the script as taken from the database.

Definition at line 339 of file pstrade.h.

int psTradeProcesses::GetSecondaryPracticePts

(

)

const [inline]

Definition at line 305 of file pstrade.h.

int psTradeProcesses::GetSecondaryQualFactor

(

)

const [inline]

Definition at line 309 of file pstrade.h.

int psTradeProcesses::GetSecondarySkillId

(

)

const [inline]

Definition at line 293 of file pstrade.h.

int psTradeProcesses::GetSubprocessId

(

)

const [inline]

Definition at line 274 of file pstrade.h.

uint32 psTradeProcesses::GetWorkItemId

(

)

const [inline]

Definition at line 250 of file pstrade.h.

bool psTradeProcesses::Load

(

iResultRow &

row

)

const char* psTradeProcesses::ToString

(

)

[virtual]

Returns the name of the current process.

Note:

Needed for iScriptableVar.

Returns:

the name of the process.

Implements iScriptableVar.

---

Member Data Documentation

csString psTradeProcesses::animation [protected]

Definition at line 378 of file pstrade.h.

csString psTradeProcesses::constraints [protected]

Definition at line 381 of file pstrade.h.

uint32 psTradeProcesses::equipmentId [protected]

Definition at line 380 of file pstrade.h.

uint32 psTradeProcesses::garbageId [protected]

Definition at line 382 of file pstrade.h.

int psTradeProcesses::garbageQty [protected]

Definition at line 383 of file pstrade.h.

int psTradeProcesses::maxPriSkill [protected]

Definition at line 386 of file pstrade.h.

int psTradeProcesses::maxSecSkill [protected]

Definition at line 391 of file pstrade.h.

int psTradeProcesses::minPriSkill [protected]

Definition at line 385 of file pstrade.h.

int psTradeProcesses::minSecSkill [protected]

Definition at line 390 of file pstrade.h.

csString psTradeProcesses::name [protected]

Definition at line 377 of file pstrade.h.

int psTradeProcesses::priPracticePts [protected]

Definition at line 387 of file pstrade.h.

int psTradeProcesses::priQualFactor [protected]

Definition at line 388 of file pstrade.h.

int psTradeProcesses::priSkillId [protected]

Definition at line 384 of file pstrade.h.

uint32 psTradeProcesses::processId [protected]

Definition at line 375 of file pstrade.h.

csString psTradeProcesses::renderEffect [protected]

Definition at line 394 of file pstrade.h.

MathScript* psTradeProcesses::script [protected]

Definition at line 396 of file pstrade.h.

csString psTradeProcesses::scriptName [protected]

Definition at line 395 of file pstrade.h.

int psTradeProcesses::secPracticePts [protected]

Definition at line 392 of file pstrade.h.

int psTradeProcesses::secQualFactor [protected]

Definition at line 393 of file pstrade.h.

int psTradeProcesses::secSkillId [protected]

Definition at line 389 of file pstrade.h.

int psTradeProcesses::subprocess [protected]

Definition at line 376 of file pstrade.h.

uint32 psTradeProcesses::workItemId [protected]

Definition at line 379 of file pstrade.h.

---

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

• server/bulkobjects/pstrade.h