Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_MilitaryBaseComponent.c File Reference

Go to the source code of this file.

Classes

class  SCR_MilitaryBaseComponentClass

Typedefs

typedef func ScriptInvokerServiceUnregisteredMethod
typedef ScriptInvokerBase< ScriptInvokerServiceUnregisteredMethod > ScriptInvokerServiceUnregistered

Functions

void ScriptInvokerServiceUnregisteredMethod (SCR_MilitaryBaseComponent militaryBaseComponent, SCR_ServicePointComponent serviceComponent)
SCR_MilitaryBaseComponentClass ScriptComponentClass Attribute ("100")
SCR_MilitaryBaseComponentClass ScriptComponentClass RplProp (onRplName:"OnRadiusChanged")
ScriptInvoker GetOnMilitaryBaseRegistered ()
ScriptInvoker GetOnMilitaryBaseUnregistered ()
bool IsProxy ()
void AllowNotifications (bool allow)
bool NotificationsAllowed ()
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 ()
void OnPlayerFactionChanged (SCR_PlayerFactionAffiliationComponent component, Faction previous, Faction current)
LocalizedString GetCallsignDisplayNameOnly ()
LocalizedString GetCallsignDisplayName ()
LocalizedString GetCallsignDisplayNameOnlyUC ()
LocalizedString GetCallsignDisplayNameUpperCase ()
int GetServices (out array< SCR_ServicePointComponent > services=null)
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)
int GetFlags (out array< SCR_FlagComponent > flags)
void SetRadius (int radius)
void OnRadiusChanged ()
int GetRadius ()
void SetFaction (Faction faction)
void SetFaction (FactionKey faction)
void OnFactionChanged (FactionAffiliationComponent owner, Faction previousFaction, Faction faction)
Faction GetFaction (bool checkDefaultFaction=false)
Faction GetCapturingFaction ()
void OnServiceStateChanged (SCR_EServicePointStatus state, notnull SCR_ServicePointComponent serviceComponent)
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)
void OnPointContested (notnull SCR_Faction faction, notnull SCR_SeizingComponent point)
void OnPointSecured (notnull SCR_Faction faction, notnull SCR_SeizingComponent point)
void OnRequiredPointsCaptured (notnull SCR_Faction faction)
void OnCapturingFactionChanged ()
void UpdateFlags ()
void ChangeFlags (notnull Faction faction)
bool GetIsLocalPlayerPresent ()
bool GetIsEntityPresent (notnull IEntity entity)
void NotifyPlayerInRadius (notnull Faction faction)
override void EOnInit (IEntity owner)
override void OnPostInit (IEntity owner)
 Editable Mine.
override void OnDelete (IEntity owner)

Variables

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

Typedef Documentation

◆ ScriptInvokerServiceUnregistered

typedef ScriptInvokerBase<ScriptInvokerServiceUnregisteredMethod> ScriptInvokerServiceUnregistered

Definition at line 3 of file SCR_MilitaryBaseComponent.c.

◆ ScriptInvokerServiceUnregisteredMethod

typedef func ScriptInvokerServiceUnregisteredMethod

Definition at line 2 of file SCR_MilitaryBaseComponent.c.

Function Documentation

◆ AllowNotifications()

void AllowNotifications ( bool allow)
protected

Show default notifications upon base capture (setter)

Parameters
[in]allow

Definition at line 93 of file SCR_MilitaryBaseComponent.c.

◆ Attribute()

SCR_MilitaryBaseComponentClass ScriptComponentClass Attribute ( "100" )

◆ ChangeFlags()

void ChangeFlags ( notnull Faction faction)
protected

Definition at line 808 of file SCR_MilitaryBaseComponent.c.

◆ GetBuildingProviders()

int GetBuildingProviders ( out array< SCR_CampaignBuildingProviderComponent > providers)
protected

Get all registered systems inherited from SCR_CampaignBuildingProviderComponent.

Definition at line 400 of file SCR_MilitaryBaseComponent.c.

