Inheritance diagram for SCR_CampaignFeedbackComponent:

Public Member Functions
void	UpdatePlayerSpawnHint (bool show, vector position=vector.Zero)
	Serves for updating spawn hint on map witth he given position.

void	SetMapCampaignUI (SCR_MapCampaignUI mapUi)

void	SetSpawnTime ()

TimeContainer	GetSpawnTime ()

bool	CanShowPlayerSpawn ()

vector	GetPlayerSpawnPos ()
	Returns players position after spawning.

bool	WasMapOpened ()

void	SetMapOpened (bool wasOpened)
	Sets that map was already opened by player.

SCR_CampaignMilitaryBaseComponent	GetBaseWithPlayer ()

void	SetIsPlayerInRadioRange (bool status)

void	BaseOutOfRangeHint (SCR_CampaignMilitaryBaseComponent base)

void	OnMapOpen (MapConfiguration config)

void	OnEntryPerformed (SCR_SelectionMenuEntry entry)

void	OnMapClose (MapConfiguration config)

void	OnRespawn ()
	Hints are displayed with a delay after respawn so player has time to find their bearings.

void	ShowHint (EHint hintID, bool showImmediately=false, bool showMultipleTimes=false)

void	PauseHintQueue ()

void	OnConsciousnessChanged (bool conscious)
	Upon death, the unconscious state is no longer detectable, we need to cache it.

bool	IsConscious ()

void	OnPlayerKilled (notnull SCR_InstigatorContextData instigatorContextData)

void	OnBaseFactionChanged (notnull SCR_MilitaryBaseComponent base, Faction faction)

void	OnBaseEntered (notnull SCR_CampaignMilitaryBaseComponent base)

void	OnBaseLeft (notnull SCR_CampaignMilitaryBaseComponent base)

void	OnSeizingTimerChange (WorldTimestamp start, WorldTimestamp end)

void	MobileAssemblyFeedback (SCR_EMobileAssemblyStatus msgID, int playerID, int factionID)

void	PlayRadioMsg (SCR_ERadioMsg msg, int factionId, int baseCallsign, int callerCallsignCompany, int callerCallsignPlatoon, int callerCallsignSquad, int callerCallsignCharacter, int calledCallsignCompany, int calledCallsignPlatoon, int calledCallsignSquad, int calledCallsignCharacter, int param, float seed, float quality)

void	OnOwnershipChanged (bool changing, bool becameOwner)

void	OnPlayerSuppliesInteraction (EResourcePlayerInteractionType interactionType, PlayerController playerController, SCR_ResourceComponent resourceComponentFrom, SCR_ResourceComponent resourceComponentTo, EResourceType resourceType, float resourceValue)

override void	EOnInit (IEntity owner)

override void	OnPostInit (IEntity owner)

void	~SCR_CampaignFeedbackComponent ()

Static Public Member Functions
static SCR_CampaignFeedbackComponent	GetInstance ()

Static Public Attributes
static const float	ICON_FLASH_DURATION = 20

static const float	ICON_FLASH_PERIOD = 0.5

Protected Member Functions
void	CheckPlayerInsideRadioRange ()

void	RegisterTasksShown ()

void	GroupLeaderHint ()

void	LoneDriverHint ()

void	TransportRequestHint ()

void	OnRadialMenuAvailable ()

void	OnBaseHovered (SCR_CampaignMilitaryBaseComponent base)

void	OnCommanderVolunteer (int playerId)

void	OnFactionCommanderChanged (SCR_Faction faction, int commanderPlayerId)

void	OnBaseClickedShowSupplyLimit (bool selected)

void	RefreshCurrentPopupMessage ()

void	OnCheckEstablishmentArea ()

void	OnTaskAssigneeAdded (SCR_Task task, SCR_TaskExecutor executor, int requesterID)

void	ProcessHintQueue ()

bool	IsLocalPlayerAlive ()

void	OnMatchSituationChanged ()

void	OnXPChanged (int totalXP, SCR_EXPRewards rewardID, int XP, bool volunteer, bool profileUsed, int skillLevel)

void	OnPlayerJoinedGroup (SCR_AIGroup group, int playerID)

void	OnGroupMenuShow ()

void	OnTaskSelected (SCR_Task task)

