SCR_CharacterRankComponent Interface Reference

Inheritance diagram for SCR_CharacterRankComponent:

Public Member Functions
void	RpcDoSetCharacterRank (SCR_ECharacterRank newRank, SCR_ECharacterRank prevRank, bool silent)
void	SetCharacterRank (SCR_ECharacterRank rank, bool silent=false)
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)
override void	OnPostInit (IEntity owner)
void	SCR_CharacterRankComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Static Public Member Functions
static SCR_CharacterRankComponent	GetCharacterRankComponent (IEntity unit)
static SCR_ECharacterRank	GetCharacterRank (IEntity unit)
	Helper method to easily read a character's rank by providing just the character parameter.
static string	GetRankName (IEntity unit, SCR_ECharacterRank rank)
	Return name of passed rank.
static string	GetCharacterRankName (IEntity unit)
static string	GetCharacterRankNameUpperCase (IEntity unit)
static string	GetCharacterRankNameShort (IEntity unit)
static ResourceName	GetCharacterRankInsignia (IEntity unit)

Static Public Attributes
static ref ScriptInvoker	s_OnRankChanged = new ScriptInvoker()

Protected Member Functions
void	OnRankChanged (SCR_ECharacterRank prevRank, SCR_ECharacterRank newRank, bool silent)
SCR_Faction	GetCharacterFaction (IEntity unit)
SCR_ECharacterRank	GetCharacterRank ()

Protected Attributes
SCR_ECharacterRank	m_iRank
IEntity	m_Owner

Constructor & Destructor Documentation

SCR_CharacterRankComponent()

void SCR_CharacterRankComponent.SCR_CharacterRankComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent )

Parameters

[in]	src
[in]	ent
[in]	parent

Member Function Documentation

GetCharacterFaction()

SCR_Faction SCR_CharacterRankComponent.GetCharacterFaction ( IEntity unit )

protected

GetCharacterRank() [1/2]

SCR_ECharacterRank SCR_CharacterRankComponent.GetCharacterRank ( )

protected

GetCharacterRank() [2/2]

static SCR_ECharacterRank SCR_CharacterRankComponent.GetCharacterRank ( IEntity unit )

static

Helper method to easily read a character's rank by providing just the character parameter.

Parameters

[in]

unit

Returns

GetCharacterRankComponent()

static SCR_CharacterRankComponent SCR_CharacterRankComponent.GetCharacterRankComponent ( IEntity unit )

static

Parameters

[in]

unit

Returns

GetCharacterRankInsignia()

static ResourceName SCR_CharacterRankComponent.GetCharacterRankInsignia ( IEntity unit )

static

Parameters

[in]

unit

Returns

GetCharacterRankName()

static string SCR_CharacterRankComponent.GetCharacterRankName ( IEntity unit )

static

Parameters

[in]

unit

Returns

GetCharacterRankNameShort()

static string SCR_CharacterRankComponent.GetCharacterRankNameShort ( IEntity unit )

static

Parameters

[in]

unit

Returns

GetCharacterRankNameUpperCase()

static string SCR_CharacterRankComponent.GetCharacterRankNameUpperCase ( IEntity unit )

static

Parameters

[in]

unit

Returns

GetRankName()

static string SCR_CharacterRankComponent.GetRankName ( IEntity unit, SCR_ECharacterRank rank )

static

Return name of passed rank.

Parameters

[in]	unit
[in]	rank

Returns

OnPostInit()

override void SCR_CharacterRankComponent.OnPostInit

(

IEntity

owner

)

OnRankChanged()

void SCR_CharacterRankComponent.OnRankChanged ( SCR_ECharacterRank prevRank, SCR_ECharacterRank newRank, bool silent )

protected

RpcDoSetCharacterRank()

void SCR_CharacterRankComponent.RpcDoSetCharacterRank	(	SCR_ECharacterRank	newRank,
		SCR_ECharacterRank	prevRank,
		bool	silent )

Parameters

[in]	newRank
[in]	prevRank
[in]	silent

RplLoad()

override bool SCR_CharacterRankComponent.RplLoad

(

ScriptBitReader

reader

)

RplSave()

override bool SCR_CharacterRankComponent.RplSave

(

ScriptBitWriter

writer

)

SetCharacterRank()

void SCR_CharacterRankComponent.SetCharacterRank	(	SCR_ECharacterRank	rank,
		bool	silent = false )

Parameters

[in]	rank
[in]	silent

Member Data Documentation

m_iRank

SCR_ECharacterRank SCR_CharacterRankComponent.m_iRank

protected

m_Owner

IEntity SCR_CharacterRankComponent.m_Owner

protected

s_OnRankChanged

ref ScriptInvoker SCR_CharacterRankComponent.s_OnRankChanged = new ScriptInvoker()

static

---

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

• Game/Components/SCR_CharacterRankComponent.c