Arma Reforger Explorer  1.1.0.42
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
SCR_CampaignFeedbackComponent.c File Reference

Go to the source code of this file.

Data Structures

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 EnablePlayerSpawnHint (bool enable)
 
void SetMapCampaignUI (SCR_MapCampaignUI mapUi)
 
void SetSpawnTime ()
 
TimeContainer GetSpawnTime ()
 
bool CanShowPlayerSpawn ()
 
vector GetPlayerSpawnPos ()
 Returns players position after spawning. More...
 
bool WasMapOpened ()
 
void SetMapOpened (bool wasOpened)
 
SCR_CampaignMilitaryBaseComponent GetBaseWithPlayer ()
 
protected void CheckPlayerInsideRadioRange ()
 
protected void RegisterTasksShown ()
 
void SetIsPlayerInRadioRange (bool status)
 
protected void GroupLeaderHint ()
 
protected void LoneDriverHint ()
 
protected void TransportRequestHint ()
 
void BaseOutOfRangeHint (SCR_CampaignMilitaryBaseComponent base)
 
void OnMapOpen (MapConfiguration config)
 
protected void RefreshCurrentPopupMessage ()
 
void OnRespawn ()
 Hints are displayed with a delay after respawn so player has time to find their bearings. More...
 
void ShowHint (EHint hintID, bool showImmediately=false, bool showMultipleTimes=false)
 
protected void ProcessHintQueue ()
 
void PauseHintQueue ()
 
void OnConsciousnessChanged (bool conscious)
 Will be called when the consciousness of the character changes. More...
 
bool IsConscious ()
 
void OnPlayerKilled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator killer)
 
void OnBaseFactionChanged (notnull SCR_MilitaryBaseComponent base, Faction faction)
 
void OnBaseEntered (notnull SCR_CampaignMilitaryBaseComponent base)
 
void OnBaseLeft (notnull SCR_CampaignMilitaryBaseComponent base)
 
protected 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 calledCallsignCompany, int calledCallsignPlatoon, int calledCallsignSquad, int param, float seed, float quality)
 
protected void OnXPChanged (int totalXP, SCR_EXPRewards rewardID, int XP, bool volunteer, bool profileUsed, int skillLevel)
 
protected void ProcessEvents (bool activate)
 
void OnOwnershipChanged (bool changing, bool becameOwner)
 
protected void ShowVolunteerHint ()
 
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)
 Called on PostInit when all components are added. More...
 
void ~SCR_CampaignFeedbackComponent ()
 

Variables

protected ref array< intm_aHintQueue = {}
 
protected bool m_bIsPlayerInRadioRange = true
 
protected bool m_bCanShowSpawnPosition
 
protected bool m_bWasMapOpened
 
protected bool m_bIsConscious
 
protected float m_fNextAllowedHintTimestamp
 
protected WorldTimestamp m_fBaseWithPlayerCaptureStart
 
protected WorldTimestamp m_fBaseWithPlayerCaptureEnd
 
enum SCR_ECampaignPopupPriority NONE
 
enum SCR_ECampaignPopupPriority SEIZING_YOU = 998
 

Enumeration Type Documentation

◆ SCR_ECampaignPopupPriority

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 1419 of file SCR_CampaignFeedbackComponent.c.

Function Documentation

◆ Attribute()

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

Definition at line 7 of file SCR_CampaignFeedbackComponent.c.

◆ BaseOutOfRangeHint()

void BaseOutOfRangeHint ( SCR_CampaignMilitaryBaseComponent  base)
Parameters
[in]base

Definition at line 320 of file SCR_CampaignFeedbackComponent.c.

◆ CanShowPlayerSpawn()

bool CanShowPlayerSpawn ( )
Returns

Definition at line 116 of file SCR_CampaignFeedbackComponent.c.

◆ CheckPlayerInsideRadioRange()

protected void CheckPlayerInsideRadioRange ( )

Definition at line 151 of file SCR_CampaignFeedbackComponent.c.

◆ EnablePlayerSpawnHint()

void EnablePlayerSpawnHint ( bool  enable)

