UFO: Alien Invasion
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
cp_rank.h File Reference

Go to the source code of this file.

Data Structures

struct  rank_s
 Describes a rank that a recruit can gain. More...
 

Macros

#define MAX_RANKS   32
 

Typedefs

typedef struct rank_s rank_t
 Describes a rank that a recruit can gain. More...
 

Functions

void CL_ParseRanks (const char *name, const char **text)
 Parse medals and ranks defined in the medals.ufo file. More...
 
int CL_GetRankIdx (const char *rankID)
 Get the index of the given rankID in ccs.ranks array. More...
 
rank_tCL_GetRankByIdx (const int index)
 Returns a rank at an index. More...
 

Macro Definition Documentation

#define MAX_RANKS   32

Definition at line 26 of file cp_rank.h.

Referenced by CL_ParseRanks().

Typedef Documentation

typedef struct rank_s rank_t

Describes a rank that a recruit can gain.

Function Documentation

rank_t* CL_GetRankByIdx ( const int  index)

Returns a rank at an index.

Parameters
[in]indexIndex of rank in ccs.ranks
Returns
nullptr on invalid index
pointer to the rank definition otherwise

Definition at line 50 of file cp_rank.cpp.

References ccs, index, ccs_s::numRanks, and ccs_s::ranks.

Referenced by CHAR_UpdateStats(), CP_TEAM_FillBDEFEmployeeList_f(), GAME_CP_CharacterCvars(), HOS_GetRank(), Employee::salary(), TR_CargoList(), and TR_FillEmployees().

int CL_GetRankIdx ( const char *  rankID)

Get the index of the given rankID in ccs.ranks array.

Parameters
[in]rankIDScript id of the rank
Returns
-1 if no rank with rankID found

Definition at line 34 of file cp_rank.cpp.

References ccs, i, rank_s::id, ccs_s::numRanks, Q_streq, and ccs_s::ranks.

Referenced by E_CreateEmployee().

void CL_ParseRanks ( const char *  name,
const char **  text 
)

Parse medals and ranks defined in the medals.ufo file.

See also
CL_ParseScriptFirst

Definition at line 74 of file cp_rank.cpp.

References ccs, cgi, cgame_import_s::Com_EParse(), Com_Parse(), cp_campaignPool, E_GetEmployeeType(), ERR_DROP, i, rank_s::id, rank_s::image, rank_s::level, MAX_RANKS, rank_s::name, ccs_s::numRanks, OBJZERO, cgame_import_s::PoolStrDup(), Q_streq, ccs_s::ranks, rank_s::shortname, and rank_s::type.

Referenced by CP_ParseScriptFirst().