Classes
class	SCR_CampaignFeedbackComponentClass

Enumerations
enum	SCR_ECampaignPopupPriority { DEFAULT , SUPPLIES_HANDLED , TASK_AVAILABLE , RELAY_DETECTED , TASK_PROGRESS , TASK_DONE , BASE_LOST , MHQ , BASE_UNDER_ATTACK , RESPAWN , MATCH_END }
	Popup message priorities sorted from lowest to highest. More...

Functions
SCR_CampaignFeedbackComponentClass ScriptComponentClass	Attribute ("{3EE26F4747B6E99D}Configs/Hints/Conflict/ConflictHints.conf")
void	UpdatePlayerSpawnHint (bool show, vector position=vector.Zero)
void	SetMapCampaignUI (SCR_MapCampaignUI mapUi)
void	SetSpawnTime ()
TimeContainer	GetSpawnTime ()
bool	CanShowPlayerSpawn ()
vector	GetPlayerSpawnPos ()
	Returns players position after spawning.
bool	WasMapOpened ()
void	SetMapOpened (bool wasOpened)
SCR_CampaignMilitaryBaseComponent	GetBaseWithPlayer ()
void	CheckPlayerInsideRadioRange ()
void	RegisterTasksShown ()
void	SetIsPlayerInRadioRange (bool status)
void	GroupLeaderHint ()
void	LoneDriverHint ()
void	TransportRequestHint ()
void	BaseOutOfRangeHint (SCR_CampaignMilitaryBaseComponent base)
void	OnMapOpen (MapConfiguration config)
void	OnRadialMenuAvailable ()
void	OnEntryPerformed (SCR_SelectionMenuEntry entry)
void	OnMapClose (MapConfiguration config)
void	OnBaseHovered (SCR_CampaignMilitaryBaseComponent base)
void	OnCommanderVolunteer (int playerId)
void	OnFactionCommanderChanged (SCR_Faction faction, int commanderPlayerId)
void	OnBaseClickedShowSupplyLimit (bool selected)
SCR_EPopUpState	GetCurrentPopUpState ()
void	RefreshCurrentPopupMessage ()
SCR_EPopUpState	GetPopUpState ()
void	HandlePopUpState (SCR_EPopUpState state, notnull SCR_PopUpNotification popup, SCR_PopupMessage currentMsg)
void	SetPopup (SCR_PopUpNotification popup, SCR_PopupMessage currentMsg, string title, string subtitle, int priority, bool useProgressBar=false)
bool	IsPlayerCapturing ()
void	OnRespawn ()
	Hints are displayed with a delay after respawn so player has time to find their bearings.
void	OnCheckEstablishmentArea ()
void	OnTaskAssigneeAdded (SCR_Task task, SCR_TaskExecutor executor, int requesterID)
void	ShowHint (EHint hintID, bool showImmediately=false, bool showMultipleTimes=false)
void	ProcessHintQueue ()
void	PauseHintQueue ()
void	OnConsciousnessChanged (bool conscious)
	Will be called when the consciousness of the character changes.
bool	IsConscious ()
bool	IsLocalPlayerAlive ()
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	OnMatchSituationChanged ()
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	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)
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	OnOwnershipChanged (bool changing, bool becameOwner)
void	ShowVolunteerHint (bool newVisibility)
void	OnHintHide (SCR_HintUIInfo info, bool isSilent)
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)
	Editable Mine.
void	~SCR_CampaignFeedbackComponent ()

Variables
ref array< int >	m_aHintQueue = {}
bool	m_bIsPlayerInRadioRange = true
bool	m_bCanShowSpawnPosition
bool	m_bWasMapOpened
bool	m_bIsConscious
bool	m_bWasNight
bool	m_bCohesionHintWasShown
bool	m_bIsPlayerCapturing
float	m_fNextAllowedHintTimestamp
WorldTimestamp	m_fBaseWithPlayerCaptureStart
WorldTimestamp	m_fBaseWithPlayerCaptureEnd
enum SCR_ECampaignPopupPriority	NONE
enum SCR_ECampaignPopupPriority	CONTESTING = 997
enum SCR_ECampaignPopupPriority	SEIZING_YOU = 998

Enumeration Type Documentation

◆ SCR_ECampaignPopupPriority

enum SCR_ECampaignPopupPriority

protected

Popup message priorities sorted from lowest to highest.

Enumerator
DEFAULT
SUPPLIES_HANDLED
TASK_AVAILABLE
RELAY_DETECTED
TASK_PROGRESS
TASK_DONE
BASE_LOST
MHQ
BASE_UNDER_ATTACK
RESPAWN
MATCH_END