Serves for enabling spawn hint on map. Also saves player spawn position

Parameters
[in]enable

Definition at line 61 of file SCR_CampaignFeedbackComponent.c.

◆ GetBaseWithPlayer()

SCR_CampaignMilitaryBaseComponent GetBaseWithPlayer ( )
Returns

Definition at line 145 of file SCR_CampaignFeedbackComponent.c.

◆ GetPlayerSpawnPos()

vector GetPlayerSpawnPos ( )

Returns players position after spawning.

Definition at line 123 of file SCR_CampaignFeedbackComponent.c.

◆ GetSpawnTime()

TimeContainer GetSpawnTime ( )
Returns

Definition at line 108 of file SCR_CampaignFeedbackComponent.c.

◆ GroupLeaderHint()

protected void GroupLeaderHint ( )

Definition at line 202 of file SCR_CampaignFeedbackComponent.c.

◆ IsConscious()

bool IsConscious ( )
Returns

Definition at line 503 of file SCR_CampaignFeedbackComponent.c.

◆ LoneDriverHint()

protected void LoneDriverHint ( )

Definition at line 224 of file SCR_CampaignFeedbackComponent.c.

◆ MobileAssemblyFeedback()

void MobileAssemblyFeedback ( SCR_EMobileAssemblyStatus  msgID,
int  playerID,
int  factionID 
)
Parameters
[in]msgID
[in]playerID
[in]factionID

Definition at line 683 of file SCR_CampaignFeedbackComponent.c.

◆ OnBaseEntered()

void OnBaseEntered ( notnull SCR_CampaignMilitaryBaseComponent  base)
Parameters
[in]base

Definition at line 560 of file SCR_CampaignFeedbackComponent.c.

◆ OnBaseFactionChanged()

void OnBaseFactionChanged ( notnull SCR_MilitaryBaseComponent  base,
Faction  faction 
)
Parameters
[in]base
[in]faction

Definition at line 528 of file SCR_CampaignFeedbackComponent.c.

◆ OnBaseLeft()

void OnBaseLeft ( notnull SCR_CampaignMilitaryBaseComponent  base)
Parameters
[in]base

Definition at line 645 of file SCR_CampaignFeedbackComponent.c.

◆ OnMapOpen()

void OnMapOpen ( MapConfiguration  config)
Parameters
[in]config

Definition at line 335 of file SCR_CampaignFeedbackComponent.c.

◆ OnMatchSituationChanged()

protected void OnMatchSituationChanged ( )

Definition at line 657 of file SCR_CampaignFeedbackComponent.c.

◆ OnPlayerSuppliesInteraction()

void 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

Definition at line 1361 of file SCR_CampaignFeedbackComponent.c.

◆ OnRespawn()

void OnRespawn ( )

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

Definition at line 407 of file SCR_CampaignFeedbackComponent.c.

◆ OnSeizingTimerChange()

void OnSeizingTimerChange ( WorldTimestamp  start,
WorldTimestamp  end 
)
Parameters
[in]start
[in]end

Definition at line 671 of file SCR_CampaignFeedbackComponent.c.

◆ OnXPChanged()

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

Definition at line 1226 of file SCR_CampaignFeedbackComponent.c.

◆ PauseHintQueue()

void PauseHintQueue ( )

Definition at line 488 of file SCR_CampaignFeedbackComponent.c.

◆ PlayRadioMsg()

void PlayRadioMsg ( SCR_ERadioMsg  msg,
int  factionId,
int  baseCallsign,
int  callerCallsignCompany,
int  callerCallsignPlatoon,
int  callerCallsignSquad,
int  calledCallsignCompany,
int  calledCallsignPlatoon,
int  calledCallsignSquad,
int  param,
float  seed,
float  quality 
)
Parameters
[in]msg
[in]factionId
[in]baseCallsign
[in]callerCallsignCompany
[in]callerCallsignPlatoon
[in]callerCallsignSquad
[in]calledCallsignCompany
[in]calledCallsignPlatoon
[in]calledCallsignSquad
[in]param
[in]seed
[in]quality

