SCR_MilitaryBaseComponent.c File Reference

Go to the source code of this file.

Data Structures
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")
protected 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 ()
protected void	OnPlayerFactionResponse_O (SCR_PlayerFactionAffiliationComponent component, int factionIndex, bool response)
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. More...
int	GetCapturePoints (out array< SCR_SeizingComponent > capturePoints)
int	GetFlags (out array< SCR_FlagComponent > flags)
void	SetRadius (int radius)
protected void	OnRadiusChanged ()
int	GetRadius ()
void	SetFaction (Faction faction)
void	SetFaction (FactionKey faction)
protected void	OnFactionChanged (FactionAffiliationComponent owner, Faction previousFaction, Faction faction)
	Event which is triggered when the owning faction changes. More...
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 ()
protected void	ChangeFlags (notnull Faction faction)
protected bool	GetIsLocalPlayerPresent ()
bool	GetIsEntityPresent (notnull IEntity entity)
protected void	NotifyPlayerInRadius (notnull Faction faction)
override void	EOnInit (IEntity owner)
override void	OnPostInit (IEntity owner)
	Called on PostInit when all components are added. More...
void	~SCR_MilitaryBaseComponent ()

Variables
protected ref array< SCR_ServicePointDelegateComponent >	m_aServiceDelegates = {}
protected RplComponent	m_RplComponent
protected SCR_FactionAffiliationComponent	m_FactionComponent
protected FactionKey	m_sCapturingFaction
protected int	m_iCallsign = INVALID_BASE_CALLSIGN

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

)

Show default notifications upon base capture (setter)

Parameters

[in]

allow

Definition at line 63 of file SCR_MilitaryBaseComponent.c.

Attribute()

SCR_MilitaryBaseComponentClass ScriptComponentClass Attribute

(

"100"

)

ChangeFlags()

protected void ChangeFlags

(

notnull Faction

faction

)

Definition at line 758 of file SCR_MilitaryBaseComponent.c.

GetBuildingProviders()

int GetBuildingProviders

(

out array< SCR_CampaignBuildingProviderComponent >

providers

)

Get all registered systems inherited from SCR_CampaignBuildingProviderComponent.

Definition at line 377 of file SCR_MilitaryBaseComponent.c.

GetCallsign()

int GetCallsign

(

)

Returns

Definition at line 140 of file SCR_MilitaryBaseComponent.c.

GetCallsignDisplayName()

LocalizedString GetCallsignDisplayName

(

)

Returns

Definition at line 205 of file SCR_MilitaryBaseComponent.c.

GetCallsignDisplayNameOnly()

LocalizedString GetCallsignDisplayNameOnly

(

)

Returns

callsign name only (eg. "Matros" instead of "Point Matros")

Definition at line 198 of file SCR_MilitaryBaseComponent.c.

GetCallsignDisplayNameOnlyUC()

LocalizedString GetCallsignDisplayNameOnlyUC

(

)

Returns

Definition at line 212 of file SCR_MilitaryBaseComponent.c.

GetCallsignDisplayNameUpperCase()

LocalizedString GetCallsignDisplayNameUpperCase

(

)

Returns

Definition at line 219 of file SCR_MilitaryBaseComponent.c.

GetCallsignSignal()

int GetCallsignSignal

(

)

Returns

Definition at line 147 of file SCR_MilitaryBaseComponent.c.

GetCapturePoints()

int GetCapturePoints

(

out array< SCR_SeizingComponent >

capturePoints

)

Get all registered systems inherited from SCR_SeizingComponent

Parameters

[out]

capturePoints

Returns

Definition at line 404 of file SCR_MilitaryBaseComponent.c.

GetCapturingFaction()

Faction GetCapturingFaction

(

)

Returns

Definition at line 556 of file SCR_MilitaryBaseComponent.c.

GetFaction()

Faction GetFaction

(

bool

checkDefaultFaction = false

)

Parameters

[in]

checkDefaultFaction

Returns

Definition at line 541 of file SCR_MilitaryBaseComponent.c.

GetFlags()

int GetFlags

(

out array< SCR_FlagComponent >

flags

)

Get all registered systems inherited from SCR_FlagComponent

Parameters

[out]

flags

Returns

Definition at line 428 of file SCR_MilitaryBaseComponent.c.

GetIsEntityPresent()

bool GetIsEntityPresent

(

notnull IEntity

entity

)

Parameters

[in]

entity

Returns

Definition at line 788 of file SCR_MilitaryBaseComponent.c.

GetIsLocalPlayerPresent()

