Arma Reforger Script API
Loading...
Searching...
No Matches
Protected Member Functions | List of all members
SCR_CampaignSourceBaseComponent Interface Reference
Inheritance diagram for SCR_CampaignSourceBaseComponent:
SCR_CampaignMilitaryBaseComponent SCR_MilitaryBaseComponent

Protected Member Functions

override void HandleSpawnPointFaction ()
 Changes the faction which can spawn on spawn point groups owned by this base.
 
override int GetSuppliesIncomeAmount ()
 
override int GetSuppliesArrivalTimer ()
 
- Protected Member Functions inherited from SCR_CampaignMilitaryBaseComponent
void SupplyRequestExecutionPriorityReplicated ()
 
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 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 OnPlayerFactionChanged (SCR_PlayerFactionAffiliationComponent component, Faction previous, Faction current)
 
void OnRadiusChanged ()
 
void UpdateFlags ()
 
void ChangeFlags (notnull Faction faction)
 
bool GetIsLocalPlayerPresent ()
 
void NotifyPlayerInRadius (notnull Faction faction)
 

Additional Inherited Members

- Public Member Functions inherited from SCR_CampaignMilitaryBaseComponent
ScriptInvokerVoid GetOnSuppliesArrivalInvoker ()
 
OnSupplyLimitChangedInvoker GetOnSupplyLimitChanged ()
 
ScriptInvokerInt GetOnSupplyRequestExecutionPriorityChanged ()
 
ScriptInvokerFloat GetOnReservedSupplyAmountChanged ()
 
IEntity GetBaseBuildingComposition ()
 
void SetBaseBuildingComposition (IEntity building)
 
bool IsResupplyTaskCreationEnabled ()
 
bool IsResupplyNeeded ()
 
float GetScarcityLevel ()
 
float GetSupplyLimit ()
 
void SetSupplyLimit (float value)
 
float GetReservedSupplyAmount ()
 
void SetReservedSupplyAmount (float value)
 
float GetSuppliesArrivalTime ()
 
SCR_ESupplyRequestExecutionPriority GetSupplyRequestExecutionPriority ()
 
void SetSupplyRequestExecutionPriority (SCR_ESupplyRequestExecutionPriority priority)
 
SCR_ResourceConsumer GetResourceConsumer ()
 
string GetFormattedBaseNameWithCallsign (Faction faction)
 
bool IsValidTarget (notnull SCR_CampaignFaction faction)
 
void SetBuiltByPlayers (bool builtByPlayers)
 
bool GetBuiltByPlayers ()
 
void SetBuiltFaction (notnull Faction faction)
 
FactionKey GetBuiltFaction ()
 
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 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 RefreshSeizingTimers ()
 
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)
 
void CalculateSupplyRegenerationAmount (float currentSupplies, float maxSupplies, notnull SCR_CampaignFaction faction)
 Calculates the supply regeneration amount based on input parameters.
 
SCR_CampaignMilitaryBaseMapDescriptorComponent GetMapDescriptor ()
 
SCR_CampaignMapUIBase GetMapUI ()
 
bool GetIsEntityInMyRange (notnull IEntity entity)
 
float GetSupplies ()
 
float GetSuppliesMax ()
 
int GetSuppliesIncome ()
 
override void RegisterLogicComponent (notnull SCR_MilitaryBaseLogicComponent component)
 
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 SetSuppliesArrivalTime (float time)
 
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 ()
 
void OnAllBasesInitialized ()
 
void RecalculateRadioRange ()
 
void OnRadioRangeChanged ()
 
void SetBaseUI (SCR_CampaignMapUIBase base)
 Called from SCR_MapCampaignUI when base UI elements are initialized.
 
void SendHQMessageBaseCaptured ()
 
void SpawnBuilding (ResourceName prefab, vector position, vector rotation, bool isMainTent=false)
 
void EvaluateDefenders ()
 Periodically add XP to players defending their base.
 
void Update (float timeSlice)
 
override void EOnInit (IEntity owner)
 
override void OnPostInit (IEntity owner)
 
override void OnDelete (IEntity owner)
 
bool IsValidForSeizeTask ()
 Checks if this base is eligible for a Seize task.
 
- Public Member Functions inherited from SCR_MilitaryBaseComponent
ScriptInvoker GetOnMilitaryBaseRegistered ()
 
ScriptInvoker GetOnMilitaryBaseUnregistered ()
 
void AllowNotifications (bool allow)
 Show default notifications upon base capture (setter)
 
bool NotificationsAllowed ()
 Show default notifications upon base capture (getter)
 
void SetCallsignIndex (int index)
 
ScriptInvoker GetOnRadiusChanged ()
 
ScriptInvoker GetOnServiceRegistered ()
 
ScriptInvokerServiceUnregistered GetOnServiceUnregistered ()
 
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 RegisterServiceDelegate (notnull SCR_ServicePointDelegateComponent delegate)
 
