Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_CampaignMilitaryBaseComponent Interface Reference
Inheritance diagram for SCR_CampaignMilitaryBaseComponent:
[legend]

Public Member Functions

bool IsControlPoint ()
 
bool CanBeHQ ()
 
bool DisableWhenUnusedAsHQ ()
 
WorldTimestamp GetRespawnTimestamp ()
 
void Initialize ()
 
void Disable ()
 
void OnInitialized ()
 
void ApplyHeaderSettings (notnull SCR_CampaignCustomBase settings)
 
override void OnServiceStateChanged (SCR_EServicePointStatus state, notnull SCR_ServicePointComponent serviceComponent)
 Called every time the status of the registered service has changed.
 
void OnServiceBuilt (notnull SCR_ServicePointComponent service)
 
void OnServiceRemoved (notnull SCR_MilitaryBaseLogicComponent service)
 
void OnServiceBuilt_AfterInit (SCR_ServicePointComponent service)
 
void OnDisabled ()
 
bool IsInitialized ()
 
void SetAsHQ (bool isHQ)
 
bool IsHQ ()
 
bool CostSuppliesToSpawn ()
 
OnSpawnPointAssignedInvoker GetOnSpawnPointAssigned ()
 
float GetRadioRange ()
 
bool CanReachByRadio (notnull IEntity entity)
 
SCR_ERadioCoverageStatus GetHQRadioCoverage (notnull SCR_CampaignFaction faction)
 
bool IsHQRadioTrafficPossible (notnull SCR_CampaignFaction faction, SCR_ERadioCoverageStatus direction=SCR_ERadioCoverageStatus.RECEIVE)
 
float GetBaseSpawnCostFactor ()
 
void RefreshTasks ()
 
void NotifyAboutEnemyAttack (notnull Faction attackingFaction)
 
void EndCapture ()
 Capturing has been terminated.
 
int GetReconfiguredByID ()
 
bool GetDisableWhenUnusedAsHQ ()
 
bool BeginCapture (SCR_CampaignFaction faction, int playerID=INVALID_PLAYER_INDEX)
 Capturing has begun.
 
SCR_SpawnPoint GetSpawnPoint ()
 
override void OnCapturingFactionChanged ()
 Event which is triggered when the capturing faction changes.
 
void FlashBaseIcon (float remainingTime=0, Faction faction=null, bool changeToDefault=false, bool infiniteTimer=false)
 
void OnHasSignalChanged ()
 
void OnSpawnPointFactionAssigned (FactionKey faction)
 
void ChangeRadioSettings (notnull SCR_Faction faction)
 
void RegisterRemnants (notnull SCR_AmbientPatrolSpawnPointComponent remnants)
 
ResourceName GetBuildingIconImageset ()
 
void SetDefendersGroup (SCR_AIGroup grp)
 
void RemoveGroup (SCR_AIGroup grp)
 
bool ContainsGroup (SCR_AIGroup grp)
 
override void SetCallsign (notnull SCR_Faction faction)
 
override void SetCallsignIndexAutomatic (int index)
 
SCR_CampaignMilitaryBaseMapDescriptorComponent GetMapDescriptor ()
 
SCR_CampaignMapUIBase GetMapUI ()
 
bool GetIsEntityInMyRange (notnull IEntity entity)
 
float GetSupplies ()
 
float GetSuppliesMax ()
 
int GetSuppliesIncome ()
 
void RegisterHQRadio (notnull IEntity radio)
 
override void RegisterLogicComponent (notnull SCR_MilitaryBaseLogicComponent component)
 
void SetRadioChatterSignal (SCR_Faction faction)
 
IEntity GetHQRadio ()
 
void HideMapLocationLabel ()
 
SCR_ResourceComponent GetResourceComponent ()
 return ResourceComponent of base
 
void AddSupplies (int suppliesCount, bool replicate=true)
 Add delivered supplies.
 
void SetSupplies (float suppliesCount)
 
void SetInitialSupplies (float suppliesCount)
 
void SetStartingSupplies (float suppliesCount)
 
void AlterSupplyIncomeTimer (float time)
 Change reinforcements timer.
 
void SetFaction (SCR_CampaignFaction faction)
 
SCR_CampaignFaction GetCampaignFaction ()
 Returns the owning faction.
 
SCR_ECampaignBaseType GetType ()
 Returns type of this base.
 
string GetBaseName ()
 Returns the name of this base.
 
string GetBaseNameUpperCase ()
 Returns the upper-case name of this base.
 
bool IsBeingCaptured ()
 Returns whether this base is being captured.
 
void SetAttackingFaction (int enemyFaction)
 
void OnAttackingFactionChanged ()
 
void OnRespawnCooldownChanged ()
 
void UpdateRespawnCooldown ()
 
override void OnCallsignAssigned ()
 
void OnAllBasesInitialized ()
 
void RecalculateRadioRange ()
 
void OnRadioRangeChanged ()
 
void SetBaseUI (SCR_CampaignMapUIBase base)
 Called from SCR_MapCampaignUI when base UI elements are initialized.
 
void SendHQMessageBaseCaptured ()
 
void LoadState (notnull SCR_CampaignBaseStruct baseStruct)
 
