SCR_RankContainer Interface Reference

Public Member Functions
bool	IsRankRenegade (SCR_ECharacterRank rankID)
int	GetRequiredRankXP (SCR_ECharacterRank rankID)
SCR_ECharacterRank	GetRankByXP (int XP)
SCR_ECharacterRank	GetNextRank (SCR_ECharacterRank rankID)
SCR_ECharacterRank	GetPreviousRank (SCR_ECharacterRank rankID)
array< ref SCR_RankInfo >	GetAllRanks ()
SCR_RankInfo	GetRankByID (SCR_ECharacterRank rankIdentifier)
SCR_RankInfo	GetRankByID (SCR_ECharacterRank rankIdentifier, bool fetchNext)
string	GetRankName (SCR_ECharacterRank rankID)
string	GetRankNameUpperCase (SCR_ECharacterRank rankID)
string	GetRankNameShort (SCR_ECharacterRank rankID)
string	GetRankInsignia (SCR_ECharacterRank rankID)

Protected Member Functions
SCR_ECharacterRank	GetRenegadeRank ()

Protected Attributes
ref array< ref SCR_RankInfo >	m_aRanks

Member Function Documentation

GetAllRanks()

array< ref SCR_RankInfo > SCR_RankContainer.GetAllRanks

(

)

GetNextRank()

SCR_ECharacterRank SCR_RankContainer.GetNextRank

(

SCR_ECharacterRank

rankID

)

Parameters

[in]

rank

Returns

the next higher rank

GetPreviousRank()

SCR_ECharacterRank SCR_RankContainer.GetPreviousRank

(

SCR_ECharacterRank

rankID

)

Parameters

[in]

rank

Returns

the next lower rank

GetRankByID() [1/2]

SCR_RankInfo SCR_RankContainer.GetRankByID

(

SCR_ECharacterRank

rankIdentifier

)

GetRankByID() [2/2]

SCR_RankInfo SCR_RankContainer.GetRankByID	(	SCR_ECharacterRank	rankIdentifier,
		bool	fetchNext )

Parameters

[in]	rankIdentifier
[in]	fetchNext	true will try to find higher rank if there is no rank for provided rank identifier. False will look for lower rank

GetRankByXP()

SCR_ECharacterRank SCR_RankContainer.GetRankByXP

(

int

XP

)

Parameters

[in]

XP

Returns

GetRankInsignia()

string SCR_RankContainer.GetRankInsignia

(

SCR_ECharacterRank

rankID

)

Parameters

rankID

Returns

GetRankName()

string SCR_RankContainer.GetRankName

(

SCR_ECharacterRank

rankID

)

Parameters

rankID

Returns

GetRankNameShort()

string SCR_RankContainer.GetRankNameShort

(

SCR_ECharacterRank

rankID

)

Parameters

rankID

Returns

GetRankNameUpperCase()

string SCR_RankContainer.GetRankNameUpperCase

(

SCR_ECharacterRank

rankID

)

Parameters

rankID

Returns

GetRenegadeRank()

SCR_ECharacterRank SCR_RankContainer.GetRenegadeRank ( )

protected

GetRequiredRankXP()

int SCR_RankContainer.GetRequiredRankXP

(

SCR_ECharacterRank

rankID

)

Parameters

[in]

rankID

Returns

IsRankRenegade()

bool SCR_RankContainer.IsRankRenegade

(

SCR_ECharacterRank

rankID

)

Parameters

[in]

rankID

Returns

Member Data Documentation

m_aRanks

ref array<ref SCR_RankInfo> SCR_RankContainer.m_aRanks

protected

---

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

• Game/Ranks/SCR_RankContainer.c