Inheritance diagram for SCR_PerceivedFactionManagerComponent:

Public Member Functions
Faction	GetFallbackFaction ()

void	ShowPerceivedFactionChangedHint (Faction playerPerceivedFaction)
	Called by SCR_CharacterFactionAffiliationComponent On Perceived faction changed. To show hint to player.

SCR_EPerceivedFactionOutfitType	GetCharacterPerceivedFactionOutfitType ()
	Get the current Perceived faction outfit type. Which determintes how the perceived faction is calculated.

void	SetCharacterPerceivedFactionOutfitType_S (SCR_EPerceivedFactionOutfitType type, int playerID=-1)
	Change the Perceived faction outfit type.

ScriptInvokerInt	GetPerceivedFactionOutfitTypeChanged ()

bool	DoesNoOutfitSetFactionToDefault ()

SCR_EDisguisedKillingPunishment	GetPunishmentKillingWhileDisguisedFlags ()

void	SetPunishmentKillingWhileDisguisedFlags_S (SCR_EDisguisedKillingPunishment punishmentFlags, int playerID=-1)
	Set if killing other characters while perceived as unknown or other faction will count as a team kill param[in] punishKillingWhileDisguised If true punishes players that kill others while disguised param[in] playerID Optional Player ID to send notification.

ScriptInvokerInt	GetOnPunishKillingWhileDisguisedChanged ()

override void	OnPlayerSpawnFinalize_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)

override void	OnPlayerKilled (notnull SCR_InstigatorContextData instigatorContextData)
	Called after a player gets killed.

bool	DoesPerceivedFactionChangesAffectsAI ()

void	SetPerceivedFactionChangesAffectsAI (bool affectsAI, int PlayerID=-1)

void	OnPerceivedFactionChangesAffectsAIChanged ()

ScriptInvokerBool	GetOnPerceivedFactionChangesAffectsAIChanged ()

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

override void	OnPostInit (IEntity owner)

override void	EOnInit (IEntity owner)

Public Member Functions inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	GetGameMode ()

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

void	OnGameStateChanged (SCR_EGameModeState state)
	Called when game mode state changes called on all machines.

void	OnGameModeStart ()
	Called on every machine when game mode starts.

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

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

void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Called after a player is disconnected.

void	OnPlayerSpawned (int playerId, IEntity controlledEntity)
	Called after a player is spawned.

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)

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	HandleOnLoadoutAssigned (int playerID, SCR_BasePlayerLoadout assignedLoadout)
	What happens when a player is assigned a loadout.

void	HandleOnFactionAssigned (int playerID, Faction assignedFaction)
	What happens when a player is assigned a faction.

void	HandleOnSpawnPointAssigned (int playerID, SCR_SpawnPoint spawnPoint)
	What happens when a player is assigned a spawn point.

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_PerceivedFactionManagerComponent	GetInstance ()

Protected Member Functions
void	ShowHint ()

void	OnPerceivedFactionOutfitTypeChanged ()

void	OnPunishKillingWhileDisguisedChanged ()

Protected Attributes
SCR_EPerceivedFactionOutfitType	m_eCharacterPerceivedFactionOutfitType

SCR_EDisguisedKillingPunishment	m_ePunishmentKillingWhileDisguised

bool	m_bNoOutfitFactionSetsDefaultFaction

ref SCR_GeneralHintStorage	m_PerceivedFactionHints

bool	m_bPerceivedFactionChangesAffectsAI

FactionKey	m_sAIFallbackFaction

Faction	m_FallbackFaction

ref ScriptInvokerInt	m_OnPerceivedFactionOutfitTypeChanged

ref ScriptInvokerInt	m_OnPunishKillingWhileDisguisedChanged

ref ScriptInvokerBool	m_OnPerceivedFactionChangesAffectsAI

Protected Attributes inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	m_pGameMode
	The game mode entity this component is attached to.

Static Protected Attributes
static SCR_PerceivedFactionManagerComponent	s_Instance

Constructor & Destructor Documentation

◆ SCR_PerceivedFactionManagerComponent()

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

Member Function Documentation

◆ DoesNoOutfitSetFactionToDefault()

bool SCR_PerceivedFactionManagerComponent.DoesNoOutfitSetFactionToDefault ( )

Returns: true if unknown perceived faction when using type HIGHEST_VALUE the perceived will instead be set to default rather than unknown.

