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

Public Member Functions

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 int INVALID_BASE_CALLSIGN = -1
 

Protected Member Functions

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

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
 

Constructor & Destructor Documentation

◆ ~SCR_MilitaryBaseComponent()

void SCR_MilitaryBaseComponent.~SCR_MilitaryBaseComponent ( )

Member Function Documentation

◆ AllowNotifications()

void SCR_MilitaryBaseComponent.AllowNotifications ( bool  allow)

Show default notifications upon base capture (setter)

Parameters
[in]allow

◆ ChangeFlags()

void SCR_MilitaryBaseComponent.ChangeFlags ( notnull Faction  faction)
protected

◆ EOnInit()

override void SCR_MilitaryBaseComponent.EOnInit ( IEntity  owner)

Implemented in SCR_CampaignMilitaryBaseComponent.

◆ GetBuildingProviders()

int SCR_MilitaryBaseComponent.GetBuildingProviders ( out array< SCR_CampaignBuildingProviderComponent >  providers)

Get all registered systems inherited from SCR_CampaignBuildingProviderComponent.

◆ GetCallsign()

int SCR_MilitaryBaseComponent.GetCallsign ( )
Returns

◆ GetCallsignDisplayName()

LocalizedString SCR_MilitaryBaseComponent.GetCallsignDisplayName ( )
Returns

◆ GetCallsignDisplayNameOnly()

LocalizedString SCR_MilitaryBaseComponent.GetCallsignDisplayNameOnly ( )
Returns
callsign name only (eg. "Matros" instead of "Point Matros")

◆ GetCallsignDisplayNameOnlyUC()

LocalizedString SCR_MilitaryBaseComponent.GetCallsignDisplayNameOnlyUC ( )
Returns

◆ GetCallsignDisplayNameUpperCase()

LocalizedString SCR_MilitaryBaseComponent.GetCallsignDisplayNameUpperCase ( )
Returns

◆ GetCallsignSignal()

int SCR_MilitaryBaseComponent.GetCallsignSignal ( )
Returns

◆ GetCapturePoints()

int SCR_MilitaryBaseComponent.GetCapturePoints ( out array< SCR_SeizingComponent >  capturePoints)

Get all registered systems inherited from SCR_SeizingComponent.

Parameters
[out]capturePoints
Returns

◆ GetCapturingFaction()

Faction SCR_MilitaryBaseComponent.GetCapturingFaction ( )
Returns

◆ GetFaction()

Faction SCR_MilitaryBaseComponent.GetFaction ( bool  checkDefaultFaction = false)
Parameters
[in]checkDefaultFaction
Returns

◆ GetFlags()

int SCR_MilitaryBaseComponent.GetFlags ( out array< SCR_FlagComponent >  flags)

Get all registered systems inherited from SCR_FlagComponent.

Parameters
[out]flags
Returns

◆ GetIsEntityPresent()

bool SCR_MilitaryBaseComponent.GetIsEntityPresent ( notnull IEntity  entity)
Parameters
[in]entity
Returns

◆ GetIsLocalPlayerPresent()

bool SCR_MilitaryBaseComponent.GetIsLocalPlayerPresent ( )
protected

◆ GetOnRadiusChanged()

ScriptInvoker SCR_MilitaryBaseComponent.GetOnRadiusChanged ( )
Returns

◆ GetOnServiceRegistered()

ScriptInvoker SCR_MilitaryBaseComponent.GetOnServiceRegistered ( )
Returns

◆ GetOnServiceUnregistered()

ScriptInvokerServiceUnregistered SCR_MilitaryBaseComponent.GetOnServiceUnregistered ( )
Returns

◆ GetRadius()

int SCR_MilitaryBaseComponent.GetRadius ( )
Returns

◆ GetServiceByLabel()

SCR_ServicePointComponent SCR_MilitaryBaseComponent.GetServiceByLabel ( EEditableEntityLabel  label)
Parameters
[in]label
Returns

◆ GetServiceByType()

SCR_ServicePointComponent SCR_MilitaryBaseComponent.GetServiceByType ( SCR_EServicePointType  type)
Parameters
[in]type
Returns

◆ GetServiceDelegateByLabel()

SCR_ServicePointDelegateComponent SCR_MilitaryBaseComponent.GetServiceDelegateByLabel ( EEditableEntityLabel  label)
Parameters
[in]label
Returns