protected bool GetIsLocalPlayerPresent

(

)

Definition at line 775 of file SCR_MilitaryBaseComponent.c.

GetOnRadiusChanged()

ScriptInvoker GetOnRadiusChanged

(

)

Returns

Definition at line 92 of file SCR_MilitaryBaseComponent.c.

GetOnServiceRegistered()

ScriptInvoker GetOnServiceRegistered

(

)

Returns

Definition at line 102 of file SCR_MilitaryBaseComponent.c.

GetOnServiceUnregistered()

ScriptInvokerServiceUnregistered GetOnServiceUnregistered

(

)

Returns

Definition at line 112 of file SCR_MilitaryBaseComponent.c.

GetRadius()

int GetRadius

(

)

Returns

Definition at line 479 of file SCR_MilitaryBaseComponent.c.

GetServiceByLabel()

SCR_ServicePointComponent GetServiceByLabel

(

EEditableEntityLabel

label

)

Parameters

[in]

label

Returns

Definition at line 275 of file SCR_MilitaryBaseComponent.c.

GetServiceByType()

SCR_ServicePointComponent GetServiceByType

(

SCR_EServicePointType

type

)

Parameters

[in]

type

Returns

Definition at line 291 of file SCR_MilitaryBaseComponent.c.

GetServiceDelegateByLabel()

SCR_ServicePointDelegateComponent GetServiceDelegateByLabel

(

EEditableEntityLabel

label

)

Parameters

[in]

label

Returns

Definition at line 350 of file SCR_MilitaryBaseComponent.c.

GetServiceDelegateByType()

SCR_ServicePointDelegateComponent GetServiceDelegateByType

(

SCR_EServicePointType

type

)

Parameters

[in]

type

Returns

Definition at line 364 of file SCR_MilitaryBaseComponent.c.

GetServiceDelegates()

int GetServiceDelegates

(

out array< SCR_ServicePointDelegateComponent >

delegates = null

)

Parameters

[out]

delegates

Returns

Definition at line 307 of file SCR_MilitaryBaseComponent.c.

GetServiceDelegatesByType()

int GetServiceDelegatesByType	(	out array< SCR_ServicePointDelegateComponent >	delegates,
		SCR_EServicePointType	type
	)

Parameters

[out]	delegates
[in]	type

Returns

Definition at line 329 of file SCR_MilitaryBaseComponent.c.

GetServices()

int GetServices

(

out array< SCR_ServicePointComponent >

services = null

)

Get all registered systems inherited from SCR_ServicePointComponent

Parameters

[out]

services

Returns

Definition at line 228 of file SCR_MilitaryBaseComponent.c.

GetServicesByType()

int GetServicesByType	(	out array< SCR_ServicePointComponent >	services,
		SCR_EServicePointType	type
	)

Parameters

[out]	services
[in]	type

Returns

Definition at line 252 of file SCR_MilitaryBaseComponent.c.

IsProxy()

protected bool IsProxy

(

)

Definition at line 55 of file SCR_MilitaryBaseComponent.c.

NotificationsAllowed()

bool NotificationsAllowed

(

)

Show default notifications upon base capture (getter)

Returns

Definition at line 71 of file SCR_MilitaryBaseComponent.c.

NotifyPlayerInRadius()

protected void NotifyPlayerInRadius

(

notnull Faction

faction

)

Definition at line 794 of file SCR_MilitaryBaseComponent.c.

OnCallsignAssigned()

void OnCallsignAssigned

(

)

Definition at line 154 of file SCR_MilitaryBaseComponent.c.

OnCapturingFactionChanged()

void OnCapturingFactionChanged

(

)

Definition at line 753 of file SCR_MilitaryBaseComponent.c.

OnFactionChanged()

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

Event which is triggered when the owning faction changes.

Definition at line 511 of file SCR_MilitaryBaseComponent.c.

OnPlayerFactionResponse_O()

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

Definition at line 178 of file SCR_MilitaryBaseComponent.c.

OnPointCaptured()

void OnPointCaptured	(	notnull SCR_Faction	faction,
		notnull SCR_SeizingComponent	point
	)

Triggered when a registered SCR_SeizingComponent gets captured

Parameters

[in]	faction
[in]	point

Definition at line 669 of file SCR_MilitaryBaseComponent.c.

OnPointContested()

void OnPointContested	(	notnull SCR_Faction	faction,
		notnull SCR_SeizingComponent	point
	)

Triggered when a registered SCR_SeizingComponent starts getting captured

Parameters

[in]	faction
[in]	point