void SpawnBuilding (ResourceName prefab, vector position, vector rotation, bool isMainTent=false)
 
void EvaluateDefenders ()
 Periodically add XP to players defending their base.
 
void StoreState (out SCR_CampaignBaseStruct baseStruct)
 
void Update (float timeSlice)
 
override void EOnInit (IEntity owner)
 
override void OnPostInit (IEntity owner)
 
override void OnDelete (IEntity owner)
 
- Public Member Functions inherited from SCR_MilitaryBaseComponent
void AllowNotifications (bool allow)
 Show default notifications upon base capture (setter)
 
bool NotificationsAllowed ()
 Show default notifications upon base capture (getter)
 
void SetCallsignIndexAutomatic (int index)
 
void SetCallsignIndex (int index)
 
ScriptInvoker GetOnRadiusChanged ()
 
ScriptInvoker GetOnServiceRegistered ()
 
ScriptInvokerServiceUnregistered GetOnServiceUnregistered ()
 
void SetCallsign (notnull SCR_Faction faction)
 
int GetCallsign ()
 
int GetCallsignSignal ()
 
void OnCallsignAssigned ()
 
LocalizedString GetCallsignDisplayNameOnly ()
 
LocalizedString GetCallsignDisplayName ()
 
LocalizedString GetCallsignDisplayNameOnlyUC ()
 
LocalizedString GetCallsignDisplayNameUpperCase ()
 
int GetServices (out array< SCR_ServicePointComponent > services=null)
 Get all registered systems inherited from SCR_ServicePointComponent.
 
int GetServicesByType (out array< SCR_ServicePointComponent > services, SCR_EServicePointType type)
 
SCR_ServicePointComponent GetServiceByLabel (EEditableEntityLabel label)
 
SCR_ServicePointComponent GetServiceByType (SCR_EServicePointType type)
 
int GetServiceDelegates (out array< SCR_ServicePointDelegateComponent > delegates=null)
 
int GetServiceDelegatesByType (out array< SCR_ServicePointDelegateComponent > delegates, SCR_EServicePointType type)
 
SCR_ServicePointDelegateComponent GetServiceDelegateByLabel (EEditableEntityLabel label)
 
SCR_ServicePointDelegateComponent GetServiceDelegateByType (SCR_EServicePointType type)
 
int GetBuildingProviders (out array< SCR_CampaignBuildingProviderComponent > providers)
 Get all registered systems inherited from SCR_CampaignBuildingProviderComponent.
 
int GetCapturePoints (out array< SCR_SeizingComponent > capturePoints)
 Get all registered systems inherited from SCR_SeizingComponent.
 
int GetFlags (out array< SCR_FlagComponent > flags)
 Get all registered systems inherited from SCR_FlagComponent.
 
void SetRadius (int radius)
 
int GetRadius ()
 
void SetFaction (Faction faction)
 
void SetFaction (FactionKey faction)
 
Faction GetFaction (bool checkDefaultFaction=false)
 
Faction GetCapturingFaction ()
 
void OnServiceStateChanged (SCR_EServicePointStatus state, notnull SCR_ServicePointComponent serviceComponent)
 Called every time the status of the registered service has changed.
 
void RegisterServiceDelegate (notnull SCR_ServicePointDelegateComponent delegate)
 
void UnregisterServiceDelegate (notnull SCR_ServicePointDelegateComponent delegate)
 
void RegisterLogicComponent (notnull SCR_MilitaryBaseLogicComponent component)
 
void UnregisterLogicComponent (notnull SCR_MilitaryBaseLogicComponent component)
 
void OnPointCaptured (notnull SCR_Faction faction, notnull SCR_SeizingComponent point)
 Triggered when a registered SCR_SeizingComponent gets captured.
 
void OnPointContested (notnull SCR_Faction faction, notnull SCR_SeizingComponent point)
 Triggered when a registered SCR_SeizingComponent starts getting captured.
 
void OnPointSecured (notnull SCR_Faction faction, notnull SCR_SeizingComponent point)
 Triggered when a registered SCR_SeizingComponent stops getting captured.
 
void OnRequiredPointsCaptured (notnull SCR_Faction faction)
 Triggered when a the required amount of SCR_SeizingComponents to seize the base is captured.
 
void OnCapturingFactionChanged ()
 
bool GetIsEntityPresent (notnull IEntity entity)
 
override void EOnInit (IEntity owner)
 
override void OnPostInit (IEntity owner)
 
void ~SCR_MilitaryBaseComponent ()
 

Static Public Attributes

static const float RADIO_RECONFIGURATION_DURATION = 10.0
 
static const float BARRACKS_REDUCED_DEPLOY_COST = 0.5
 
static const int UNDER_ATTACK_WARNING_PERIOD = 60
 
static const int INVALID_PLAYER_INDEX = -1
 
static const int INVALID_FACTION_INDEX = -1
 
static const int RESPAWN_DELAY_AFTER_CAPTURE = 180000
 
static const int RELAY_BASE_RADIUS = 100
 
static const int SUPPLY_DEPOT_CAPACITY = 4500
 
static const int DEFENDERS_CHECK_PERIOD = 30000
 
static const int DEFENDERS_REWARD_PERIOD = 120000
 