void	OnVehicleEnter (ChimeraCharacter playerCharacter, IEntity compartmentEntit)
	Called when local player enters any vehicle compartment.

void	RegisterVehicleListener ()
	Registers a callback for vehicle enter events for the local player.

void	RegisterVehicleEnter ()

void	UnregisterVehicleEnter ()

void	OnTaskStateChanged (SCR_Task task, SCR_ETaskState newState)

void	OnRadialMenuOpen ()

void	OnJournalOpened (bool newVisibility)

void	NightHint ()

void	OnArsenalOpen ()

void	OnItemSlotHover (SCR_InventorySlotUI slot)

void	TryRegisterInventoryHover ()

void	CheckSquadCohesionHint ()

void	ProcessEvents (bool activate)

void	ShowVolunteerHint (bool newVisibility)

Protected Attributes
ResourceName	m_sHintsConfig

int	m_iVehicleHintDelay

SCR_GameModeCampaign	m_Campaign

SCR_PlayerController	m_PlayerController

SCR_CampaignMilitaryBaseComponent	m_BaseWithPlayer

AudioHandle	m_PlayedRadio = AudioHandle.Invalid

vector	m_vFirstSpawnPosition

SCR_MapCampaignUI	m_MapCampaignUI

ref TimeContainer	m_SpawnTime

ref SCR_CampaignHintStorage	m_HintsConfig

ref array< int >	m_aShownHints = {}

ref array< int >	m_aHintQueue = {}

bool	m_bIsPlayerInRadioRange = true

bool	m_bCanShowSpawnPosition

bool	m_bWasMapOpened

bool	m_bIsConscious

bool	m_bWasNight

bool	m_bCohesionHintWasShown

float	m_fNextAllowedHintTimestamp

WorldTimestamp	m_fBaseWithPlayerCaptureStart

WorldTimestamp	m_fBaseWithPlayerCaptureEnd

Static Protected Attributes
static const int	AFTER_RESPAWN_HINT_DELAY_MS = 16500

static const int	DELAY_BETWEEN_HINTS_MS = 1000

static const int	FEATURE_HINT_DELAY = 120000

static const int	NIGHT_HINT_DELAY_MS = 10000

static const int	COHESION_HINT_DELAY_MS = 20000

Constructor & Destructor Documentation

◆ ~SCR_CampaignFeedbackComponent()

void SCR_CampaignFeedbackComponent.~SCR_CampaignFeedbackComponent ( )

Member Function Documentation

◆ BaseOutOfRangeHint()

void SCR_CampaignFeedbackComponent.BaseOutOfRangeHint ( SCR_CampaignMilitaryBaseComponent base )

Parameters

[in] base

◆ CanShowPlayerSpawn()

bool SCR_CampaignFeedbackComponent.CanShowPlayerSpawn ( )

Returns

◆ CheckPlayerInsideRadioRange()

void SCR_CampaignFeedbackComponent.CheckPlayerInsideRadioRange ( )

protected

◆ CheckSquadCohesionHint()

void SCR_CampaignFeedbackComponent.CheckSquadCohesionHint ( )

protected

◆ EOnInit()

override void SCR_CampaignFeedbackComponent.EOnInit ( IEntity owner )

◆ GetBaseWithPlayer()

SCR_CampaignMilitaryBaseComponent SCR_CampaignFeedbackComponent.GetBaseWithPlayer ( )

Returns

◆ GetInstance()

static SCR_CampaignFeedbackComponent SCR_CampaignFeedbackComponent.GetInstance ( )

static

Returns

◆ GetPlayerSpawnPos()

vector SCR_CampaignFeedbackComponent.GetPlayerSpawnPos ( )

Returns players position after spawning.

◆ GetSpawnTime()

TimeContainer SCR_CampaignFeedbackComponent.GetSpawnTime ( )

Returns

◆ GroupLeaderHint()

void SCR_CampaignFeedbackComponent.GroupLeaderHint ( )

protected

◆ IsConscious()

bool SCR_CampaignFeedbackComponent.IsConscious ( )

Returns

◆ IsLocalPlayerAlive()

bool SCR_CampaignFeedbackComponent.IsLocalPlayerAlive ( )

protected

◆ LoneDriverHint()

void SCR_CampaignFeedbackComponent.LoneDriverHint ( )

