SCR_CampaignFactionCommanderHandlerComponent Interface Reference

Inheritance diagram for SCR_CampaignFactionCommanderHandlerComponent:

Public Member Functions
int	GetBaseEstablishingRadius ()
int	GetBaseMinDistance (notnull SCR_CampaignMilitaryBaseComponent base)
int	GetBaseMinDistance (SCR_ECampaignBaseType baseType)
void	CreateSeizeTask (notnull SCR_CampaignFaction faction, SCR_CampaignMilitaryBaseComponent targetBase)
	Create seize task.
override void	OnPlayerRegistered (int playerId)
	Called on every machine after a player is registered (identity, name etc.).
override void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Unregister player from Commander role when they disconnect.
override void	OnPlayerKilled (notnull SCR_InstigatorContextData instigatorContextData)
	Called after a player gets killed.
override void	EOnInit (IEntity owner)
void	~SCR_CampaignFactionCommanderHandlerComponent ()
Public Member Functions inherited from SCR_FactionCommanderHandlerComponent
OnFactionCommanderChangedInvoker	GetOnFactionCommanderChanged ()
int	GetVolunteerCooldown ()
WorldTimestamp	GetFactionCooldown (int factionIndex)
bool	CheckRank ()
SCR_ECharacterRank	GetMinimumRank ()
void	SetFactionCommander (notnull SCR_Faction faction, int commanderPlayerId)
override void	OnGameModeStart ()
	Called on every machine when game mode starts.
override void	OnGameEnd ()
	Called on all machines when the world ends.
override void	OnPostInit (IEntity owner)
Public Member Functions inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	GetGameMode ()
void	OnGameStateChanged (SCR_EGameModeState state)
	Called when game mode state changes called on all machines.
void	OnGameModeEnd (SCR_GameModeEndData data)
	Called when game mode ends.
void	OnPlayerConnected (int playerId)
	Called after a player is connected.
void	OnPlayerAuditSuccess (int playerId)
	Event is called when player connecting Session hosting current Game Mode where is required authentication verification via.
void	OnPlayerAuditFail (int playerId)
	Event is called when player connecting Session hosting current Game Mode AuditFail() call may be called under two occasions: 1) verification is required but failed (account is not valid, player is banned, internet issues) 2) player cannot be verified as authentication is not required or possible - where it may be valid behavior (server online connectivity turned off for example) Basically non-audited player cannot access persistency/ etc.
void	OnPlayerAuditTimeouted (int playerId)
	Event is called when player connected to Session was kicked and did not reconnected in time This mean that slot reservation can be canceled.
void	OnPlayerAuditRevived (int playerId)
	Event is called when player reconnected successfully back to Session after kick This mean that slot reservation need to be finished (closed).
bool	PreparePlayerEntity_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
void	OnSpawnPlayerEntityFailure_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, IEntity entity, SCR_SpawnData data, SCR_ESpawnResult reason)
void	OnPlayerSpawnFinalize_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
bool	HandlePlayerKilled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	See SCR_BaseGameMode.HandlePlayerKilled.
void	OnPlayerKilledHandled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	Called after player gets killed in cases where the kill was handled by the game mode, supressing the default OnPlayerKilled behaviour.
void	OnPlayerDeleted (int playerId, IEntity player)
	Called after a player gets deleted.
void	OnPlayerRoleChange (int playerId, EPlayerRole roleFlags)
	Called when player role changes.
void	OnWorldPostProcess (World world)
	Called once loading of all entities of the world have been finished (still within the loading)
void	OnControllableSpawned (IEntity entity)
	When a controllable entity is spawned, this event is raised.
void	OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
	When a controllable entity is destroyed, this event is raised.
void	OnControllableDeleted (IEntity entity)
	Prior to a controllable entity being DELETED, this event is raised.
void	SCR_BaseGameModeComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Static Public Attributes
static const string	SEIZE_TASK_RELAY_NAME = "#AR-CampaignTasks_TitleHack-UC"
static const string	SEIZE_TASK_RELAY_DESC = "#AR-CampaignTasks_DescriptionReconfigure"
static const string	SEIZE_TASK_NAME = "#AR-CampaignTasks_TitleSeize-UC"
static const string	SEIZE_TASK_DESC = "#AR-CampaignTasks_DescriptionSeize"
static const string	SEIZE_TASK_ID = "%1_SeizeCampaignMilitaryBase_%2"
static const ResourceName	SEIZE_TASK_PREFAB = "{1CE0D63C852E747B}Prefabs/Tasks/SeizeCampaignMilitaryBaseTaskEntity.et"