Definition at line 693 of file SCR_MilitaryBaseComponent.c.

OnPointSecured()

void OnPointSecured	(	notnull SCR_Faction	faction,
		notnull SCR_SeizingComponent	point
	)

Triggered when a registered SCR_SeizingComponent stops getting captured

Parameters

[in]	faction
[in]	point

Definition at line 720 of file SCR_MilitaryBaseComponent.c.

OnRadiusChanged()

protected void OnRadiusChanged

(

)

Definition at line 471 of file SCR_MilitaryBaseComponent.c.

OnRequiredPointsCaptured()

void OnRequiredPointsCaptured

(

notnull SCR_Faction

faction

)

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

Parameters

[in]

faction

Definition at line 746 of file SCR_MilitaryBaseComponent.c.

OnServiceStateChanged()

void OnServiceStateChanged	(	SCR_EServicePointStatus	state,
		notnull SCR_ServicePointComponent	serviceComponent
	)

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

Parameters

[in]	state
[in]	serviceComponent

Definition at line 566 of file SCR_MilitaryBaseComponent.c.

RegisterLogicComponent()

void RegisterLogicComponent

(

notnull SCR_MilitaryBaseLogicComponent

component

)

Parameters

[in]

component

Definition at line 590 of file SCR_MilitaryBaseComponent.c.

RegisterServiceDelegate()

void RegisterServiceDelegate

(

notnull SCR_ServicePointDelegateComponent

delegate

)

Parameters

[in]

delegate

Definition at line 574 of file SCR_MilitaryBaseComponent.c.

RplProp()

SCR_MilitaryBaseComponentClass ScriptComponentClass RplProp

(

onRplName:"OnRadiusChanged"

)

Definition at line 11 of file SCR_MilitaryBaseComponent.c.

ScriptInvokerServiceUnregisteredMethod()

void ScriptInvokerServiceUnregisteredMethod	(	SCR_MilitaryBaseComponent	militaryBaseComponent,
		SCR_ServicePointComponent	serviceComponent
	)

SetCallsign()

void SetCallsign

(

notnull SCR_Faction

faction

)

Parameters

[in]

faction

Definition at line 122 of file SCR_MilitaryBaseComponent.c.

SetCallsignIndex()

void SetCallsignIndex

(

int

index

)

Parameters

[in]

index

Definition at line 85 of file SCR_MilitaryBaseComponent.c.

SetCallsignIndexAutomatic()

void SetCallsignIndexAutomatic

(

int

index

)

Parameters

[in]

index

Definition at line 78 of file SCR_MilitaryBaseComponent.c.

SetFaction() [1/2]

void SetFaction

(

Faction

faction

)

Parameters

[in]

faction

Definition at line 486 of file SCR_MilitaryBaseComponent.c.

SetFaction() [2/2]

void SetFaction

(

FactionKey

faction

)

Parameters

[in]

faction

Definition at line 499 of file SCR_MilitaryBaseComponent.c.

SetRadius()

void SetRadius

(

int

radius

)

Parameters

[in]

radius

Definition at line 450 of file SCR_MilitaryBaseComponent.c.

UnregisterLogicComponent()

void UnregisterLogicComponent

(

notnull SCR_MilitaryBaseLogicComponent

component

)

Parameters

[in]

component

Definition at line 631 of file SCR_MilitaryBaseComponent.c.

UnregisterServiceDelegate()

void UnregisterServiceDelegate

(

notnull SCR_ServicePointDelegateComponent

delegate

)

Parameters

[in]

delegate

Definition at line 582 of file SCR_MilitaryBaseComponent.c.

~SCR_MilitaryBaseComponent()

void ~SCR_MilitaryBaseComponent

(

)

Definition at line 857 of file SCR_MilitaryBaseComponent.c.

Variable Documentation

m_aServiceDelegates

protected ref array<SCR_ServicePointDelegateComponent> m_aServiceDelegates = {}

Definition at line 43 of file SCR_MilitaryBaseComponent.c.

m_FactionComponent

protected SCR_FactionAffiliationComponent m_FactionComponent

Definition at line 46 of file SCR_MilitaryBaseComponent.c.

m_iCallsign

protected int m_iCallsign = INVALID_BASE_CALLSIGN

Definition at line 52 of file SCR_MilitaryBaseComponent.c.

m_RplComponent

protected RplComponent m_RplComponent

Definition at line 45 of file SCR_MilitaryBaseComponent.c.

m_sCapturingFaction

protected FactionKey m_sCapturingFaction

Definition at line 49 of file SCR_MilitaryBaseComponent.c.