Definition at line 2373 of file SCR_CampaignFeedbackComponent.c.

Function Documentation

◆ Attribute()

SCR_CampaignFeedbackComponentClass ScriptComponentClass Attribute ( "{3EE26F4747B6E99D}Configs/Hints/Conflict/ConflictHints.conf" )

Definition at line 1 of file SCR_CampaignFeedbackComponent.c.

◆ BaseOutOfRangeHint()

void BaseOutOfRangeHint ( SCR_CampaignMilitaryBaseComponent base )

protected

Parameters

[in] base

Definition at line 335 of file SCR_CampaignFeedbackComponent.c.

◆ CanShowPlayerSpawn()

bool CanShowPlayerSpawn ( )

protected

Returns

Definition at line 131 of file SCR_CampaignFeedbackComponent.c.

◆ CheckPlayerInsideRadioRange()

void CheckPlayerInsideRadioRange ( )

protected

Definition at line 166 of file SCR_CampaignFeedbackComponent.c.

◆ CheckSquadCohesionHint()

void CheckSquadCohesionHint ( )

protected

Definition at line 2085 of file SCR_CampaignFeedbackComponent.c.

◆ GetBaseWithPlayer()

SCR_CampaignMilitaryBaseComponent GetBaseWithPlayer ( )

protected

Returns

Definition at line 160 of file SCR_CampaignFeedbackComponent.c.

◆ GetCurrentPopUpState()

SCR_EPopUpState GetCurrentPopUpState ( )

protected

Definition at line 519 of file SCR_CampaignFeedbackComponent.c.

◆ GetPlayerSpawnPos()

vector GetPlayerSpawnPos ( )

protected

Returns players position after spawning.

Definition at line 138 of file SCR_CampaignFeedbackComponent.c.

◆ GetPopUpState()

SCR_EPopUpState GetPopUpState ( )

protected

Definition at line 542 of file SCR_CampaignFeedbackComponent.c.

◆ GetSpawnTime()

TimeContainer GetSpawnTime ( )

protected

Returns

Definition at line 123 of file SCR_CampaignFeedbackComponent.c.

◆ GroupLeaderHint()

void GroupLeaderHint ( )

protected

Definition at line 217 of file SCR_CampaignFeedbackComponent.c.

◆ HandlePopUpState()

void HandlePopUpState	(	SCR_EPopUpState	state,
		notnull SCR_PopUpNotification	popup,
		SCR_PopupMessage	currentMsg )

protected

Definition at line 597 of file SCR_CampaignFeedbackComponent.c.

◆ IsConscious()

bool IsConscious ( )

protected

Returns

Definition at line 990 of file SCR_CampaignFeedbackComponent.c.

◆ IsLocalPlayerAlive()

bool IsLocalPlayerAlive ( )

protected

Definition at line 996 of file SCR_CampaignFeedbackComponent.c.

◆ IsPlayerCapturing()

bool IsPlayerCapturing ( )

protected

Definition at line 667 of file SCR_CampaignFeedbackComponent.c.

◆ LoneDriverHint()

void LoneDriverHint ( )

protected

Definition at line 239 of file SCR_CampaignFeedbackComponent.c.

◆ MobileAssemblyFeedback()

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

protected

Parameters

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

Definition at line 1191 of file SCR_CampaignFeedbackComponent.c.

◆ NightHint()

void NightHint ( )

protected

Definition at line 2030 of file SCR_CampaignFeedbackComponent.c.

◆ OnArsenalOpen()

void OnArsenalOpen ( )

protected

Definition at line 2053 of file SCR_CampaignFeedbackComponent.c.

◆ OnBaseClickedShowSupplyLimit()

void OnBaseClickedShowSupplyLimit ( bool selected )

protected

Definition at line 509 of file SCR_CampaignFeedbackComponent.c.

◆ OnBaseEntered()

void OnBaseEntered ( notnull SCR_CampaignMilitaryBaseComponent base )

protected

Parameters

[in] base

Definition at line 1064 of file SCR_CampaignFeedbackComponent.c.

◆ OnBaseFactionChanged()

void OnBaseFactionChanged	(	notnull SCR_MilitaryBaseComponent	base,
		Faction	faction )

protected

Parameters

[in]	base
[in]	faction

Definition at line 1029 of file SCR_CampaignFeedbackComponent.c.

◆ OnBaseHovered()

void OnBaseHovered ( SCR_CampaignMilitaryBaseComponent base )

protected

Definition at line 484 of file SCR_CampaignFeedbackComponent.c.

◆ OnBaseLeft()