◆ GetCallsign()

int GetCallsign ( )
protected
Returns

Definition at line 175 of file SCR_MilitaryBaseComponent.c.

◆ GetCallsignDisplayName()

LocalizedString GetCallsignDisplayName ( )
protected
Returns

Definition at line 228 of file SCR_MilitaryBaseComponent.c.

◆ GetCallsignDisplayNameOnly()

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

Definition at line 221 of file SCR_MilitaryBaseComponent.c.

◆ GetCallsignDisplayNameOnlyUC()

LocalizedString GetCallsignDisplayNameOnlyUC ( )
protected
Returns

Definition at line 235 of file SCR_MilitaryBaseComponent.c.

◆ GetCallsignDisplayNameUpperCase()

LocalizedString GetCallsignDisplayNameUpperCase ( )
protected
Returns

Definition at line 242 of file SCR_MilitaryBaseComponent.c.

◆ GetCallsignSignal()

int GetCallsignSignal ( )
protected
Returns

Definition at line 182 of file SCR_MilitaryBaseComponent.c.

◆ GetCapturePoints()

int GetCapturePoints ( out array< SCR_SeizingComponent > capturePoints)
protected

Get all registered systems inherited from SCR_SeizingComponent

Parameters
[out]capturePoints
Returns

Definition at line 427 of file SCR_MilitaryBaseComponent.c.

◆ GetCapturingFaction()

Faction GetCapturingFaction ( )
protected
Returns

Definition at line 578 of file SCR_MilitaryBaseComponent.c.

◆ GetFaction()

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

Definition at line 563 of file SCR_MilitaryBaseComponent.c.

◆ GetFlags()

int GetFlags ( out array< SCR_FlagComponent > flags)
protected

Get all registered systems inherited from SCR_FlagComponent

Parameters
[out]flags
Returns

Definition at line 451 of file SCR_MilitaryBaseComponent.c.

◆ GetIsEntityPresent()

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

Definition at line 838 of file SCR_MilitaryBaseComponent.c.

◆ GetIsLocalPlayerPresent()

bool GetIsLocalPlayerPresent ( )
protected

Definition at line 825 of file SCR_MilitaryBaseComponent.c.

◆ GetOnMilitaryBaseRegistered()

ScriptInvoker GetOnMilitaryBaseRegistered ( )
protected

Definition at line 67 of file SCR_MilitaryBaseComponent.c.

◆ GetOnMilitaryBaseUnregistered()

ScriptInvoker GetOnMilitaryBaseUnregistered ( )
protected

Definition at line 76 of file SCR_MilitaryBaseComponent.c.

◆ GetOnRadiusChanged()

ScriptInvoker GetOnRadiusChanged ( )
protected
Returns

Definition at line 126 of file SCR_MilitaryBaseComponent.c.

◆ GetOnServiceRegistered()

ScriptInvoker GetOnServiceRegistered ( )
protected
Returns

Definition at line 136 of file SCR_MilitaryBaseComponent.c.

◆ GetOnServiceUnregistered()

ScriptInvokerServiceUnregistered GetOnServiceUnregistered ( )
protected
Returns

Definition at line 146 of file SCR_MilitaryBaseComponent.c.

◆ GetRadius()

int GetRadius ( )
protected
Returns

Get radius of the area. To be overloaded by inherited classes.

Returns
Radius

Definition at line 502 of file SCR_MilitaryBaseComponent.c.

◆ GetServiceByLabel()

SCR_ServicePointComponent GetServiceByLabel ( EEditableEntityLabel label)
protected
Parameters
[in]label
Returns

Definition at line 298 of file SCR_MilitaryBaseComponent.c.

◆ GetServiceByType()

SCR_ServicePointComponent GetServiceByType ( SCR_EServicePointType type)
protected
Parameters
[in]type
Returns

Definition at line 314 of file SCR_MilitaryBaseComponent.c.

◆ GetServiceDelegateByLabel()

