SCR_CharacterRankComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_CharacterRankComponentClass

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	SpecialRankHandling (SCR_ECharacterRank newRank, SCR_ECharacterRank prevRank)
	Helper method for specific ranks with custom logic attached to them.
void	AttemptSwitchFaction (SCR_CampaignFaction campaignFaction)
	Helper method for attempting to switch factions.
void	FinishFactionSwitch (SCR_PlayerFactionAffiliationComponent component, int factionIndex, bool response)
	Callback method for ensuring that completed faction switches are set up correctly.
void	SetCharacterRank (SCR_ECharacterRank rank, bool silent=false)
void	OnRankChanged (SCR_ECharacterRank prevRank, SCR_ECharacterRank newRank, bool silent)
SCR_Faction	GetCharacterFaction (IEntity unit)
SCR_ECharacterRank	GetCharacterRank ()
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)
override void	OnPostInit (IEntity owner)
	Editable Mine.
void	SCR_CharacterRankComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Variables
IEntity	m_Owner

Function Documentation

AttemptSwitchFaction()

void AttemptSwitchFaction ( SCR_CampaignFaction campaignFaction )

protected

Helper method for attempting to switch factions.

Definition at line 54 of file SCR_CharacterRankComponent.c.

Attribute()

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

FinishFactionSwitch()

void FinishFactionSwitch ( SCR_PlayerFactionAffiliationComponent component, int factionIndex, bool response )

protected

Callback method for ensuring that completed faction switches are set up correctly.

Definition at line 89 of file SCR_CharacterRankComponent.c.

GetCharacterFaction()

SCR_Faction GetCharacterFaction ( IEntity unit )

protected

Definition at line 147 of file SCR_CharacterRankComponent.c.

GetCharacterRank()

SCR_ECharacterRank GetCharacterRank ( )

protected

Definition at line 273 of file SCR_CharacterRankComponent.c.

OnRankChanged()

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

protected

Definition at line 124 of file SCR_CharacterRankComponent.c.

RpcDoSetCharacterRank()

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

protected

Parameters

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

Definition at line 20 of file SCR_CharacterRankComponent.c.

RplLoad()

override bool RplLoad ( ScriptBitReader reader )

protected

Definition at line 287 of file SCR_CharacterRankComponent.c.

RplSave()

override bool RplSave ( ScriptBitWriter writer )

protected

Definition at line 279 of file SCR_CharacterRankComponent.c.

SCR_CharacterRankComponent()

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

protected

Parameters

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

Definition at line 306 of file SCR_CharacterRankComponent.c.

SetCharacterRank()

void SetCharacterRank ( SCR_ECharacterRank rank, bool silent = false )

protected

Parameters

[in]	rank
[in]	silent

Definition at line 114 of file SCR_CharacterRankComponent.c.

SpecialRankHandling()

void SpecialRankHandling ( SCR_ECharacterRank newRank, SCR_ECharacterRank prevRank )

protected

Helper method for specific ranks with custom logic attached to them.

Definition at line 31 of file SCR_CharacterRankComponent.c.

Variable Documentation

m_Owner

IEntity m_Owner

protected

Definition at line 11 of file SCR_CharacterRankComponent.c.