◆ GetServiceDelegateByType()

SCR_ServicePointDelegateComponent SCR_MilitaryBaseComponent.GetServiceDelegateByType ( SCR_EServicePointType  type)
Parameters
[in]type
Returns

◆ GetServiceDelegates()

int SCR_MilitaryBaseComponent.GetServiceDelegates ( out array< SCR_ServicePointDelegateComponent >  delegates = null)
Parameters
[out]delegates
Returns

◆ GetServiceDelegatesByType()

int SCR_MilitaryBaseComponent.GetServiceDelegatesByType ( out array< SCR_ServicePointDelegateComponent >  delegates,
SCR_EServicePointType  type 
)
Parameters
[out]delegates
[in]type
Returns

◆ GetServices()

int SCR_MilitaryBaseComponent.GetServices ( out array< SCR_ServicePointComponent >  services = null)

Get all registered systems inherited from SCR_ServicePointComponent.

Parameters
[out]services
Returns

◆ GetServicesByType()

int SCR_MilitaryBaseComponent.GetServicesByType ( out array< SCR_ServicePointComponent >  services,
SCR_EServicePointType  type 
)
Parameters
[out]services
[in]type
Returns

◆ IsProxy()

bool SCR_MilitaryBaseComponent.IsProxy ( )
protected

◆ NotificationsAllowed()

bool SCR_MilitaryBaseComponent.NotificationsAllowed ( )

Show default notifications upon base capture (getter)

Returns

◆ NotifyPlayerInRadius()

void SCR_MilitaryBaseComponent.NotifyPlayerInRadius ( notnull Faction  faction)
protected

◆ OnCallsignAssigned()

void SCR_MilitaryBaseComponent.OnCallsignAssigned ( )

Implemented in SCR_CampaignMilitaryBaseComponent.

◆ OnCapturingFactionChanged()

void SCR_MilitaryBaseComponent.OnCapturingFactionChanged ( )

Implemented in SCR_CampaignMilitaryBaseComponent.

◆ OnFactionChanged()

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

Implemented in SCR_CampaignMilitaryBaseComponent.

◆ OnPlayerFactionResponse_O()

void SCR_MilitaryBaseComponent.OnPlayerFactionResponse_O ( SCR_PlayerFactionAffiliationComponent  component,
int  factionIndex,
bool  response 
)
protected

◆ OnPointCaptured()

void SCR_MilitaryBaseComponent.OnPointCaptured ( notnull SCR_Faction  faction,
notnull SCR_SeizingComponent  point 
)

Triggered when a registered SCR_SeizingComponent gets captured.

Parameters
[in]faction
[in]point

◆ OnPointContested()

void SCR_MilitaryBaseComponent.OnPointContested ( notnull SCR_Faction  faction,
notnull SCR_SeizingComponent  point 
)

Triggered when a registered SCR_SeizingComponent starts getting captured.

Parameters
[in]faction
[in]point

◆ OnPointSecured()

void SCR_MilitaryBaseComponent.OnPointSecured ( notnull SCR_Faction  faction,
notnull SCR_SeizingComponent  point 
)

Triggered when a registered SCR_SeizingComponent stops getting captured.

Parameters
[in]faction
[in]point

◆ OnPostInit()

override void SCR_MilitaryBaseComponent.OnPostInit ( IEntity  owner)

Implemented in SCR_CampaignMilitaryBaseComponent.

◆ OnRadiusChanged()

void SCR_MilitaryBaseComponent.OnRadiusChanged ( )
protected

◆ OnRequiredPointsCaptured()

void SCR_MilitaryBaseComponent.OnRequiredPointsCaptured ( notnull SCR_Faction  faction)

Triggered when a the required amount of SCR_SeizingComponents to seize the base is captured.

Parameters
[in]faction

◆ OnServiceStateChanged()

void SCR_MilitaryBaseComponent.OnServiceStateChanged ( SCR_EServicePointStatus  state,
notnull SCR_ServicePointComponent  serviceComponent 
)

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

Parameters
[in]state
[in]serviceComponent

Implemented in SCR_CampaignMilitaryBaseComponent.

◆ RegisterLogicComponent()

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

Implemented in SCR_CampaignMilitaryBaseComponent.

◆ RegisterServiceDelegate()