SCR_ServicePointDelegateComponent GetServiceDelegateByLabel ( EEditableEntityLabel label)
protected
Parameters
[in]label
Returns

Definition at line 373 of file SCR_MilitaryBaseComponent.c.

◆ GetServiceDelegateByType()

SCR_ServicePointDelegateComponent GetServiceDelegateByType ( SCR_EServicePointType type)
protected
Parameters
[in]type
Returns

Definition at line 387 of file SCR_MilitaryBaseComponent.c.

◆ GetServiceDelegates()

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

Definition at line 330 of file SCR_MilitaryBaseComponent.c.

◆ GetServiceDelegatesByType()

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

Definition at line 352 of file SCR_MilitaryBaseComponent.c.

◆ GetServices()

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

Get all registered systems inherited from SCR_ServicePointComponent

Parameters
[out]services
Returns

Definition at line 251 of file SCR_MilitaryBaseComponent.c.

◆ GetServicesByType()

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

Definition at line 275 of file SCR_MilitaryBaseComponent.c.

◆ NotificationsAllowed()

bool NotificationsAllowed ( )
protected

Show default notifications upon base capture (getter)

Returns

Definition at line 101 of file SCR_MilitaryBaseComponent.c.

◆ NotifyPlayerInRadius()

void NotifyPlayerInRadius ( notnull Faction faction)
protected

Definition at line 844 of file SCR_MilitaryBaseComponent.c.

◆ OnCallsignAssigned()

void OnCallsignAssigned ( )
protected

Definition at line 189 of file SCR_MilitaryBaseComponent.c.

◆ OnCapturingFactionChanged()

void OnCapturingFactionChanged ( )
protected

Definition at line 786 of file SCR_MilitaryBaseComponent.c.

◆ OnDelete()

override void OnDelete ( IEntity owner)
protected

Definition at line 905 of file SCR_MilitaryBaseComponent.c.

◆ OnFactionChanged()

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

Definition at line 534 of file SCR_MilitaryBaseComponent.c.

◆ OnPlayerFactionChanged()

void OnPlayerFactionChanged ( SCR_PlayerFactionAffiliationComponent component,
Faction previous,
Faction current )
protected

Definition at line 210 of file SCR_MilitaryBaseComponent.c.

◆ OnPointCaptured()

void OnPointCaptured ( notnull SCR_Faction faction,
notnull SCR_SeizingComponent point )
protected

Triggered when a registered SCR_SeizingComponent gets captured

Parameters
[in]faction
[in]point

Definition at line 702 of file SCR_MilitaryBaseComponent.c.

◆ OnPointContested()

void OnPointContested ( notnull SCR_Faction faction,
notnull SCR_SeizingComponent point )
protected

Triggered when a registered SCR_SeizingComponent starts getting captured

Parameters
[in]faction
[in]point

Definition at line 726 of file SCR_MilitaryBaseComponent.c.

◆ OnPointSecured()

void OnPointSecured ( notnull SCR_Faction faction,
notnull SCR_SeizingComponent point )
protected

Triggered when a registered SCR_SeizingComponent stops getting captured

Parameters
[in]faction
[in]point

Definition at line 753 of file SCR_MilitaryBaseComponent.c.

◆ OnRadiusChanged()

void OnRadiusChanged ( )
protected

Definition at line 494 of file SCR_MilitaryBaseComponent.c.

◆ OnRequiredPointsCaptured()

void OnRequiredPointsCaptured ( notnull SCR_Faction faction)
protected

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

Parameters
[in]faction

Definition at line 779 of file SCR_MilitaryBaseComponent.c.

◆ OnServiceStateChanged()

void OnServiceStateChanged ( SCR_EServicePointStatus state,
notnull SCR_ServicePointComponent serviceComponent )
protected

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

Parameters
[in]state
[in]serviceComponent

Definition at line 593 of file SCR_MilitaryBaseComponent.c.

◆ RegisterLogicComponent()

void RegisterLogicComponent ( notnull SCR_MilitaryBaseLogicComponent component)
protected
Parameters
[in]component