protected

◆ MobileAssemblyFeedback()

void SCR_CampaignFeedbackComponent.MobileAssemblyFeedback	(	SCR_EMobileAssemblyStatus	msgID,
		int	playerID,
		int	factionID )

Parameters

[in]	msgID
[in]	playerID
[in]	factionID

◆ NightHint()

void SCR_CampaignFeedbackComponent.NightHint ( )

protected

◆ OnArsenalOpen()

void SCR_CampaignFeedbackComponent.OnArsenalOpen ( )

protected

◆ OnBaseClickedShowSupplyLimit()

void SCR_CampaignFeedbackComponent.OnBaseClickedShowSupplyLimit ( bool selected )

protected

◆ OnBaseEntered()

void SCR_CampaignFeedbackComponent.OnBaseEntered ( notnull SCR_CampaignMilitaryBaseComponent base )

Parameters

[in] base

◆ OnBaseFactionChanged()

void SCR_CampaignFeedbackComponent.OnBaseFactionChanged	(	notnull SCR_MilitaryBaseComponent	base,
		Faction	faction )

Parameters

[in]	base
[in]	faction

◆ OnBaseHovered()

void SCR_CampaignFeedbackComponent.OnBaseHovered ( SCR_CampaignMilitaryBaseComponent base )

protected

◆ OnBaseLeft()

void SCR_CampaignFeedbackComponent.OnBaseLeft ( notnull SCR_CampaignMilitaryBaseComponent base )

Parameters

[in] base

◆ OnCheckEstablishmentArea()

void SCR_CampaignFeedbackComponent.OnCheckEstablishmentArea ( )

protected

◆ OnCommanderVolunteer()

void SCR_CampaignFeedbackComponent.OnCommanderVolunteer ( int playerId )

protected

◆ OnConsciousnessChanged()

void SCR_CampaignFeedbackComponent.OnConsciousnessChanged ( bool conscious )

Upon death, the unconscious state is no longer detectable, we need to cache it.

Parameters

[in] conscious

◆ OnEntryPerformed()

void SCR_CampaignFeedbackComponent.OnEntryPerformed ( SCR_SelectionMenuEntry entry )

◆ OnFactionCommanderChanged()

void SCR_CampaignFeedbackComponent.OnFactionCommanderChanged	(	SCR_Faction	faction,
		int	commanderPlayerId )

protected

◆ OnGroupMenuShow()

void SCR_CampaignFeedbackComponent.OnGroupMenuShow ( )

protected

◆ OnItemSlotHover()

void SCR_CampaignFeedbackComponent.OnItemSlotHover ( SCR_InventorySlotUI slot )

protected

◆ OnJournalOpened()

void SCR_CampaignFeedbackComponent.OnJournalOpened ( bool newVisibility )

protected

◆ OnMapClose()

void SCR_CampaignFeedbackComponent.OnMapClose ( MapConfiguration config )

◆ OnMapOpen()

void SCR_CampaignFeedbackComponent.OnMapOpen ( MapConfiguration config )

Parameters

[in] config

◆ OnMatchSituationChanged()

void SCR_CampaignFeedbackComponent.OnMatchSituationChanged ( )

protected

◆ OnOwnershipChanged()

void SCR_CampaignFeedbackComponent.OnOwnershipChanged	(	bool	changing,
		bool	becameOwner )

Parameters

[in]	changing
[in]	becameOwner

◆ OnPlayerJoinedGroup()

void SCR_CampaignFeedbackComponent.OnPlayerJoinedGroup	(	SCR_AIGroup	group,
		int	playerID )

protected

◆ OnPlayerKilled()

void SCR_CampaignFeedbackComponent.OnPlayerKilled ( notnull SCR_InstigatorContextData instigatorContextData )

Parameters

[in]	playerId
[in]	playerEntity
[in]	killerEntity
[in]	killer

◆ OnPlayerSuppliesInteraction()

void SCR_CampaignFeedbackComponent.OnPlayerSuppliesInteraction	(	EResourcePlayerInteractionType	interactionType,
		PlayerController	playerController,
		SCR_ResourceComponent	resourceComponentFrom,
		SCR_ResourceComponent	resourceComponentTo,
		EResourceType	resourceType,
		float	resourceValue )

Parameters