static const int DEFENDERS_REWARD_MULTIPLIER = 3
 
- Static Public Attributes inherited from SCR_MilitaryBaseComponent
static const int INVALID_BASE_CALLSIGN = -1
 

Protected Member Functions

void SetProviderEntity (notnull SCR_ServicePointComponent service)
 
void SendHighestPriorityMessage (notnull SCR_CampaignFaction faction)
 
void OnHQSet ()
 
float GetRelayRadioRange (notnull BaseRadioComponent radio)
 
void OnLocalPlayerFactionAssigned (Faction assignedFaction)
 
void OnCaptureStart (SCR_Faction faction)
 
void HandleSpawnPointFaction ()
 Changes the faction which can spawn on spawn point groups owned by this base.
 
void OnSuppliesChanged ()
 
override void OnFactionChanged (FactionAffiliationComponent owner, Faction previousFaction, Faction faction)
 Event which is triggered when the owning faction changes.
 
void SupplyIncomeTimer (bool reset=false)
 Handles the timer for reinforcements arrival at this base.
 
void AddRegularSupplyPackage (notnull SCR_CampaignFaction faction)
 Reinforcements timer has finished, send in reinforcements.
 
void SpawnStartingVehicles ()
 
void DeleteStartingVehicles ()
 
void RemoveFortifications ()
 
void ConnectToCampaignBasesSystem ()
 
void DisconnectFromCampaignBasesSystem ()
 
- Protected Member Functions inherited from SCR_MilitaryBaseComponent
bool IsProxy ()
 
void OnPlayerFactionResponse_O (SCR_PlayerFactionAffiliationComponent component, int factionIndex, bool response)
 
void OnRadiusChanged ()
 
void OnFactionChanged (FactionAffiliationComponent owner, Faction previousFaction, Faction faction)
 
void ChangeFlags (notnull Faction faction)
 
bool GetIsLocalPlayerPresent ()
 
void NotifyPlayerInRadius (notnull Faction faction)
 

Protected Attributes

bool m_bIsControlPoint
 
bool m_bCanBeHQ
 
bool m_bDisableWhenUnusedAsHQ
 
bool m_bIsSupplyHub
 
string m_sBaseName
 
string m_sBaseNameUpper
 
string m_sMapLocationName
 
SCR_ECampaignBaseType m_eType
 
ref map< int, WorldTimestamp > m_mDefendersData = new map<int, WorldTimestamp>()
 
ref OnSpawnPointAssignedInvoker m_OnSpawnPointAssigned
 
ref array< SCR_AmbientPatrolSpawnPointComponentm_aRemnants = {}
 
ref array< IEntity > m_aStartingVehicles = {}
 
ref array< SCR_ERadioMsg > m_aServiceBuiltMsgQueue = {}
 
float m_fStartingSupplies
 
float m_fSuppliesArrivalTime = float.MAX
 
float m_fNextFrameCheck
 
float m_fTimer
 
float m_fRadioRangeDefault
 
WorldTimestamp m_fLastEnemyContactTimestamp
 
bool m_bLocalPlayerPresent
 
SCR_CampaignMilitaryBaseMapDescriptorComponent m_MapDescriptor
 
SCR_SpawnPoint m_SpawnPoint
 
SCR_CampaignFaction m_CapturingFaction
 
SCR_CampaignFaction m_OwningFactionPrevious
 
SCR_CoverageRadioComponent m_RadioComponent
 
IEntity m_HQRadio
 
IEntity m_HQTent
 
SCR_CampaignMapUIBase m_UIElement
 
SCR_TimedWaypoint m_SeekDestroyWP
 
ref array< SCR_AIGroupm_aDefendersGroups = {}
 
bool m_bIsHQ
 
bool m_bInitialized
 
int m_iSupplyRegenAmount
 
int m_iCapturingFaction = INVALID_FACTION_INDEX
 
int m_iReconfiguredBy = INVALID_PLAYER_INDEX
 
float m_fRadioRange
 
WorldTimestamp m_fRespawnAvailableSince
 
int m_iAttackingFaction = -1
 
- Protected Attributes inherited from SCR_MilitaryBaseComponent
int m_iRadius
 
bool m_bSeizedByMajority
 
bool m_bShowNotifications
 
bool m_bShowMapIcon
 
ENotification m_eCapturedByFriendliesNotification
 
ENotification m_eCapturedByEnemiesNotification
 
int m_iCallsignSignal = INVALID_BASE_CALLSIGN
 
string m_sCallsign
 
string m_sCallsignUpper
 
string m_sCallsignNameOnly
 
string m_sCallsignNameOnlyUC
 
ref ScriptInvoker m_OnRadiusChanged
 
ref ScriptInvoker m_OnServiceRegistered
 
ref ScriptInvokerServiceUnregistered m_OnServiceUnregistered
 
ref array< SCR_MilitaryBaseLogicComponentm_aSystems = {}
 
ref array< SCR_ServicePointDelegateComponentm_aServiceDelegates = {}
 
RplComponent m_RplComponent
 
SCR_FactionAffiliationComponent m_FactionComponent
 
FactionKey m_sCapturingFaction
 
int m_iCallsign = INVALID_BASE_CALLSIGN
 

Static Protected Attributes