Definition at line 617 of file SCR_MilitaryBaseComponent.c.

◆ RegisterServiceDelegate()

void RegisterServiceDelegate ( notnull SCR_ServicePointDelegateComponent delegate)
protected
Parameters
[in]delegate

Definition at line 601 of file SCR_MilitaryBaseComponent.c.

◆ RplProp()

SCR_MilitaryBaseComponentClass ScriptComponentClass RplProp ( onRplName:"OnRadiusChanged" )

Definition at line 20 of file SCR_MilitaryBaseComponent.c.

◆ ScriptInvokerServiceUnregisteredMethod()

void ScriptInvokerServiceUnregisteredMethod ( SCR_MilitaryBaseComponent militaryBaseComponent,
SCR_ServicePointComponent serviceComponent )

◆ SetCallsign()

void SetCallsign ( notnull SCR_Faction faction)
protected
Parameters
[in]faction

Definition at line 156 of file SCR_MilitaryBaseComponent.c.

◆ SetCallsignIndex()

void SetCallsignIndex ( int index)
protected
Parameters
[in]index

Definition at line 117 of file SCR_MilitaryBaseComponent.c.

◆ SetCallsignIndexAutomatic()

void SetCallsignIndexAutomatic ( int index)
protected
Parameters
[in]index

Definition at line 108 of file SCR_MilitaryBaseComponent.c.

◆ SetFaction() [1/2]

void SetFaction ( Faction faction)
protected
Parameters
[in]faction

Definition at line 509 of file SCR_MilitaryBaseComponent.c.

◆ SetFaction() [2/2]

void SetFaction ( FactionKey faction)
protected
Parameters
[in]faction

Definition at line 522 of file SCR_MilitaryBaseComponent.c.

◆ SetRadius()

void SetRadius ( int radius)
protected
Parameters
[in]radius

Definition at line 473 of file SCR_MilitaryBaseComponent.c.

◆ UnregisterLogicComponent()

void UnregisterLogicComponent ( notnull SCR_MilitaryBaseLogicComponent component)
protected
Parameters
[in]component

Definition at line 661 of file SCR_MilitaryBaseComponent.c.

◆ UnregisterServiceDelegate()

void UnregisterServiceDelegate ( notnull SCR_ServicePointDelegateComponent delegate)
protected
Parameters
[in]delegate

Definition at line 609 of file SCR_MilitaryBaseComponent.c.

◆ UpdateFlags()

void UpdateFlags ( )
protected

Definition at line 798 of file SCR_MilitaryBaseComponent.c.

Variable Documentation

◆ m_aServiceDelegates

ref array<SCR_ServicePointDelegateComponent> m_aServiceDelegates = {}
protected

Definition at line 52 of file SCR_MilitaryBaseComponent.c.

◆ m_FactionComponent

SCR_FactionAffiliationComponent m_FactionComponent
protected

Definition at line 55 of file SCR_MilitaryBaseComponent.c.

◆ m_iCallsign

int m_iCallsign = INVALID_BASE_CALLSIGN
protected

Definition at line 61 of file SCR_MilitaryBaseComponent.c.

◆ m_OnMilitaryBaseRegistered

ref ScriptInvoker<SCR_MilitaryBaseLogicComponent> m_OnMilitaryBaseRegistered
protected

Definition at line 63 of file SCR_MilitaryBaseComponent.c.

◆ m_OnMilitaryBaseUnregistered

ref ScriptInvoker<SCR_MilitaryBaseLogicComponent> m_OnMilitaryBaseUnregistered
protected

Definition at line 64 of file SCR_MilitaryBaseComponent.c.

◆ m_RplComponent

RplComponent m_RplComponent
protected

Definition at line 54 of file SCR_MilitaryBaseComponent.c.

◆ m_sCapturingFaction

FactionKey m_sCapturingFaction
protected

Definition at line 58 of file SCR_MilitaryBaseComponent.c.