void SCR_MilitaryBaseComponent.RegisterServiceDelegate ( notnull SCR_ServicePointDelegateComponent  delegate)
Parameters
[in]delegate

◆ SetCallsign()

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

Implemented in SCR_CampaignMilitaryBaseComponent.

◆ SetCallsignIndex()

void SCR_MilitaryBaseComponent.SetCallsignIndex ( int  index)
Parameters
[in]index

◆ SetCallsignIndexAutomatic()

void SCR_MilitaryBaseComponent.SetCallsignIndexAutomatic ( int  index)
Parameters
[in]index

Implemented in SCR_CampaignMilitaryBaseComponent.

◆ SetFaction() [1/2]

void SCR_MilitaryBaseComponent.SetFaction ( Faction  faction)
Parameters
[in]faction

◆ SetFaction() [2/2]

void SCR_MilitaryBaseComponent.SetFaction ( FactionKey  faction)
Parameters
[in]faction

◆ SetRadius()

void SCR_MilitaryBaseComponent.SetRadius ( int  radius)
Parameters
[in]radius

◆ UnregisterLogicComponent()

void SCR_MilitaryBaseComponent.UnregisterLogicComponent ( notnull SCR_MilitaryBaseLogicComponent  component)
Parameters
[in]component

◆ UnregisterServiceDelegate()

void SCR_MilitaryBaseComponent.UnregisterServiceDelegate ( notnull SCR_ServicePointDelegateComponent  delegate)
Parameters
[in]delegate

Member Data Documentation

◆ INVALID_BASE_CALLSIGN

const int SCR_MilitaryBaseComponent.INVALID_BASE_CALLSIGN = -1
static

◆ m_aServiceDelegates

ref array<SCR_ServicePointDelegateComponent> SCR_MilitaryBaseComponent.m_aServiceDelegates = {}
protected

◆ m_aSystems

ref array<SCR_MilitaryBaseLogicComponent> SCR_MilitaryBaseComponent.m_aSystems = {}
protected

◆ m_bSeizedByMajority

bool SCR_MilitaryBaseComponent.m_bSeizedByMajority
protected

◆ m_bShowMapIcon

bool SCR_MilitaryBaseComponent.m_bShowMapIcon
protected

◆ m_bShowNotifications

bool SCR_MilitaryBaseComponent.m_bShowNotifications
protected

◆ m_eCapturedByEnemiesNotification

ENotification SCR_MilitaryBaseComponent.m_eCapturedByEnemiesNotification
protected

◆ m_eCapturedByFriendliesNotification

ENotification SCR_MilitaryBaseComponent.m_eCapturedByFriendliesNotification
protected

◆ m_FactionComponent

SCR_FactionAffiliationComponent SCR_MilitaryBaseComponent.m_FactionComponent
protected

◆ m_iCallsign

int SCR_MilitaryBaseComponent.m_iCallsign = INVALID_BASE_CALLSIGN
protected

◆ m_iCallsignSignal

int SCR_MilitaryBaseComponent.m_iCallsignSignal = INVALID_BASE_CALLSIGN
protected

◆ m_iRadius

int SCR_MilitaryBaseComponent.m_iRadius
protected

◆ m_OnRadiusChanged

ref ScriptInvoker SCR_MilitaryBaseComponent.m_OnRadiusChanged
protected

◆ m_OnServiceRegistered

ref ScriptInvoker SCR_MilitaryBaseComponent.m_OnServiceRegistered
protected

◆ m_OnServiceUnregistered

ref ScriptInvokerServiceUnregistered SCR_MilitaryBaseComponent.m_OnServiceUnregistered
protected

◆ m_RplComponent

RplComponent SCR_MilitaryBaseComponent.m_RplComponent
protected

◆ m_sCallsign

string SCR_MilitaryBaseComponent.m_sCallsign
protected

◆ m_sCallsignNameOnly

string SCR_MilitaryBaseComponent.m_sCallsignNameOnly
protected

◆ m_sCallsignNameOnlyUC

string SCR_MilitaryBaseComponent.m_sCallsignNameOnlyUC
protected

◆ m_sCallsignUpper

string SCR_MilitaryBaseComponent.m_sCallsignUpper
protected

◆ m_sCapturingFaction

FactionKey SCR_MilitaryBaseComponent.m_sCapturingFaction
protected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.9.6