Inheritance diagram for SCR_FactionCommanderHandlerComponent:

Public Member Functions
OnFactionCommanderChangedInvoker	GetOnFactionCommanderChanged ()

int	GetVolunteerCooldown ()

WorldTimestamp	GetFactionCooldown (int factionIndex)

bool	CheckRank ()

SCR_ECharacterRank	GetMinimumRank ()

void	SetFactionCommander (notnull SCR_Faction faction, int commanderPlayerId)

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	OnGameModeStart ()
	Called on every machine when game mode starts.

override void	OnGameEnd ()
	Called on all machines when the world ends.

override void	EOnInit (IEntity owner)

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	OnPlayerKilled (notnull SCR_InstigatorContextData instigatorContextData)
	Called after a player gets killed.

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 Member Functions
static SCR_FactionCommanderHandlerComponent	GetInstance ()

Protected Member Functions
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	OnServerCommanderChanged (int newCommanderId, int oldCommanderId)

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_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.

Member Function Documentation

◆ CheckRank()

bool SCR_FactionCommanderHandlerComponent.CheckRank ( )

◆ EOnInit()

override void SCR_FactionCommanderHandlerComponent.EOnInit ( IEntity owner )

Implemented in SCR_CampaignFactionCommanderHandlerComponent.

◆ GetFactionCooldown()

WorldTimestamp SCR_FactionCommanderHandlerComponent.GetFactionCooldown ( int factionIndex )

◆ GetInstance()

static SCR_FactionCommanderHandlerComponent SCR_FactionCommanderHandlerComponent.GetInstance ( )

static

◆ GetMinimumRank()

SCR_ECharacterRank SCR_FactionCommanderHandlerComponent.GetMinimumRank ( )

◆ GetOnFactionCommanderChanged()

OnFactionCommanderChangedInvoker SCR_FactionCommanderHandlerComponent.GetOnFactionCommanderChanged ( )

◆ GetVolunteerCooldown()

int SCR_FactionCommanderHandlerComponent.GetVolunteerCooldown ( )

◆ OnFactionCommanderChanged()

void SCR_FactionCommanderHandlerComponent.OnFactionCommanderChanged ( )

protected

◆ OnGameEnd()

override void SCR_FactionCommanderHandlerComponent.OnGameEnd ( )

Called on all machines when the world ends.

Implements SCR_BaseGameModeComponent.

◆ OnGameModeStart()

override void SCR_FactionCommanderHandlerComponent.OnGameModeStart ( )

Called on every machine when game mode starts.

This can be immediate (if no pre-game period is set) or can happen after a certain delay, as deemed appropriate by the authority.

Implements SCR_BaseGameModeComponent.

◆ OnPlayerDisconnected()

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

Unregister player from Commander role when they disconnect.

Implements SCR_BaseGameModeComponent.

Implemented in SCR_CampaignFactionCommanderHandlerComponent.

◆ OnPlayerFactionChanged()

void SCR_FactionCommanderHandlerComponent.OnPlayerFactionChanged	(	int	playerId,
		SCR_PlayerFactionAffiliationComponent	playerFactionAffiliationComponent,
		Faction	faction )

protected

Unregister player from Commander role when they change factions.

◆ OnPlayerRegistered()

override void SCR_FactionCommanderHandlerComponent.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_BaseGameModeComponent.

Implemented in SCR_CampaignFactionCommanderHandlerComponent.

◆ OnPostInit()

override void SCR_FactionCommanderHandlerComponent.OnPostInit ( IEntity owner )

◆ OnServerCommanderChanged()

void SCR_FactionCommanderHandlerComponent.OnServerCommanderChanged	(	int	newCommanderId,
		int	oldCommanderId )

protected

Implemented in SCR_CampaignFactionCommanderHandlerComponent.

◆ OnVotingEnd()

void SCR_FactionCommanderHandlerComponent.OnVotingEnd	(	EVotingType	type,
		int	value,
		int	winner )

protected

◆ OnVotingStart()