[in]	interactionType
[in]	playerController
[in]	resourceComponentFrom
[in]	resourceComponentTo
[in]	resourceType
[in]	resourceValue

◆ OnPostInit()

override void SCR_CampaignFeedbackComponent.OnPostInit ( IEntity owner )

◆ OnRadialMenuAvailable()

void SCR_CampaignFeedbackComponent.OnRadialMenuAvailable ( )

protected

◆ OnRadialMenuOpen()

void SCR_CampaignFeedbackComponent.OnRadialMenuOpen ( )

protected

◆ OnRespawn()

void SCR_CampaignFeedbackComponent.OnRespawn ( )

Hints are displayed with a delay after respawn so player has time to find their bearings.

◆ OnSeizingTimerChange()

void SCR_CampaignFeedbackComponent.OnSeizingTimerChange	(	WorldTimestamp	start,
		WorldTimestamp	end )

Parameters

[in]	start
[in]	end

◆ OnTaskAssigneeAdded()

void SCR_CampaignFeedbackComponent.OnTaskAssigneeAdded	(	SCR_Task	task,
		SCR_TaskExecutor	executor,
		int	requesterID )

protected

◆ OnTaskSelected()

void SCR_CampaignFeedbackComponent.OnTaskSelected ( SCR_Task task )

protected

◆ OnTaskStateChanged()

void SCR_CampaignFeedbackComponent.OnTaskStateChanged	(	SCR_Task	task,
		SCR_ETaskState	newState )

protected

◆ OnVehicleEnter()

void SCR_CampaignFeedbackComponent.OnVehicleEnter	(	ChimeraCharacter	playerCharacter,
		IEntity	compartmentEntit )

protected

Called when local player enters any vehicle compartment.

Parameters

[in]	playerCharacter	The player character entity
[in]	compartmentEntit	The compartment entity entered

◆ OnXPChanged()

void SCR_CampaignFeedbackComponent.OnXPChanged	(	int	totalXP,
		SCR_EXPRewards	rewardID,
		int	XP,
		bool	volunteer,
		bool	profileUsed,
		int	skillLevel )

protected

◆ PauseHintQueue()

void SCR_CampaignFeedbackComponent.PauseHintQueue ( )

◆ PlayRadioMsg()

void SCR_CampaignFeedbackComponent.PlayRadioMsg	(	SCR_ERadioMsg	msg,
		int	factionId,
		int	baseCallsign,
		int	callerCallsignCompany,
		int	callerCallsignPlatoon,
		int	callerCallsignSquad,
		int	callerCallsignCharacter,
		int	calledCallsignCompany,
		int	calledCallsignPlatoon,
		int	calledCallsignSquad,
		int	calledCallsignCharacter,
		int	param,
		float	seed,
		float	quality )

Parameters

[in]	msg
[in]	factionId
[in]	baseCallsign
[in]	callerCallsignCompany
[in]	callerCallsignPlatoon
[in]	callerCallsignSquad
[in]	callerCallsignCharacter
[in]	calledCallsignCompany
[in]	calledCallsignPlatoon
[in]	calledCallsignSquad
[in]	calledCallsignCharacter
[in]	param
[in]	seed
[in]	quality

◆ ProcessEvents()

void SCR_CampaignFeedbackComponent.ProcessEvents ( bool activate )

protected

◆ ProcessHintQueue()

void SCR_CampaignFeedbackComponent.ProcessHintQueue ( )

protected

◆ RefreshCurrentPopupMessage()

void SCR_CampaignFeedbackComponent.RefreshCurrentPopupMessage ( )

protected

◆ RegisterTasksShown()

void SCR_CampaignFeedbackComponent.RegisterTasksShown ( )

protected

◆ RegisterVehicleEnter()

void SCR_CampaignFeedbackComponent.RegisterVehicleEnter ( )

protected

◆ RegisterVehicleListener()

void SCR_CampaignFeedbackComponent.RegisterVehicleListener ( )

protected

Registers a callback for vehicle enter events for the local player.

◆ SetIsPlayerInRadioRange()

void SCR_CampaignFeedbackComponent.SetIsPlayerInRadioRange ( bool status )

Parameters

[in] status

◆ SetMapCampaignUI()