static const int TICK_TIME = 1
 
static const int CONTESTED_RESPAWN_DELAY = 35
 
static const int BASES_IN_RANGE_RESUPPLY_THRESHOLD = 5
 
static const float HQ_VEHICLE_SPAWN_RADIUS = 40
 
static const float HQ_VEHICLE_QUERY_SPACE = 6
 
static const string RADIO_CHATTER_SIGNAL_NAME = "RadioChatter"
 
static const string ESTABLISH_ACTION_SIGNAL_NAME = "EstablishAction"
 

Member Function Documentation

◆ AddRegularSupplyPackage()

void SCR_CampaignMilitaryBaseComponent.AddRegularSupplyPackage ( notnull SCR_CampaignFaction  faction)
protected

Reinforcements timer has finished, send in reinforcements.

◆ AddSupplies()

void SCR_CampaignMilitaryBaseComponent.AddSupplies ( int  suppliesCount,
bool  replicate = true 
)

Add delivered supplies.

Parameters
[in]suppliesCount
[in]replicate

◆ AlterSupplyIncomeTimer()

void SCR_CampaignMilitaryBaseComponent.AlterSupplyIncomeTimer ( float  time)

Change reinforcements timer.

Parameters
timeThis number is added to the timer

◆ ApplyHeaderSettings()

void SCR_CampaignMilitaryBaseComponent.ApplyHeaderSettings ( notnull SCR_CampaignCustomBase  settings)
Parameters
[in]settings

◆ BeginCapture()

bool SCR_CampaignMilitaryBaseComponent.BeginCapture ( SCR_CampaignFaction  faction,
int  playerID = INVALID_PLAYER_INDEX 
)

Capturing has begun.

◆ CanBeHQ()

bool SCR_CampaignMilitaryBaseComponent.CanBeHQ ( )
Returns

◆ CanReachByRadio()

bool SCR_CampaignMilitaryBaseComponent.CanReachByRadio ( notnull IEntity  entity)

◆ ChangeRadioSettings()

void SCR_CampaignMilitaryBaseComponent.ChangeRadioSettings ( notnull SCR_Faction  faction)
Parameters
[in]faction

◆ ConnectToCampaignBasesSystem()

void SCR_CampaignMilitaryBaseComponent.ConnectToCampaignBasesSystem ( )
protected

◆ ContainsGroup()

bool SCR_CampaignMilitaryBaseComponent.ContainsGroup ( SCR_AIGroup  grp)
Returns

◆ CostSuppliesToSpawn()

bool SCR_CampaignMilitaryBaseComponent.CostSuppliesToSpawn ( )
Returns
If it cost supplies to spawn on this base

◆ DeleteStartingVehicles()

void SCR_CampaignMilitaryBaseComponent.DeleteStartingVehicles ( )
protected

◆ Disable()

void SCR_CampaignMilitaryBaseComponent.Disable ( )

◆ DisableWhenUnusedAsHQ()

bool SCR_CampaignMilitaryBaseComponent.DisableWhenUnusedAsHQ ( )
Returns

◆ DisconnectFromCampaignBasesSystem()

void SCR_CampaignMilitaryBaseComponent.DisconnectFromCampaignBasesSystem ( )
protected

◆ EndCapture()

void SCR_CampaignMilitaryBaseComponent.EndCapture ( )

Capturing has been terminated.

◆ EOnInit()

override void SCR_CampaignMilitaryBaseComponent.EOnInit ( IEntity  owner)

◆ EvaluateDefenders()

void SCR_CampaignMilitaryBaseComponent.EvaluateDefenders ( )

Periodically add XP to players defending their base.

◆ FlashBaseIcon()

void SCR_CampaignMilitaryBaseComponent.FlashBaseIcon ( float  remainingTime = 0,
Faction  faction = null,
bool  changeToDefault = false,
bool  infiniteTimer = false 
)

◆ GetBaseName()

string SCR_CampaignMilitaryBaseComponent.GetBaseName ( )

Returns the name of this base.

◆ GetBaseNameUpperCase()

string SCR_CampaignMilitaryBaseComponent.GetBaseNameUpperCase ( )

Returns the upper-case name of this base.

◆ GetBaseSpawnCostFactor()

float SCR_CampaignMilitaryBaseComponent.GetBaseSpawnCostFactor ( )
Returns

◆ GetBuildingIconImageset()

ResourceName SCR_CampaignMilitaryBaseComponent.GetBuildingIconImageset ( )
Returns

◆ GetCampaignFaction()

SCR_CampaignFaction SCR_CampaignMilitaryBaseComponent.GetCampaignFaction ( )

Returns the owning faction.

◆ GetDisableWhenUnusedAsHQ()

bool SCR_CampaignMilitaryBaseComponent.GetDisableWhenUnusedAsHQ ( )
Returns

◆ GetHQRadio()

IEntity SCR_CampaignMilitaryBaseComponent.GetHQRadio ( )
Returns

◆ GetHQRadioCoverage()

SCR_ERadioCoverageStatus SCR_CampaignMilitaryBaseComponent.GetHQRadioCoverage ( notnull SCR_CampaignFaction  faction)
Parameters
[in]faction
Returns

◆ GetIsEntityInMyRange()