void SCR_FactionCommanderHandlerComponent.OnVotingStart	(	EVotingType	type,
		int	value )

protected

◆ RpcDo_FactionCooldown()

void SCR_FactionCommanderHandlerComponent.RpcDo_FactionCooldown	(	int	factionIdx,
		WorldTimestamp	timeStamp )

protected

◆ SetFactionCommander()

void SCR_FactionCommanderHandlerComponent.SetFactionCommander	(	notnull SCR_Faction	faction,
		int	commanderPlayerId )

◆ SetGroupForNewCommander()

void SCR_FactionCommanderHandlerComponent.SetGroupForNewCommander ( int newCommanderId )

protected

Sets the commander to his special commander group.

Parameters

[in] old commander id

◆ SetGroupForOldCommander()

void SCR_FactionCommanderHandlerComponent.SetGroupForOldCommander ( int oldCommanderId )

protected

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.

Parameters

[in] oldCommanderId

◆ SetNextVolunteeringTimestamp()

void SCR_FactionCommanderHandlerComponent.SetNextVolunteeringTimestamp	(	int	playerId,
		WorldTimestamp	timestamp )

protected

Member Data Documentation

◆ m_aAIFactionCommanders

ref array<ref SCR_BaseAIFactionCommander> SCR_FactionCommanderHandlerComponent.m_aAIFactionCommanders

protected

◆ m_aFactionCommanders

ref array<int> SCR_FactionCommanderHandlerComponent.m_aFactionCommanders = {}

protected

◆ m_bCheckRank

bool SCR_FactionCommanderHandlerComponent.m_bCheckRank

protected

◆ m_eMinimumCommanderRank

SCR_ECharacterRank SCR_FactionCommanderHandlerComponent.m_eMinimumCommanderRank

protected

◆ m_iReplaceCommanderCooldown

int SCR_FactionCommanderHandlerComponent.m_iReplaceCommanderCooldown

protected

◆ m_iVolunteerCooldown

int SCR_FactionCommanderHandlerComponent.m_iVolunteerCooldown

protected

◆ m_mReplaceCommanderCooldowns

ref map<int, WorldTimestamp> SCR_FactionCommanderHandlerComponent.m_mReplaceCommanderCooldowns = new map<int, WorldTimestamp>()

protected

◆ m_mVotingTimestamps

ref map<int, WorldTimestamp> SCR_FactionCommanderHandlerComponent.m_mVotingTimestamps = new map<int, WorldTimestamp>()

protected

◆ m_OnFactionCommanderChanged

ref OnFactionCommanderChangedInvoker SCR_FactionCommanderHandlerComponent.m_OnFactionCommanderChanged

protected

◆ m_RplComponent

RplComponent SCR_FactionCommanderHandlerComponent.m_RplComponent

protected

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

Game/FactionCommander/Components/SCR_FactionCommanderHandlerComponent.c

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ CheckRank()

◆ EOnInit()

◆ GetFactionCooldown()

◆ GetInstance()

◆ GetMinimumRank()

◆ GetOnFactionCommanderChanged()

◆ GetVolunteerCooldown()

◆ OnFactionCommanderChanged()

◆ OnGameEnd()

◆ OnGameModeStart()

◆ OnPlayerDisconnected()

◆ OnPlayerFactionChanged()

◆ OnPlayerRegistered()

◆ OnPostInit()

◆ OnServerCommanderChanged()

◆ OnVotingEnd()

◆ OnVotingStart()

◆ RpcDo_FactionCooldown()

◆ SetFactionCommander()

◆ SetGroupForNewCommander()

◆ SetGroupForOldCommander()

◆ SetNextVolunteeringTimestamp()

Member Data Documentation

◆ m_aAIFactionCommanders

◆ m_aFactionCommanders

◆ m_bCheckRank

◆ m_eMinimumCommanderRank

◆ m_iReplaceCommanderCooldown

◆ m_iVolunteerCooldown

◆ m_mReplaceCommanderCooldowns

◆ m_mVotingTimestamps

◆ m_OnFactionCommanderChanged

◆ m_RplComponent