void SCR_CampaignFeedbackComponent.SetMapCampaignUI ( SCR_MapCampaignUI mapUi )

Parameters

[in] mapUi

◆ SetMapOpened()

void SCR_CampaignFeedbackComponent.SetMapOpened ( bool wasOpened )

Sets that map was already opened by player.

Parameters

[in] wasOpened

◆ SetSpawnTime()

void SCR_CampaignFeedbackComponent.SetSpawnTime ( )

◆ ShowHint()

void SCR_CampaignFeedbackComponent.ShowHint	(	EHint	hintID,
		bool	showImmediately = false,
		bool	showMultipleTimes = false )

Parameters

[in]	hintID
[in]	showImmediately
[in]	showMultipleTimes

◆ ShowVolunteerHint()

void SCR_CampaignFeedbackComponent.ShowVolunteerHint ( bool newVisibility )

protected

◆ TransportRequestHint()

void SCR_CampaignFeedbackComponent.TransportRequestHint ( )

protected

◆ TryRegisterInventoryHover()

void SCR_CampaignFeedbackComponent.TryRegisterInventoryHover ( )

protected

◆ UnregisterVehicleEnter()

void SCR_CampaignFeedbackComponent.UnregisterVehicleEnter ( )

protected

◆ UpdatePlayerSpawnHint()

void SCR_CampaignFeedbackComponent.UpdatePlayerSpawnHint	(	bool	show,
		vector	position = vector::Zero )

Serves for updating spawn hint on map witth he given position.

Parameters

[in]	enable
[in]	position

◆ WasMapOpened()

bool SCR_CampaignFeedbackComponent.WasMapOpened ( )

Returns: true if map was already opened, false otherwise

Member Data Documentation

◆ AFTER_RESPAWN_HINT_DELAY_MS

const int SCR_CampaignFeedbackComponent.AFTER_RESPAWN_HINT_DELAY_MS = 16500

staticprotected

◆ COHESION_HINT_DELAY_MS

const int SCR_CampaignFeedbackComponent.COHESION_HINT_DELAY_MS = 20000

staticprotected

◆ DELAY_BETWEEN_HINTS_MS

const int SCR_CampaignFeedbackComponent.DELAY_BETWEEN_HINTS_MS = 1000

staticprotected

◆ FEATURE_HINT_DELAY

const int SCR_CampaignFeedbackComponent.FEATURE_HINT_DELAY = 120000

staticprotected

◆ ICON_FLASH_DURATION

const float SCR_CampaignFeedbackComponent.ICON_FLASH_DURATION = 20

static

◆ ICON_FLASH_PERIOD

const float SCR_CampaignFeedbackComponent.ICON_FLASH_PERIOD = 0.5

static

◆ m_aHintQueue

ref array<int> SCR_CampaignFeedbackComponent.m_aHintQueue = {}

protected

◆ m_aShownHints

ref array<int> SCR_CampaignFeedbackComponent.m_aShownHints = {}

protected

◆ m_BaseWithPlayer

SCR_CampaignMilitaryBaseComponent SCR_CampaignFeedbackComponent.m_BaseWithPlayer

protected

◆ m_bCanShowSpawnPosition

bool SCR_CampaignFeedbackComponent.m_bCanShowSpawnPosition

protected

◆ m_bCohesionHintWasShown

bool SCR_CampaignFeedbackComponent.m_bCohesionHintWasShown

protected

◆ m_bIsConscious

bool SCR_CampaignFeedbackComponent.m_bIsConscious

protected

◆ m_bIsPlayerInRadioRange

bool SCR_CampaignFeedbackComponent.m_bIsPlayerInRadioRange = true

protected

◆ m_bWasMapOpened

bool SCR_CampaignFeedbackComponent.m_bWasMapOpened

protected

◆ m_bWasNight

bool SCR_CampaignFeedbackComponent.m_bWasNight

protected

◆ m_Campaign

SCR_GameModeCampaign SCR_CampaignFeedbackComponent.m_Campaign

protected

◆ m_fBaseWithPlayerCaptureEnd

WorldTimestamp SCR_CampaignFeedbackComponent.m_fBaseWithPlayerCaptureEnd

protected

◆ m_fBaseWithPlayerCaptureStart

WorldTimestamp SCR_CampaignFeedbackComponent.m_fBaseWithPlayerCaptureStart