bool SCR_CampaignMilitaryBaseComponent.GetIsEntityInMyRange ( notnull IEntity  entity)
Parameters
[in]entity
Returns

◆ GetMapDescriptor()

SCR_CampaignMilitaryBaseMapDescriptorComponent SCR_CampaignMilitaryBaseComponent.GetMapDescriptor ( )
Returns

◆ GetMapUI()

SCR_CampaignMapUIBase SCR_CampaignMilitaryBaseComponent.GetMapUI ( )
Returns

◆ GetOnSpawnPointAssigned()

OnSpawnPointAssignedInvoker SCR_CampaignMilitaryBaseComponent.GetOnSpawnPointAssigned ( )
Returns

◆ GetRadioRange()

float SCR_CampaignMilitaryBaseComponent.GetRadioRange ( )
Returns

◆ GetReconfiguredByID()

int SCR_CampaignMilitaryBaseComponent.GetReconfiguredByID ( )
Returns

◆ GetRelayRadioRange()

float SCR_CampaignMilitaryBaseComponent.GetRelayRadioRange ( notnull BaseRadioComponent  radio)
protected

◆ GetResourceComponent()

SCR_ResourceComponent SCR_CampaignMilitaryBaseComponent.GetResourceComponent ( )

return ResourceComponent of base

◆ GetRespawnTimestamp()

WorldTimestamp SCR_CampaignMilitaryBaseComponent.GetRespawnTimestamp ( )
Returns

◆ GetSpawnPoint()

SCR_SpawnPoint SCR_CampaignMilitaryBaseComponent.GetSpawnPoint ( )
Returns

◆ GetSupplies()

float SCR_CampaignMilitaryBaseComponent.GetSupplies ( )
Returns

◆ GetSuppliesIncome()

int SCR_CampaignMilitaryBaseComponent.GetSuppliesIncome ( )
Returns

◆ GetSuppliesMax()

float SCR_CampaignMilitaryBaseComponent.GetSuppliesMax ( )
Returns

◆ GetType()

SCR_ECampaignBaseType SCR_CampaignMilitaryBaseComponent.GetType ( )

Returns type of this base.

◆ HandleSpawnPointFaction()

void SCR_CampaignMilitaryBaseComponent.HandleSpawnPointFaction ( )
protected

Changes the faction which can spawn on spawn point groups owned by this base.

◆ HideMapLocationLabel()

void SCR_CampaignMilitaryBaseComponent.HideMapLocationLabel ( )

◆ Initialize()

void SCR_CampaignMilitaryBaseComponent.Initialize ( )

◆ IsBeingCaptured()

bool SCR_CampaignMilitaryBaseComponent.IsBeingCaptured ( )

Returns whether this base is being captured.

◆ IsControlPoint()

bool SCR_CampaignMilitaryBaseComponent.IsControlPoint ( )
Returns

◆ IsHQ()

bool SCR_CampaignMilitaryBaseComponent.IsHQ ( )
Returns

◆ IsHQRadioTrafficPossible()

bool SCR_CampaignMilitaryBaseComponent.IsHQRadioTrafficPossible ( notnull SCR_CampaignFaction  faction,
SCR_ERadioCoverageStatus  direction = SCR_ERadioCoverageStatus::RECEIVE 
)
Parameters
[in]faction
[in]direction
Returns

◆ IsInitialized()

bool SCR_CampaignMilitaryBaseComponent.IsInitialized ( )
Returns

◆ LoadState()

void SCR_CampaignMilitaryBaseComponent.LoadState ( notnull SCR_CampaignBaseStruct  baseStruct)
Parameters
[in]baseStruct

◆ NotifyAboutEnemyAttack()

void SCR_CampaignMilitaryBaseComponent.NotifyAboutEnemyAttack ( notnull Faction  attackingFaction)
Parameters
[in]attackingFaction

◆ OnAllBasesInitialized()

void SCR_CampaignMilitaryBaseComponent.OnAllBasesInitialized ( )

◆ OnAttackingFactionChanged()

void SCR_CampaignMilitaryBaseComponent.OnAttackingFactionChanged ( )

◆ OnCallsignAssigned()

override void SCR_CampaignMilitaryBaseComponent.OnCallsignAssigned ( )

◆ OnCaptureStart()

void SCR_CampaignMilitaryBaseComponent.OnCaptureStart ( SCR_Faction  faction)
protected

◆ OnCapturingFactionChanged()

override void SCR_CampaignMilitaryBaseComponent.OnCapturingFactionChanged ( )

Event which is triggered when the capturing faction changes.

Implements SCR_MilitaryBaseComponent.

◆ OnDelete()

override void SCR_CampaignMilitaryBaseComponent.OnDelete ( IEntity  owner)

◆ OnDisabled()

void SCR_CampaignMilitaryBaseComponent.OnDisabled ( )

◆ OnFactionChanged()

override void SCR_CampaignMilitaryBaseComponent.OnFactionChanged ( FactionAffiliationComponent  owner,
Faction  previousFaction,
Faction  faction 
)
protected

Event which is triggered when the owning faction changes.

Implements SCR_MilitaryBaseComponent.

◆ OnHasSignalChanged()