Definition at line 756 of file SCR_CampaignFeedbackComponent.c.

◆ ProcessEvents()

protected void ProcessEvents ( bool  activate)

Definition at line 1244 of file SCR_CampaignFeedbackComponent.c.

◆ ProcessHintQueue()

protected void ProcessHintQueue ( )

Definition at line 475 of file SCR_CampaignFeedbackComponent.c.

◆ RefreshCurrentPopupMessage()

protected void RefreshCurrentPopupMessage ( )

Definition at line 345 of file SCR_CampaignFeedbackComponent.c.

◆ RegisterTasksShown()

protected void RegisterTasksShown ( )

Definition at line 188 of file SCR_CampaignFeedbackComponent.c.

◆ SetIsPlayerInRadioRange()

void SetIsPlayerInRadioRange ( bool  status)
Parameters
[in]status

Definition at line 196 of file SCR_CampaignFeedbackComponent.c.

◆ SetMapCampaignUI()

void SetMapCampaignUI ( SCR_MapCampaignUI  mapUi)
Parameters
[in]mapUi

Definition at line 89 of file SCR_CampaignFeedbackComponent.c.

◆ SetMapOpened()

void SetMapOpened ( bool  wasOpened)

Sets that map was already opened by player

Parameters
[in]wasOpened

Definition at line 138 of file SCR_CampaignFeedbackComponent.c.

◆ SetSpawnTime()

void SetSpawnTime ( )

Definition at line 95 of file SCR_CampaignFeedbackComponent.c.

◆ ShowHint()

void ShowHint ( EHint  hintID,
bool  showImmediately = false,
bool  showMultipleTimes = false 
)
Parameters
[in]hintID
[in]showImmediately
[in]showMultipleTimes

Definition at line 432 of file SCR_CampaignFeedbackComponent.c.

◆ ShowVolunteerHint()

protected void ShowVolunteerHint ( )

Definition at line 1343 of file SCR_CampaignFeedbackComponent.c.

◆ TransportRequestHint()

protected void TransportRequestHint ( )

Definition at line 255 of file SCR_CampaignFeedbackComponent.c.

◆ WasMapOpened()

bool WasMapOpened ( )
Returns
true if map was already opened, false otherwise

Definition at line 130 of file SCR_CampaignFeedbackComponent.c.

◆ ~SCR_CampaignFeedbackComponent()

void ~SCR_CampaignFeedbackComponent ( )

Definition at line 1412 of file SCR_CampaignFeedbackComponent.c.

Variable Documentation

◆ m_aHintQueue

protected ref array<int> m_aHintQueue = {}

Definition at line 27 of file SCR_CampaignFeedbackComponent.c.

◆ m_bCanShowSpawnPosition

protected bool m_bCanShowSpawnPosition

Definition at line 30 of file SCR_CampaignFeedbackComponent.c.

◆ m_bIsConscious

protected bool m_bIsConscious

Definition at line 32 of file SCR_CampaignFeedbackComponent.c.

◆ m_bIsPlayerInRadioRange

protected bool m_bIsPlayerInRadioRange = true

Definition at line 29 of file SCR_CampaignFeedbackComponent.c.

◆ m_bWasMapOpened

protected bool m_bWasMapOpened

Definition at line 31 of file SCR_CampaignFeedbackComponent.c.

◆ m_fBaseWithPlayerCaptureEnd

protected WorldTimestamp m_fBaseWithPlayerCaptureEnd

Definition at line 37 of file SCR_CampaignFeedbackComponent.c.

◆ m_fBaseWithPlayerCaptureStart

protected WorldTimestamp m_fBaseWithPlayerCaptureStart

Definition at line 36 of file SCR_CampaignFeedbackComponent.c.

◆ m_fNextAllowedHintTimestamp

protected float m_fNextAllowedHintTimestamp

Definition at line 34 of file SCR_CampaignFeedbackComponent.c.

◆ NONE

◆ SEIZING_YOU

enum SCR_ECampaignPopupPriority SEIZING_YOU = 998