Planeshift
Public Member Functions

psItemCreativeStats Class Reference

This class holds info about Creative items such as books, etc. More...

#include <psitemstats.h>

List of all members.

Public Member Functions

PID GetCreator (PSITEMSTATS_CREATORSTATUS &creatorStatus)
 Gets the creator and the status of the creator of this creative.
bool IsThisTheCreator (PID characterID)
 Checks if the passed PID is the creator of this creative.
 psItemCreativeStats ()
 constructor
void SetCreator (PID characterID, PSITEMSTATS_CREATORSTATUS creatorStatus)
 Sets the player passed as the creator of this creative, in case someone doesn't own creation status already, in that case it will be ignored.
 ~psItemCreativeStats ()
 destructor

Detailed Description

This class holds info about Creative items such as books, etc.

Definition at line 351 of file psitemstats.h.


Constructor & Destructor Documentation

psItemCreativeStats::psItemCreativeStats ( )

constructor

psItemCreativeStats::~psItemCreativeStats ( )

destructor


Member Function Documentation

PID psItemCreativeStats::GetCreator ( PSITEMSTATS_CREATORSTATUS creatorStatus)

Gets the creator and the status of the creator of this creative.

Parameters:
creatorStatusA reference to a PSITEMSTATS_CREATORSTATUS which will be filled with the informations about the status of the creator.
Returns:
PID The pid of the character who created this creative in case it's valid, else will return 0 as PID.
bool psItemCreativeStats::IsThisTheCreator ( PID  characterID)

Checks if the passed PID is the creator of this creative.

Parameters:
characterIDThe PID of the player we are checking if it's the creator.
Returns:
TRUE if the passed PID corresponds to the creator of this creative item.
void psItemCreativeStats::SetCreator ( PID  characterID,
PSITEMSTATS_CREATORSTATUS  creatorStatus 
)

Sets the player passed as the creator of this creative, in case someone doesn't own creation status already, in that case it will be ignored.

Parameters:
characterIDThe PID of the character who will be the creator of this creative defintion.
creatorStatusA status from PSITEMSTATS_CREATORSTATUS to which setting the creative.

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