protected

◆ m_fNextAllowedHintTimestamp

float SCR_CampaignFeedbackComponent.m_fNextAllowedHintTimestamp

protected

◆ m_HintsConfig

ref SCR_CampaignHintStorage SCR_CampaignFeedbackComponent.m_HintsConfig

protected

◆ m_iVehicleHintDelay

int SCR_CampaignFeedbackComponent.m_iVehicleHintDelay

protected

◆ m_MapCampaignUI

SCR_MapCampaignUI SCR_CampaignFeedbackComponent.m_MapCampaignUI

protected

◆ m_PlayedRadio

AudioHandle SCR_CampaignFeedbackComponent.m_PlayedRadio = AudioHandle.Invalid

protected

◆ m_PlayerController

SCR_PlayerController SCR_CampaignFeedbackComponent.m_PlayerController

protected

◆ m_sHintsConfig

ResourceName SCR_CampaignFeedbackComponent.m_sHintsConfig

protected

◆ m_SpawnTime

ref TimeContainer SCR_CampaignFeedbackComponent.m_SpawnTime

protected

◆ m_vFirstSpawnPosition

vector SCR_CampaignFeedbackComponent.m_vFirstSpawnPosition

protected

◆ NIGHT_HINT_DELAY_MS

const int SCR_CampaignFeedbackComponent.NIGHT_HINT_DELAY_MS = 10000

staticprotected

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

Game/Campaign/SCR_CampaignFeedbackComponent.c

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ ~SCR_CampaignFeedbackComponent()

Member Function Documentation

◆ BaseOutOfRangeHint()

◆ CanShowPlayerSpawn()

◆ CheckPlayerInsideRadioRange()

◆ CheckSquadCohesionHint()

◆ EOnInit()

◆ GetBaseWithPlayer()

◆ GetInstance()

◆ GetPlayerSpawnPos()

◆ GetSpawnTime()

◆ GroupLeaderHint()

◆ IsConscious()

◆ IsLocalPlayerAlive()

◆ LoneDriverHint()

◆ MobileAssemblyFeedback()

◆ NightHint()

◆ OnArsenalOpen()

◆ OnBaseClickedShowSupplyLimit()

◆ OnBaseEntered()

◆ OnBaseFactionChanged()

◆ OnBaseHovered()

◆ OnBaseLeft()

◆ OnCheckEstablishmentArea()

◆ OnCommanderVolunteer()

◆ OnConsciousnessChanged()

◆ OnEntryPerformed()

◆ OnFactionCommanderChanged()

◆ OnGroupMenuShow()

◆ OnItemSlotHover()

◆ OnJournalOpened()

◆ OnMapClose()

◆ OnMapOpen()

◆ OnMatchSituationChanged()

◆ OnOwnershipChanged()

◆ OnPlayerJoinedGroup()

◆ OnPlayerKilled()

◆ OnPlayerSuppliesInteraction()

◆ OnPostInit()

◆ OnRadialMenuAvailable()

◆ OnRadialMenuOpen()

◆ OnRespawn()

◆ OnSeizingTimerChange()

◆ OnTaskAssigneeAdded()

◆ OnTaskSelected()

◆ OnTaskStateChanged()

◆ OnVehicleEnter()

◆ OnXPChanged()

◆ PauseHintQueue()

◆ PlayRadioMsg()

◆ ProcessEvents()

◆ ProcessHintQueue()

◆ RefreshCurrentPopupMessage()

◆ RegisterTasksShown()

◆ RegisterVehicleEnter()

◆ RegisterVehicleListener()

◆ SetIsPlayerInRadioRange()

◆ SetMapCampaignUI()

◆ SetMapOpened()

◆ SetSpawnTime()

◆ ShowHint()

◆ ShowVolunteerHint()

◆ TransportRequestHint()

◆ TryRegisterInventoryHover()

◆ UnregisterVehicleEnter()

◆ UpdatePlayerSpawnHint()

◆ WasMapOpened()

Member Data Documentation

◆ AFTER_RESPAWN_HINT_DELAY_MS

◆ COHESION_HINT_DELAY_MS

◆ DELAY_BETWEEN_HINTS_MS

◆ FEATURE_HINT_DELAY

◆ ICON_FLASH_DURATION