Protected Member Functions
void	OnBaseFactionChanged (SCR_MilitaryBaseComponent base, Faction faction)
void	OnRadioCoverageChanged (notnull SCR_CoverageRadioComponent radio)
void	OnCommanderChanged (SCR_Faction faction, int commanderPlayerId)
void	CheckSeizeTasks (notnull SCR_CampaignFaction faction)
SCR_Task	GetTaskOnBase (notnull SCR_CampaignMilitaryBaseComponent campaignMilitaryBase, notnull Faction faction, TypeName taskClass)
void	OnPlayerXPChanged (int playerId, int currentXP, int XPToAdd, SCR_EXPRewards rewardId)
	Player XP changed, award commander a fraction of gained XP if eligible for the reward.
void	AwardCommanderTaskCompletionXP (int commanderId, SCR_EXPRewards rewardId, int XPToAdd)
	Awards a fraction of gained player XP to Commander The amount of XP added is determined by the original amount of XP multiplied by Commander Reward XP Amount Fraction.
override void	OnServerCommanderChanged (int newCommanderId, int oldCommanderId)
void	RegisterPlayerXPInvokers (int playerId, bool unregister=false)
Protected Member Functions inherited from SCR_FactionCommanderHandlerComponent
void	SetGroupForOldCommander (int oldCommanderId)
	Sets the commander to his previous group if exists and if there is a free slot, otherwise a new group will be created for him.
void	SetGroupForNewCommander (int newCommanderId)
	Sets the commander to his special commander group.
void	RpcDo_FactionCooldown (int factionIdx, WorldTimestamp timeStamp)
void	OnFactionCommanderChanged ()
void	OnPlayerFactionChanged (int playerId, SCR_PlayerFactionAffiliationComponent playerFactionAffiliationComponent, Faction faction)
	Unregister player from Commander role when they change factions.
void	OnVotingStart (EVotingType type, int value)
void	OnVotingEnd (EVotingType type, int value, int winner)
void	SetNextVolunteeringTimestamp (int playerId, WorldTimestamp timestamp)

Protected Attributes
int	m_iBaseEstablishingRadius
ref SCR_MinBaseDistanceConfig	m_MinBaseDistanceConfig
Protected Attributes inherited from SCR_FactionCommanderHandlerComponent
int	m_iVolunteerCooldown
int	m_iReplaceCommanderCooldown
bool	m_bCheckRank
SCR_ECharacterRank	m_eMinimumCommanderRank
ref array< ref SCR_BaseAIFactionCommander >	m_aAIFactionCommanders
ref OnFactionCommanderChangedInvoker	m_OnFactionCommanderChanged
ref map< int, WorldTimestamp >	m_mVotingTimestamps = new map<int, WorldTimestamp>()
ref array< int >	m_aFactionCommanders = {}
RplComponent	m_RplComponent
ref map< int, WorldTimestamp >	m_mReplaceCommanderCooldowns = new map<int, WorldTimestamp>()
Protected Attributes inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	m_pGameMode
	The game mode entity this component is attached to.

Additional Inherited Members
Static Public Member Functions inherited from SCR_FactionCommanderHandlerComponent
static SCR_FactionCommanderHandlerComponent	GetInstance ()

Constructor & Destructor Documentation

~SCR_CampaignFactionCommanderHandlerComponent()

void SCR_CampaignFactionCommanderHandlerComponent.~SCR_CampaignFactionCommanderHandlerComponent

(

)

Member Function Documentation

AwardCommanderTaskCompletionXP()

void SCR_CampaignFactionCommanderHandlerComponent.AwardCommanderTaskCompletionXP ( int commanderId, SCR_EXPRewards rewardId, int XPToAdd )

protected

Awards a fraction of gained player XP to Commander The amount of XP added is determined by the original amount of XP multiplied by Commander Reward XP Amount Fraction.

Parameters

[in]	commander	player Id
[in]	rewardId
[in]	XPToAdd	- the original amount of XP gained

CheckSeizeTasks()

void SCR_CampaignFactionCommanderHandlerComponent.CheckSeizeTasks ( notnull SCR_CampaignFaction faction )

protected

CreateSeizeTask()

void SCR_CampaignFactionCommanderHandlerComponent.CreateSeizeTask	(	notnull SCR_CampaignFaction	faction,
		SCR_CampaignMilitaryBaseComponent	targetBase )

Create seize task.

Parameters

[in]	faction
[in]	targetBase

EOnInit()

override void SCR_CampaignFactionCommanderHandlerComponent.EOnInit

(

IEntity

owner

)

Implements SCR_FactionCommanderHandlerComponent.

GetBaseEstablishingRadius()

int SCR_CampaignFactionCommanderHandlerComponent.GetBaseEstablishingRadius

(

)

GetBaseMinDistance() [1/2]

int SCR_CampaignFactionCommanderHandlerComponent.GetBaseMinDistance

(

notnull SCR_CampaignMilitaryBaseComponent

base

)

