SCR_CharacterRankComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_CharacterRankComponentClass
class	SCR_CharacterRank

Enumerations
enum	SCR_ECharacterRank {   RENEGADE, PRIVATE, CORPORAL, SERGEANT,   LIEUTENANT, CAPTAIN, MAJOR = 4, COLONEL,   GENERAL, CUSTOM1, CUSTOM2, CUSTOM3,   CUSTOM4, CUSTOM5, CUSTOM6, CUSTOM7,   CUSTOM8, CUSTOM9, CUSTOM10, INVALID }

Functions
SCR_CharacterRankComponentClass ScriptComponentClass	Attribute (defvalue:"1", uiwidget:UIWidgets.ComboBox, desc:"Rank", enums:ParamEnumArray.FromEnum(SCR_ECharacterRank))] protected SCR_ECharacterRank m_iRank
void	RpcDoSetCharacterRank (SCR_ECharacterRank newRank, SCR_ECharacterRank prevRank, bool silent)
void	SetCharacterRank (SCR_ECharacterRank rank, bool silent=false)
protected void	OnRankChanged (SCR_ECharacterRank prevRank, SCR_ECharacterRank newRank, bool silent)
protected SCR_Faction	GetCharacterFaction (IEntity unit)
protected SCR_ECharacterRank	GetCharacterRank ()
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)
override void	OnPostInit (IEntity owner)
	Called on PostInit when all components are added. More...
void	SCR_CharacterRankComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
class SCR_CharacterRank	BaseContainerProps ()] class SCR_RankID
SCR_ECharacterRank	GetRankID ()
string	GetRankName ()
string	GetRankNameUpperCase ()
string	GetRankNameShort ()
string	GetRankInsignia ()

Variables
protected IEntity	m_Owner
protected SCR_ECharacterRank	m_iRank
protected string	m_sRankName
protected string	m_sRankNameUpper
protected string	m_sRankNameShort
protected string	m_sInsignia

Enumeration Type Documentation

SCR_ECharacterRank

enum SCR_ECharacterRank

Enumerator
RENEGADE
PRIVATE
CORPORAL
SERGEANT
LIEUTENANT
CAPTAIN
MAJOR
COLONEL
GENERAL
CUSTOM1
CUSTOM2
CUSTOM3
CUSTOM4
CUSTOM5
CUSTOM6
CUSTOM7
CUSTOM8
CUSTOM9
CUSTOM10
INVALID	Missing components, or obstruction test was not possible.

Definition at line 305 of file SCR_CharacterRankComponent.c.

Function Documentation

Attribute()

SCR_CharacterRankComponentClass ScriptComponentClass Attribute	(	defvalue:"1"	,
		uiwidget:UIWidgets.	ComboBox,
		desc:"Rank"	,
		enums:ParamEnumArray.	FromEnumSCR_ECharacterRank
	)

BaseContainerProps()

class SCR_CharacterRank BaseContainerProps

(

)

Returns

Definition at line 269 of file SCR_CharacterRankComponent.c.

GetCharacterFaction()

protected SCR_Faction GetCharacterFaction

(

IEntity

unit

)

Definition at line 71 of file SCR_CharacterRankComponent.c.

GetCharacterRank()

protected SCR_ECharacterRank GetCharacterRank

(

)

Definition at line 176 of file SCR_CharacterRankComponent.c.

GetRankID()

SCR_ECharacterRank BaseContainerProps::GetRankID

(

)

Returns

Definition at line 227 of file SCR_CharacterRankComponent.c.

GetRankInsignia()

string BaseContainerProps::GetRankInsignia

(

)

Returns

Definition at line 255 of file SCR_CharacterRankComponent.c.

GetRankName()

string BaseContainerProps::GetRankName

(

)

Returns

Definition at line 234 of file SCR_CharacterRankComponent.c.

GetRankNameShort()

string BaseContainerProps::GetRankNameShort

(

)

Returns

Definition at line 248 of file SCR_CharacterRankComponent.c.

GetRankNameUpperCase()

string BaseContainerProps::GetRankNameUpperCase

(

)

Returns

Definition at line 241 of file SCR_CharacterRankComponent.c.

OnRankChanged()

protected void OnRankChanged	(	SCR_ECharacterRank	prevRank,
		SCR_ECharacterRank	newRank,
		bool	silent
	)

Definition at line 48 of file SCR_CharacterRankComponent.c.

RpcDoSetCharacterRank()

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

Parameters

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

Definition at line 20 of file SCR_CharacterRankComponent.c.

RplLoad()

override bool RplLoad

(

ScriptBitReader

reader

)

Definition at line 190 of file SCR_CharacterRankComponent.c.

RplSave()

override bool RplSave

(

ScriptBitWriter

writer

)

Definition at line 182 of file SCR_CharacterRankComponent.c.

SCR_CharacterRankComponent()

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

Parameters

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

Definition at line 209 of file SCR_CharacterRankComponent.c.

SetCharacterRank()

void SetCharacterRank	(	SCR_ECharacterRank	rank,
		bool	silent = false
	)

Parameters

[in]	rank
[in]	silent

Definition at line 38 of file SCR_CharacterRankComponent.c.

Variable Documentation

m_iRank

protected SCR_ECharacterRank m_iRank

Definition at line 211 of file SCR_CharacterRankComponent.c.

m_Owner

protected IEntity m_Owner

Definition at line 11 of file SCR_CharacterRankComponent.c.

m_sInsignia

protected string m_sInsignia

Definition at line 223 of file SCR_CharacterRankComponent.c.

m_sRankName

protected string m_sRankName

Definition at line 214 of file SCR_CharacterRankComponent.c.

m_sRankNameShort

protected string m_sRankNameShort

Definition at line 220 of file SCR_CharacterRankComponent.c.

m_sRankNameUpper

protected string m_sRankNameUpper

Definition at line 217 of file SCR_CharacterRankComponent.c.