void SCR_CampaignMilitaryBaseComponent.OnHasSignalChanged ( )

◆ OnHQSet()

void SCR_CampaignMilitaryBaseComponent.OnHQSet ( )
protected

◆ OnInitialized()

void SCR_CampaignMilitaryBaseComponent.OnInitialized ( )

◆ OnLocalPlayerFactionAssigned()

void SCR_CampaignMilitaryBaseComponent.OnLocalPlayerFactionAssigned ( Faction  assignedFaction)
protected

◆ OnPostInit()

override void SCR_CampaignMilitaryBaseComponent.OnPostInit ( IEntity  owner)

◆ OnRadioRangeChanged()

void SCR_CampaignMilitaryBaseComponent.OnRadioRangeChanged ( )

◆ OnRespawnCooldownChanged()

void SCR_CampaignMilitaryBaseComponent.OnRespawnCooldownChanged ( )

◆ OnServiceBuilt()

void SCR_CampaignMilitaryBaseComponent.OnServiceBuilt ( notnull SCR_ServicePointComponent  service)
Parameters
[in]service

◆ OnServiceBuilt_AfterInit()

void SCR_CampaignMilitaryBaseComponent.OnServiceBuilt_AfterInit ( SCR_ServicePointComponent  service)
Parameters
[in]service

◆ OnServiceRemoved()

void SCR_CampaignMilitaryBaseComponent.OnServiceRemoved ( notnull SCR_MilitaryBaseLogicComponent  service)
Parameters
[in]service

◆ OnServiceStateChanged()

override void SCR_CampaignMilitaryBaseComponent.OnServiceStateChanged ( SCR_EServicePointStatus  state,
notnull SCR_ServicePointComponent  serviceComponent 
)

Called every time the status of the registered service has changed.

Parameters
[in]state
[in]serviceComponent

Implements SCR_MilitaryBaseComponent.

◆ OnSpawnPointFactionAssigned()

void SCR_CampaignMilitaryBaseComponent.OnSpawnPointFactionAssigned ( FactionKey  faction)
Parameters
[in]faction

◆ OnSuppliesChanged()

void SCR_CampaignMilitaryBaseComponent.OnSuppliesChanged ( )
protected

◆ RecalculateRadioRange()

void SCR_CampaignMilitaryBaseComponent.RecalculateRadioRange ( )

◆ RefreshTasks()

void SCR_CampaignMilitaryBaseComponent.RefreshTasks ( )

◆ RegisterHQRadio()

void SCR_CampaignMilitaryBaseComponent.RegisterHQRadio ( notnull IEntity  radio)
Parameters
[in]radio

◆ RegisterLogicComponent()

override void SCR_CampaignMilitaryBaseComponent.RegisterLogicComponent ( notnull SCR_MilitaryBaseLogicComponent  component)
Parameters
[in]component

Implements SCR_MilitaryBaseComponent.

◆ RegisterRemnants()

void SCR_CampaignMilitaryBaseComponent.RegisterRemnants ( notnull SCR_AmbientPatrolSpawnPointComponent  remnants)
Parameters
[in]remnants

◆ RemoveFortifications()

void SCR_CampaignMilitaryBaseComponent.RemoveFortifications ( )
protected

◆ RemoveGroup()

void SCR_CampaignMilitaryBaseComponent.RemoveGroup ( SCR_AIGroup  grp)
Returns

◆ SendHighestPriorityMessage()

void SCR_CampaignMilitaryBaseComponent.SendHighestPriorityMessage ( notnull SCR_CampaignFaction  faction)
protected

◆ SendHQMessageBaseCaptured()

void SCR_CampaignMilitaryBaseComponent.SendHQMessageBaseCaptured ( )

◆ SetAsHQ()

void SCR_CampaignMilitaryBaseComponent.SetAsHQ ( bool  isHQ)
Parameters
[in]isHQ

◆ SetAttackingFaction()

void SCR_CampaignMilitaryBaseComponent.SetAttackingFaction ( int  enemyFaction)
Parameters
[in]enemyFaction

◆ SetBaseUI()

void SCR_CampaignMilitaryBaseComponent.SetBaseUI ( SCR_CampaignMapUIBase  base)

Called from SCR_MapCampaignUI when base UI elements are initialized.

◆ SetCallsign()

override void SCR_CampaignMilitaryBaseComponent.SetCallsign ( notnull SCR_Faction  faction)
Parameters
[in]faction

Implements SCR_MilitaryBaseComponent.

◆ SetCallsignIndexAutomatic()

override void SCR_CampaignMilitaryBaseComponent.SetCallsignIndexAutomatic ( int  index)
Parameters
[in]index

Implements SCR_MilitaryBaseComponent.

◆ SetDefendersGroup()

void SCR_CampaignMilitaryBaseComponent.SetDefendersGroup ( SCR_AIGroup  grp)
Parameters
[in]grp

◆ SetFaction()

void SCR_CampaignMilitaryBaseComponent.SetFaction ( SCR_CampaignFaction  faction)
Parameters
[in]faction

◆ SetInitialSupplies()

void SCR_CampaignMilitaryBaseComponent.SetInitialSupplies ( float  suppliesCount)
Parameters
[in]suppliesCount

◆ SetProviderEntity()