Parameters

[in]

base

Returns

min base distance

GetBaseMinDistance() [2/2]

int SCR_CampaignFactionCommanderHandlerComponent.GetBaseMinDistance

(

SCR_ECampaignBaseType

baseType

)

Parameters

[in]

baseType

Returns

min base distance

GetTaskOnBase()

SCR_Task SCR_CampaignFactionCommanderHandlerComponent.GetTaskOnBase ( notnull SCR_CampaignMilitaryBaseComponent campaignMilitaryBase, notnull Faction faction, TypeName taskClass )

protected

OnBaseFactionChanged()

void SCR_CampaignFactionCommanderHandlerComponent.OnBaseFactionChanged ( SCR_MilitaryBaseComponent base, Faction faction )

protected

OnCommanderChanged()

void SCR_CampaignFactionCommanderHandlerComponent.OnCommanderChanged ( SCR_Faction faction, int commanderPlayerId )

protected

OnPlayerDisconnected()

override void SCR_CampaignFactionCommanderHandlerComponent.OnPlayerDisconnected	(	int	playerId,
		KickCauseCode	cause,
		int	timeout )

Unregister player from Commander role when they disconnect.

Implements SCR_FactionCommanderHandlerComponent.

OnPlayerKilled()

override void SCR_CampaignFactionCommanderHandlerComponent.OnPlayerKilled

(

notnull SCR_InstigatorContextData

instigatorContextData

)

Called after a player gets killed.

Parameters

[in]

instigatorContextData

Holds the data of the victim and killer

Implements SCR_BaseGameModeComponent.

OnPlayerRegistered()

override void SCR_CampaignFactionCommanderHandlerComponent.OnPlayerRegistered

(

int

playerId

)

Called on every machine after a player is registered (identity, name etc.).

Always called after OnPlayerConnected.

Parameters

[in]

playerId

PlayerId of registered player.

Implements SCR_FactionCommanderHandlerComponent.

OnPlayerXPChanged()

void SCR_CampaignFactionCommanderHandlerComponent.OnPlayerXPChanged ( int playerId, int currentXP, int XPToAdd, SCR_EXPRewards rewardId )

protected

Player XP changed, award commander a fraction of gained XP if eligible for the reward.

Parameters

[in]	playerId
[in]	currentXP
[in]	XPToAdd
[in]	rewardId

OnRadioCoverageChanged()

void SCR_CampaignFactionCommanderHandlerComponent.OnRadioCoverageChanged ( notnull SCR_CoverageRadioComponent radio )

protected

OnServerCommanderChanged()

override void SCR_CampaignFactionCommanderHandlerComponent.OnServerCommanderChanged ( int newCommanderId, int oldCommanderId )

protected

Implements SCR_FactionCommanderHandlerComponent.

RegisterPlayerXPInvokers()

void SCR_CampaignFactionCommanderHandlerComponent.RegisterPlayerXPInvokers ( int playerId, bool unregister = false )

protected

Member Data Documentation

m_iBaseEstablishingRadius

int SCR_CampaignFactionCommanderHandlerComponent.m_iBaseEstablishingRadius

protected

m_MinBaseDistanceConfig

ref SCR_MinBaseDistanceConfig SCR_CampaignFactionCommanderHandlerComponent.m_MinBaseDistanceConfig

protected

SEIZE_TASK_DESC

const string SCR_CampaignFactionCommanderHandlerComponent.SEIZE_TASK_DESC = "#AR-CampaignTasks_DescriptionSeize"

static

SEIZE_TASK_ID

const string SCR_CampaignFactionCommanderHandlerComponent.SEIZE_TASK_ID = "%1_SeizeCampaignMilitaryBase_%2"

static

SEIZE_TASK_NAME

const string SCR_CampaignFactionCommanderHandlerComponent.SEIZE_TASK_NAME = "#AR-CampaignTasks_TitleSeize-UC"

static

SEIZE_TASK_PREFAB

const ResourceName SCR_CampaignFactionCommanderHandlerComponent.SEIZE_TASK_PREFAB = "{1CE0D63C852E747B}Prefabs/Tasks/SeizeCampaignMilitaryBaseTaskEntity.et"

static

SEIZE_TASK_RELAY_DESC

const string SCR_CampaignFactionCommanderHandlerComponent.SEIZE_TASK_RELAY_DESC = "#AR-CampaignTasks_DescriptionReconfigure"

static

SEIZE_TASK_RELAY_NAME

const string SCR_CampaignFactionCommanderHandlerComponent.SEIZE_TASK_RELAY_NAME = "#AR-CampaignTasks_TitleHack-UC"

static

---

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

• Game/FactionCommander/Components/SCR_CampaignFactionCommanderHandlerComponent.c