◆ DoesPerceivedFactionChangesAffectsAI()

bool SCR_PerceivedFactionManagerComponent.DoesPerceivedFactionChangesAffectsAI ( )

◆ EOnInit()

override void SCR_PerceivedFactionManagerComponent.EOnInit ( IEntity owner )

◆ GetCharacterPerceivedFactionOutfitType()

SCR_EPerceivedFactionOutfitType SCR_PerceivedFactionManagerComponent.GetCharacterPerceivedFactionOutfitType ( )

Get the current Perceived faction outfit type. Which determintes how the perceived faction is calculated.

◆ GetFallbackFaction()

Faction SCR_PerceivedFactionManagerComponent.GetFallbackFaction ( )

◆ GetInstance()

static SCR_PerceivedFactionManagerComponent SCR_PerceivedFactionManagerComponent.GetInstance ( )

static

◆ GetOnPerceivedFactionChangesAffectsAIChanged()

ScriptInvokerBool SCR_PerceivedFactionManagerComponent.GetOnPerceivedFactionChangesAffectsAIChanged ( )

◆ GetOnPunishKillingWhileDisguisedChanged()

ScriptInvokerInt SCR_PerceivedFactionManagerComponent.GetOnPunishKillingWhileDisguisedChanged ( )

Returns: Get script when punished if player is disguised changes

◆ GetPerceivedFactionOutfitTypeChanged()

ScriptInvokerInt SCR_PerceivedFactionManagerComponent.GetPerceivedFactionOutfitTypeChanged ( )

Returns: Get on Player perceived action type changed script invoker

◆ GetPunishmentKillingWhileDisguisedFlags()

SCR_EDisguisedKillingPunishment SCR_PerceivedFactionManagerComponent.GetPunishmentKillingWhileDisguisedFlags ( )

Returns: The punishment flags set which dictate what the punishment is for killing enemies while disguised

◆ OnPerceivedFactionChangesAffectsAIChanged()

void SCR_PerceivedFactionManagerComponent.OnPerceivedFactionChangesAffectsAIChanged ( )

◆ OnPerceivedFactionOutfitTypeChanged()

void SCR_PerceivedFactionManagerComponent.OnPerceivedFactionOutfitTypeChanged ( )

protected

◆ OnPlayerKilled()

override void SCR_PerceivedFactionManagerComponent.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.

◆ OnPlayerSpawnFinalize_S()

override void SCR_PerceivedFactionManagerComponent.OnPlayerSpawnFinalize_S	(	SCR_SpawnRequestComponent	requestComponent,
		SCR_SpawnHandlerComponent	handlerComponent,
		SCR_SpawnData	data,
		IEntity	entity )

Parameters

[in]	requestComponent
[in]	handlerComponent
[in]	data
[in]	entity

Implements SCR_BaseGameModeComponent.

◆ OnPostInit()

override void SCR_PerceivedFactionManagerComponent.OnPostInit ( IEntity owner )

◆ OnPunishKillingWhileDisguisedChanged()

void SCR_PerceivedFactionManagerComponent.OnPunishKillingWhileDisguisedChanged ( )

protected

◆ SetCharacterPerceivedFactionOutfitType_S()

void SCR_PerceivedFactionManagerComponent.SetCharacterPerceivedFactionOutfitType_S	(	SCR_EPerceivedFactionOutfitType	type,
		int	playerID = -1 )

Change the Perceived faction outfit type.

Which determintes how the perceived faction is calculated param[in] type New type to set param[in] playerID Optional to show notification

◆ SetPerceivedFactionChangesAffectsAI()

void SCR_PerceivedFactionManagerComponent.SetPerceivedFactionChangesAffectsAI	(	bool	affectsAI,
		int	PlayerID = -1 )

◆ SetPunishmentKillingWhileDisguisedFlags_S()

void SCR_PerceivedFactionManagerComponent.SetPunishmentKillingWhileDisguisedFlags_S	(	SCR_EDisguisedKillingPunishment	punishmentFlags,
		int	playerID = -1 )

Set if killing other characters while perceived as unknown or other faction will count as a team kill param[in] punishKillingWhileDisguised If true punishes players that kill others while disguised param[in] playerID Optional Player ID to send notification.

◆ ShowHint()

void SCR_PerceivedFactionManagerComponent.ShowHint ( )