void SCR_CampaignMilitaryBaseComponent.SetProviderEntity ( notnull SCR_ServicePointComponent  service)
protected

◆ SetRadioChatterSignal()

void SCR_CampaignMilitaryBaseComponent.SetRadioChatterSignal ( SCR_Faction  faction)
Parameters
[in]faction

◆ SetStartingSupplies()

void SCR_CampaignMilitaryBaseComponent.SetStartingSupplies ( float  suppliesCount)
Parameters
[in]suppliesCount

◆ SetSupplies()

void SCR_CampaignMilitaryBaseComponent.SetSupplies ( float  suppliesCount)
Parameters
[in]suppliesCount

◆ SpawnBuilding()

void SCR_CampaignMilitaryBaseComponent.SpawnBuilding ( ResourceName  prefab,
vector  position,
vector  rotation,
bool  isMainTent = false 
)
Parameters
[in]prefab
[in]position
[in]rotation
[in]isMainTent

◆ SpawnStartingVehicles()

void SCR_CampaignMilitaryBaseComponent.SpawnStartingVehicles ( )
protected

◆ StoreState()

void SCR_CampaignMilitaryBaseComponent.StoreState ( out SCR_CampaignBaseStruct  baseStruct)
Parameters
[out]baseStruct

◆ SupplyIncomeTimer()

void SCR_CampaignMilitaryBaseComponent.SupplyIncomeTimer ( bool  reset = false)
protected

Handles the timer for reinforcements arrival at this base.

Parameters
resetResets the current timer

◆ Update()

void SCR_CampaignMilitaryBaseComponent.Update ( float  timeSlice)
Parameters
[in]timeSlice

◆ UpdateRespawnCooldown()

void SCR_CampaignMilitaryBaseComponent.UpdateRespawnCooldown ( )

Member Data Documentation

◆ BARRACKS_REDUCED_DEPLOY_COST

const float SCR_CampaignMilitaryBaseComponent.BARRACKS_REDUCED_DEPLOY_COST = 0.5
static

◆ BASES_IN_RANGE_RESUPPLY_THRESHOLD

const int SCR_CampaignMilitaryBaseComponent.BASES_IN_RANGE_RESUPPLY_THRESHOLD = 5
staticprotected

◆ CONTESTED_RESPAWN_DELAY

const int SCR_CampaignMilitaryBaseComponent.CONTESTED_RESPAWN_DELAY = 35
staticprotected

◆ DEFENDERS_CHECK_PERIOD

const int SCR_CampaignMilitaryBaseComponent.DEFENDERS_CHECK_PERIOD = 30000
static

◆ DEFENDERS_REWARD_MULTIPLIER

const int SCR_CampaignMilitaryBaseComponent.DEFENDERS_REWARD_MULTIPLIER = 3
static

◆ DEFENDERS_REWARD_PERIOD

const int SCR_CampaignMilitaryBaseComponent.DEFENDERS_REWARD_PERIOD = 120000
static

◆ ESTABLISH_ACTION_SIGNAL_NAME

const string SCR_CampaignMilitaryBaseComponent.ESTABLISH_ACTION_SIGNAL_NAME = "EstablishAction"
staticprotected

◆ HQ_VEHICLE_QUERY_SPACE

const float SCR_CampaignMilitaryBaseComponent.HQ_VEHICLE_QUERY_SPACE = 6
staticprotected

◆ HQ_VEHICLE_SPAWN_RADIUS

const float SCR_CampaignMilitaryBaseComponent.HQ_VEHICLE_SPAWN_RADIUS = 40
staticprotected

◆ INVALID_FACTION_INDEX

const int SCR_CampaignMilitaryBaseComponent.INVALID_FACTION_INDEX = -1
static

◆ INVALID_PLAYER_INDEX

const int SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX = -1
static

◆ m_aDefendersGroups

ref array<SCR_AIGroup> SCR_CampaignMilitaryBaseComponent.m_aDefendersGroups = {}
protected

◆ m_aRemnants

ref array<SCR_AmbientPatrolSpawnPointComponent> SCR_CampaignMilitaryBaseComponent.m_aRemnants = {}
protected

◆ m_aServiceBuiltMsgQueue

ref array<SCR_ERadioMsg> SCR_CampaignMilitaryBaseComponent.m_aServiceBuiltMsgQueue = {}
protected

◆ m_aStartingVehicles

ref array<IEntity> SCR_CampaignMilitaryBaseComponent.m_aStartingVehicles = {}
protected

◆ m_bCanBeHQ

bool SCR_CampaignMilitaryBaseComponent.m_bCanBeHQ
protected

◆ m_bDisableWhenUnusedAsHQ

bool SCR_CampaignMilitaryBaseComponent.m_bDisableWhenUnusedAsHQ
protected

◆ m_bInitialized

bool SCR_CampaignMilitaryBaseComponent.m_bInitialized
protected

◆ m_bIsControlPoint

bool SCR_CampaignMilitaryBaseComponent.m_bIsControlPoint
protected

◆ m_bIsHQ

bool SCR_CampaignMilitaryBaseComponent.m_bIsHQ
protected

◆ m_bIsSupplyHub

bool SCR_CampaignMilitaryBaseComponent.m_bIsSupplyHub
protected