void OnBaseLeft ( notnull SCR_CampaignMilitaryBaseComponent base )

protected

Parameters

[in] base

Definition at line 1153 of file SCR_CampaignFeedbackComponent.c.

◆ OnCheckEstablishmentArea()

void OnCheckEstablishmentArea ( )

protected

Definition at line 792 of file SCR_CampaignFeedbackComponent.c.

◆ OnCommanderVolunteer()

void OnCommanderVolunteer ( int playerId )

protected

Definition at line 491 of file SCR_CampaignFeedbackComponent.c.

◆ OnEntryPerformed()

void OnEntryPerformed ( SCR_SelectionMenuEntry entry )

protected

Definition at line 441 of file SCR_CampaignFeedbackComponent.c.

◆ OnFactionCommanderChanged()

void OnFactionCommanderChanged	(	SCR_Faction	faction,
		int	commanderPlayerId )

protected

Definition at line 498 of file SCR_CampaignFeedbackComponent.c.

◆ OnGroupMenuShow()

void OnGroupMenuShow ( )

protected

Definition at line 1854 of file SCR_CampaignFeedbackComponent.c.

◆ OnHintHide()

void OnHintHide	(	SCR_HintUIInfo	info,
		bool	isSilent )

protected

Definition at line 2295 of file SCR_CampaignFeedbackComponent.c.

◆ OnItemSlotHover()

void OnItemSlotHover ( SCR_InventorySlotUI slot )

protected

Definition at line 2059 of file SCR_CampaignFeedbackComponent.c.

◆ OnJournalOpened()

void OnJournalOpened ( bool newVisibility )

protected

Definition at line 2011 of file SCR_CampaignFeedbackComponent.c.

◆ OnMapClose()

void OnMapClose ( MapConfiguration config )

protected

Definition at line 459 of file SCR_CampaignFeedbackComponent.c.

◆ OnMapOpen()

void OnMapOpen ( MapConfiguration config )

protected

Parameters

[in] config

Definition at line 350 of file SCR_CampaignFeedbackComponent.c.

◆ OnMatchSituationChanged()

void OnMatchSituationChanged ( )

protected

Definition at line 1165 of file SCR_CampaignFeedbackComponent.c.

◆ OnPlayerJoinedGroup()

void OnPlayerJoinedGroup	(	SCR_AIGroup	group,
		int	playerID )

protected

Definition at line 1827 of file SCR_CampaignFeedbackComponent.c.

◆ OnPlayerKilled()

void OnPlayerKilled ( notnull SCR_InstigatorContextData instigatorContextData )

protected

Parameters

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

Called after a player gets killed.

Parameters

[in] instigatorContextData Holds the data of the victim and killer

Definition at line 1014 of file SCR_CampaignFeedbackComponent.c.

◆ OnPlayerSuppliesInteraction()

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

protected

Parameters

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

Definition at line 2307 of file SCR_CampaignFeedbackComponent.c.

◆ OnRadialMenuAvailable()

void OnRadialMenuAvailable ( )

protected

Definition at line 424 of file SCR_CampaignFeedbackComponent.c.

◆ OnRadialMenuOpen()

void OnRadialMenuOpen ( )

protected

Definition at line 1994 of file SCR_CampaignFeedbackComponent.c.

◆ OnRespawn()

void OnRespawn ( )

protected

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

Definition at line 698 of file SCR_CampaignFeedbackComponent.c.

◆ OnSeizingTimerChange()

void OnSeizingTimerChange	(	WorldTimestamp	start,
		WorldTimestamp	end )

protected

Parameters

[in]	start
[in]	end

Definition at line 1179 of file SCR_CampaignFeedbackComponent.c.

◆ OnTaskAssigneeAdded()

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

protected

Definition at line 799 of file SCR_CampaignFeedbackComponent.c.

◆ OnTaskSelected()

void OnTaskSelected ( SCR_Task task )

protected

Definition at line 1862 of file SCR_CampaignFeedbackComponent.c.

◆ OnTaskStateChanged()

void OnTaskStateChanged	(	SCR_Task	task,
		SCR_ETaskState	newState )

protected

Definition at line 1980 of file SCR_CampaignFeedbackComponent.c.

◆ OnVehicleEnter()

void 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

Definition at line 1910 of file SCR_CampaignFeedbackComponent.c.

◆ OnXPChanged()

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

protected

Definition at line 1807 of file SCR_CampaignFeedbackComponent.c.

◆ PauseHintQueue()

void PauseHintQueue ( )

protected

Definition at line 975 of file SCR_CampaignFeedbackComponent.c.

◆ PlayRadioMsg()

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 )

protected

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