protected

No hints set

Perceived faction is disabled

No hint manager

Get the correct hint depending if killing others while disguised is not punished, is a warcrime or just loses XP

Show the hint

◆ ShowPerceivedFactionChangedHint()

void SCR_PerceivedFactionManagerComponent.ShowPerceivedFactionChangedHint ( Faction playerPerceivedFaction )

Called by SCR_CharacterFactionAffiliationComponent On Perceived faction changed. To show hint to player.

Member Data Documentation

◆ m_bNoOutfitFactionSetsDefaultFaction

bool SCR_PerceivedFactionManagerComponent.m_bNoOutfitFactionSetsDefaultFaction

protected

◆ m_bPerceivedFactionChangesAffectsAI

bool SCR_PerceivedFactionManagerComponent.m_bPerceivedFactionChangesAffectsAI

protected

◆ m_eCharacterPerceivedFactionOutfitType

SCR_EPerceivedFactionOutfitType SCR_PerceivedFactionManagerComponent.m_eCharacterPerceivedFactionOutfitType

protected

◆ m_ePunishmentKillingWhileDisguised

SCR_EDisguisedKillingPunishment SCR_PerceivedFactionManagerComponent.m_ePunishmentKillingWhileDisguised

protected

◆ m_FallbackFaction

Faction SCR_PerceivedFactionManagerComponent.m_FallbackFaction

protected

◆ m_OnPerceivedFactionChangesAffectsAI

ref ScriptInvokerBool SCR_PerceivedFactionManagerComponent.m_OnPerceivedFactionChangesAffectsAI

protected

◆ m_OnPerceivedFactionOutfitTypeChanged

ref ScriptInvokerInt SCR_PerceivedFactionManagerComponent.m_OnPerceivedFactionOutfitTypeChanged

protected

◆ m_OnPunishKillingWhileDisguisedChanged

ref ScriptInvokerInt SCR_PerceivedFactionManagerComponent.m_OnPunishKillingWhileDisguisedChanged

protected

◆ m_PerceivedFactionHints

ref SCR_GeneralHintStorage SCR_PerceivedFactionManagerComponent.m_PerceivedFactionHints

protected

◆ m_sAIFallbackFaction

FactionKey SCR_PerceivedFactionManagerComponent.m_sAIFallbackFaction

protected

◆ s_Instance

SCR_PerceivedFactionManagerComponent SCR_PerceivedFactionManagerComponent.s_Instance

staticprotected

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

Game/GameMode/SCR_PerceivedFactionManagerComponent.c

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ SCR_PerceivedFactionManagerComponent()

Member Function Documentation

◆ DoesNoOutfitSetFactionToDefault()

◆ DoesPerceivedFactionChangesAffectsAI()

◆ EOnInit()

◆ GetCharacterPerceivedFactionOutfitType()

◆ GetFallbackFaction()

◆ GetInstance()

◆ GetOnPerceivedFactionChangesAffectsAIChanged()

◆ GetOnPunishKillingWhileDisguisedChanged()

◆ GetPerceivedFactionOutfitTypeChanged()

◆ GetPunishmentKillingWhileDisguisedFlags()

◆ OnPerceivedFactionChangesAffectsAIChanged()

◆ OnPerceivedFactionOutfitTypeChanged()

◆ OnPlayerKilled()

◆ OnPlayerSpawnFinalize_S()

◆ OnPostInit()

◆ OnPunishKillingWhileDisguisedChanged()

◆ SetCharacterPerceivedFactionOutfitType_S()

◆ SetPerceivedFactionChangesAffectsAI()

◆ SetPunishmentKillingWhileDisguisedFlags_S()

◆ ShowHint()

◆ ShowPerceivedFactionChangedHint()

Member Data Documentation

◆ m_bNoOutfitFactionSetsDefaultFaction

◆ m_bPerceivedFactionChangesAffectsAI

◆ m_eCharacterPerceivedFactionOutfitType

◆ m_ePunishmentKillingWhileDisguised

◆ m_FallbackFaction

◆ m_OnPerceivedFactionChangesAffectsAI

◆ m_OnPerceivedFactionOutfitTypeChanged

◆ m_OnPunishKillingWhileDisguisedChanged

◆ m_PerceivedFactionHints

◆ m_sAIFallbackFaction

◆ s_Instance