◆ m_bLocalPlayerPresent

bool SCR_CampaignMilitaryBaseComponent.m_bLocalPlayerPresent
protected

◆ m_CapturingFaction

SCR_CampaignFaction SCR_CampaignMilitaryBaseComponent.m_CapturingFaction
protected

◆ m_eType

SCR_ECampaignBaseType SCR_CampaignMilitaryBaseComponent.m_eType
protected

◆ m_fLastEnemyContactTimestamp

WorldTimestamp SCR_CampaignMilitaryBaseComponent.m_fLastEnemyContactTimestamp
protected

◆ m_fNextFrameCheck

float SCR_CampaignMilitaryBaseComponent.m_fNextFrameCheck
protected

◆ m_fRadioRange

float SCR_CampaignMilitaryBaseComponent.m_fRadioRange
protected

◆ m_fRadioRangeDefault

float SCR_CampaignMilitaryBaseComponent.m_fRadioRangeDefault
protected

◆ m_fRespawnAvailableSince

WorldTimestamp SCR_CampaignMilitaryBaseComponent.m_fRespawnAvailableSince
protected

◆ m_fStartingSupplies

float SCR_CampaignMilitaryBaseComponent.m_fStartingSupplies
protected

◆ m_fSuppliesArrivalTime

float SCR_CampaignMilitaryBaseComponent.m_fSuppliesArrivalTime = float.MAX
protected

◆ m_fTimer

float SCR_CampaignMilitaryBaseComponent.m_fTimer
protected

◆ m_HQRadio

IEntity SCR_CampaignMilitaryBaseComponent.m_HQRadio
protected

◆ m_HQTent

IEntity SCR_CampaignMilitaryBaseComponent.m_HQTent
protected

◆ m_iAttackingFaction

int SCR_CampaignMilitaryBaseComponent.m_iAttackingFaction = -1
protected

◆ m_iCapturingFaction

int SCR_CampaignMilitaryBaseComponent.m_iCapturingFaction = INVALID_FACTION_INDEX
protected

◆ m_iReconfiguredBy

int SCR_CampaignMilitaryBaseComponent.m_iReconfiguredBy = INVALID_PLAYER_INDEX
protected

◆ m_iSupplyRegenAmount

int SCR_CampaignMilitaryBaseComponent.m_iSupplyRegenAmount
protected

◆ m_MapDescriptor

SCR_CampaignMilitaryBaseMapDescriptorComponent SCR_CampaignMilitaryBaseComponent.m_MapDescriptor
protected

◆ m_mDefendersData

ref map<int, WorldTimestamp> SCR_CampaignMilitaryBaseComponent.m_mDefendersData = new map<int, WorldTimestamp>()
protected

◆ m_OnSpawnPointAssigned

ref OnSpawnPointAssignedInvoker SCR_CampaignMilitaryBaseComponent.m_OnSpawnPointAssigned
protected

◆ m_OwningFactionPrevious

SCR_CampaignFaction SCR_CampaignMilitaryBaseComponent.m_OwningFactionPrevious
protected

◆ m_RadioComponent

SCR_CoverageRadioComponent SCR_CampaignMilitaryBaseComponent.m_RadioComponent
protected

◆ m_sBaseName

string SCR_CampaignMilitaryBaseComponent.m_sBaseName
protected

◆ m_sBaseNameUpper

string SCR_CampaignMilitaryBaseComponent.m_sBaseNameUpper
protected

◆ m_SeekDestroyWP

SCR_TimedWaypoint SCR_CampaignMilitaryBaseComponent.m_SeekDestroyWP
protected

◆ m_sMapLocationName

string SCR_CampaignMilitaryBaseComponent.m_sMapLocationName
protected

◆ m_SpawnPoint

SCR_SpawnPoint SCR_CampaignMilitaryBaseComponent.m_SpawnPoint
protected

◆ m_UIElement

SCR_CampaignMapUIBase SCR_CampaignMilitaryBaseComponent.m_UIElement
protected

◆ RADIO_CHATTER_SIGNAL_NAME

const string SCR_CampaignMilitaryBaseComponent.RADIO_CHATTER_SIGNAL_NAME = "RadioChatter"
staticprotected

◆ RADIO_RECONFIGURATION_DURATION

const float SCR_CampaignMilitaryBaseComponent.RADIO_RECONFIGURATION_DURATION = 10.0
static

◆ RELAY_BASE_RADIUS

const int SCR_CampaignMilitaryBaseComponent.RELAY_BASE_RADIUS = 100
static

◆ RESPAWN_DELAY_AFTER_CAPTURE

const int SCR_CampaignMilitaryBaseComponent.RESPAWN_DELAY_AFTER_CAPTURE = 180000
static

◆ SUPPLY_DEPOT_CAPACITY

const int SCR_CampaignMilitaryBaseComponent.SUPPLY_DEPOT_CAPACITY = 4500
static

◆ TICK_TIME

const int SCR_CampaignMilitaryBaseComponent.TICK_TIME = 1
staticprotected

◆ UNDER_ATTACK_WARNING_PERIOD

const int SCR_CampaignMilitaryBaseComponent.UNDER_ATTACK_WARNING_PERIOD = 60
static

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