Planeshift
psRaceInfo Struct Reference

Defines characteristics of a race associated to an NPC, player or pet. More...

#include <psraceinfo.h>

Public Member Functions

float GetBaseAttribute (PSITEMSTATS_STAT attrib)
 
const char * GetBeltGroup ()
 
const char * GetBracerGroup ()
 
const char * GetCloakGroup ()
 
const char * GetGender ()
 
const char * GetHelmGroup ()
 
const char * GetHonorific ()
 
const char * GetMeshName ()
 
const char * GetMounterAnim ()
 
const char * GetName ()
 Gets the name of this race. More...
 
uint32 GetNaturalArmorID ()
 Returns the natural armor stat id used for this race when it's not equipping an armor. More...
 
uint32 GetNaturalWeaponID ()
 Returns the natural weapon stat id used for this race when it's not equipping a weapon. More...
 
const char * GetObjectPronoun ()
 
const char * GetPossessive ()
 
const char * GetRace ()
 
int GetRaceID ()
 Gets the id of the race (regardless of sex). More...
 
float GetScale ()
 Gets the scale override, if any, of this race. More...
 
void GetSize (csVector3 &size)
 
float GetSpeedModifier ()
 
void GetStartingLocation (float &x, float &y, float &z, float &rot, float &range, const char *&sectorname)
 
const char * GetTextureName ()
 Gets the name of the texture associated to this race, if any. More...
 
int GetUID ()
 Gets the id of the specific race (considering also its sex, and alternative versions),. More...
 
bool Load (iResultRow &row)
 
bool LoadBaseSpeeds (iObjectRegistry *object_reg)
 
 psRaceInfo ()
 
csString ReadableRaceGender ()
 
 ~psRaceInfo ()
 

Public Attributes

csString base_texture_name
 
float baseRegen [4]
 
PSCHARACTER_GENDER gender
 
int initialCP
 
csString mesh_name
 
csString name
 
uint32 natural_armor_id
 
uint32 natural_weapon_id
 
unsigned int race
 
float runBaseSpeed
 
float runMaxSpeed
 
float runMinSpeed
 
csString sex
 
csVector3 size
 
csArray< psRaceStartingLocationstartingLocations
 
unsigned int uid
 
float walkBaseSpeed
 
float walkMaxSpeed
 
float walkMinSpeed
 

Protected Attributes

unsigned short attributes [PSITEMSTATS_STAT_COUNT]
 

Detailed Description

Defines characteristics of a race associated to an NPC, player or pet.

Includes gender, movement speed, armor, items, regeneration, ...

Definition at line 58 of file psraceinfo.h.

Constructor & Destructor Documentation

psRaceInfo::psRaceInfo ( )
psRaceInfo::~psRaceInfo ( )

Member Function Documentation

float psRaceInfo::GetBaseAttribute ( PSITEMSTATS_STAT  attrib)
const char* psRaceInfo::GetBeltGroup ( )
inline

Definition at line 158 of file psraceinfo.h.

const char* psRaceInfo::GetBracerGroup ( )
inline

Definition at line 154 of file psraceinfo.h.

const char* psRaceInfo::GetCloakGroup ( )
inline

Definition at line 162 of file psraceinfo.h.

const char* psRaceInfo::GetGender ( )
inline

Definition at line 128 of file psraceinfo.h.

const char* psRaceInfo::GetHelmGroup ( )
inline

Definition at line 150 of file psraceinfo.h.

const char* psRaceInfo::GetHonorific ( )
const char* psRaceInfo::GetMeshName ( )
inline

Definition at line 137 of file psraceinfo.h.

const char* psRaceInfo::GetMounterAnim ( )
inline

Definition at line 167 of file psraceinfo.h.

const char* psRaceInfo::GetName ( )
inline

Gets the name of this race.

Returns
The race name.

Definition at line 117 of file psraceinfo.h.

uint32 psRaceInfo::GetNaturalArmorID ( )
inline

Returns the natural armor stat id used for this race when it's not equipping an armor.