void UnregisterServiceDelegate (notnull SCR_ServicePointDelegateComponent delegate)
 
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.
 
bool GetIsEntityPresent (notnull IEntity entity)
 
void ~SCR_MilitaryBaseComponent ()
 
- Static Public Member Functions inherited from SCR_CampaignMilitaryBaseComponent
static OnBaseStateChangedInvoker GetOnBaseUnderAttack ()
 
static OnBaseStateChangedInvoker GetOnFactionChangedExtended ()
 
static OnBaseAttackEndInvoker GetOnBaseAttackEnd ()
 
- Static Public Attributes inherited from SCR_CampaignMilitaryBaseComponent
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 const float SUPPLY_LIMIT_MIN = 0
 
static const float SUPPLY_LIMIT_MAX = 0.9
 
- Static Public Attributes inherited from SCR_MilitaryBaseComponent
static const int INVALID_BASE_CALLSIGN = -1
 
- Protected Attributes inherited from SCR_CampaignMilitaryBaseComponent
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
 
bool m_bIsResupplyTaskCreationEnabled
 
float m_fRespawnDelayAfterCaptureSeconds
 
int m_iRegularSuppliesIncomeBase
 
int m_iSuppliesArrivalInterval
 
float m_fSupplyLimit
 
float m_fReservedSupplyAmount
 
SCR_ESupplyRequestExecutionPriority m_eSupplyRequestExecutionPriority
 
ref map< int, WorldTimestamp > m_mDefendersData = new map<int, WorldTimestamp>()
 
ref OnSpawnPointAssignedInvoker m_OnSpawnPointAssigned
 
ref array< SCR_AmbientPatrolSpawnPointComponent > m_aRemnants = {}
 
ref array< IEntity > m_aStartingVehicles = {}
 
ref array< SCR_ERadioMsg > m_aServiceBuiltMsgQueue = {}
 
float m_fStartingSupplies
 
float m_fNextFrameCheck
 
float m_fTimer
 
float m_fRadioRangeDefault
 
WorldTimestamp m_fLastEnemyContactTimestamp
 
bool m_bLocalPlayerPresent
 
bool m_bWasHQSet
 
SCR_CampaignMilitaryBaseMapDescriptorComponent m_MapDescriptor
 
SCR_SpawnPoint m_SpawnPoint
 
SCR_CampaignFaction m_CapturingFaction
 
SCR_CampaignFaction m_OwningFactionPrevious
 
SCR_CoverageRadioComponent m_RadioComponent
 
SCR_CampaignMapUIBase m_UIElement
 
SCR_TimedWaypoint m_SeekDestroyWP
 
ref array< SCR_AIGroup > m_aDefendersGroups = {}
 
IEntity m_BaseBuildingComposition
 
ref OnSupplyLimitChangedInvoker m_OnSupplyLimitChanged
 
ref ScriptInvokerInt m_OnSupplyRequestExecutionPriorityChanged
 
ref ScriptInvokerFloat m_OnReservedSupplyAmountChanged
 
ref ScriptInvokerVoid m_SuppliesArrivalInvoker
 
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
 
float m_fSuppliesArrivalTime = float.MAX
 
bool m_bBuiltByPlayers
 
FactionKey m_sBuiltFaction
 
- 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_MilitaryBaseLogicComponent > m_aSystems = {}
 
ref array< SCR_ServicePointDelegateComponent > m_aServiceDelegates = {}
 
RplComponent m_RplComponent
 
SCR_FactionAffiliationComponent m_FactionComponent
 
FactionKey m_sCapturingFaction
 
int m_iCallsign = INVALID_BASE_CALLSIGN
 
ref ScriptInvoker< SCR_MilitaryBaseLogicComponent > m_OnMilitaryBaseRegistered
 
ref ScriptInvoker< SCR_MilitaryBaseLogicComponent > m_OnMilitaryBaseUnregistered
 
- Static Protected Attributes inherited from SCR_CampaignMilitaryBaseComponent
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 ref OnBaseStateChangedInvoker m_OnFactionChangedExtended
 
static ref OnBaseStateChangedInvoker m_OnBaseUnderAttack
 
static ref OnBaseAttackEndInvoker m_OnBaseAttackEnd
 

Member Function Documentation

◆ GetSuppliesArrivalTimer()

override int SCR_CampaignSourceBaseComponent.GetSuppliesArrivalTimer ( )
protected

Implements SCR_CampaignMilitaryBaseComponent.

◆ GetSuppliesIncomeAmount()

override int SCR_CampaignSourceBaseComponent.GetSuppliesIncomeAmount ( )
protected

Implements SCR_CampaignMilitaryBaseComponent.

◆ HandleSpawnPointFaction()

override void SCR_CampaignSourceBaseComponent.HandleSpawnPointFaction ( )
protected

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

Implements SCR_CampaignMilitaryBaseComponent.

The documentation for this interface was generated from the following file:
Generated by doxygen 1.13.2