Returns
The itemstats id of the natural armor.

Definition at line 175 of file psraceinfo.h.

uint32 psRaceInfo::GetNaturalWeaponID ( )
inline

Returns the natural weapon stat id used for this race when it's not equipping a weapon.

Returns
The itemstats id of the natural weapon.

Definition at line 183 of file psraceinfo.h.

const char* psRaceInfo::GetObjectPronoun ( )
const char* psRaceInfo::GetPossessive ( )
const char* psRaceInfo::GetRace ( )
inline

Definition at line 132 of file psraceinfo.h.

int psRaceInfo::GetRaceID ( )
inline

Gets the id of the race (regardless of sex).

Returns
An int rappresenting the whole race.

Definition at line 204 of file psraceinfo.h.

float psRaceInfo::GetScale ( )
inline

Gets the scale override, if any, of this race.

Returns
A float which contains the scale override for this race.

Definition at line 196 of file psraceinfo.h.

void psRaceInfo::GetSize ( csVector3 &  size)
inline

Definition at line 109 of file psraceinfo.h.

float psRaceInfo::GetSpeedModifier ( )
inline

Definition at line 188 of file psraceinfo.h.

void psRaceInfo::GetStartingLocation ( float x,
float y,
float z,
float rot,
float range,
const char *&  sectorname 
)
const char* psRaceInfo::GetTextureName ( )
inline

Gets the name of the texture associated to this race, if any.

Returns
The name of the texture.

Definition at line 145 of file psraceinfo.h.

int psRaceInfo::GetUID ( )
inline

Gets the id of the specific race (considering also its sex, and alternative versions),.

Returns
An int rappresenting the specific instance of the race (as a specific sex).

Definition at line 212 of file psraceinfo.h.

bool psRaceInfo::Load ( iResultRow &  row)
bool psRaceInfo::LoadBaseSpeeds ( iObjectRegistry *  object_reg)
csString psRaceInfo::ReadableRaceGender ( )

Member Data Documentation

unsigned short psRaceInfo::attributes[PSITEMSTATS_STAT_COUNT]
protected

Definition at line 61 of file psraceinfo.h.

csString psRaceInfo::base_texture_name

Definition at line 78 of file psraceinfo.h.

float psRaceInfo::baseRegen[4]

Definition at line 104 of file psraceinfo.h.

PSCHARACTER_GENDER psRaceInfo::gender

Definition at line 75 of file psraceinfo.h.

int psRaceInfo::initialCP

Definition at line 80 of file psraceinfo.h.

csString psRaceInfo::mesh_name

Definition at line 77 of file psraceinfo.h.

csString psRaceInfo::name

Definition at line 72 of file psraceinfo.h.

uint32 psRaceInfo::natural_armor_id

Definition at line 81 of file psraceinfo.h.

uint32 psRaceInfo::natural_weapon_id

Definition at line 82 of file psraceinfo.h.

unsigned int psRaceInfo::race

Definition at line 71 of file psraceinfo.h.

float psRaceInfo::runBaseSpeed

Definition at line 83 of file psraceinfo.h.

float psRaceInfo::runMaxSpeed

Definition at line 83 of file psraceinfo.h.

float psRaceInfo::runMinSpeed

Definition at line 83 of file psraceinfo.h.

csString psRaceInfo::sex

Definition at line 73 of file psraceinfo.h.

csVector3 psRaceInfo::size

Definition at line 79 of file psraceinfo.h.

csArray<psRaceStartingLocation> psRaceInfo::startingLocations

Definition at line 106 of file psraceinfo.h.

unsigned int psRaceInfo::uid

Definition at line 70 of file psraceinfo.h.

float psRaceInfo::walkBaseSpeed

Definition at line 84 of file psraceinfo.h.

float psRaceInfo::walkMaxSpeed

Definition at line 84 of file psraceinfo.h.

float psRaceInfo::walkMinSpeed

Definition at line 84 of file psraceinfo.h.


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