SCR_ServicePointComponent Interface Reference

Inheritance diagram for SCR_ServicePointComponent:

Public Member Functions
Faction	GetFaction ()
ResourceName	GetDelegatePrefab ()
ScriptInvoker< SCR_ServicePointComponent, SCR_MilitaryBaseComponent >	GetOnBaseRegistered ()
ScriptInvoker< SCR_ServicePointComponent, SCR_MilitaryBaseComponent >	GetOnBaseUnregistered ()
ScriptInvoker	GetOnServiceStateChanged ()
SCR_EServicePointType	GetType ()
EEditableEntityLabel	GetLabel ()
SCR_EServicePointStatus	GetServiceState ()
void	SetServiceState (SCR_EServicePointStatus state)
	Set the current operational state of the service.
void	ServiceStateChanged ()
	Called from RplProp event.
void	SetDelegate (notnull SCR_ServicePointDelegateComponent delegate)
override void	OnBaseRegistered (notnull SCR_MilitaryBaseComponent base)
override void	OnBaseUnregistered (notnull SCR_MilitaryBaseComponent base)
void	RegisterService ()
void	SetServiceOnline ()
	Switch service to online status.
override void	OnPostInit (IEntity owner)
override void	OnDelete (IEntity owner)
Public Member Functions inherited from SCR_MilitaryBaseLogicComponent
void	RegisterBase (notnull SCR_MilitaryBaseComponent base)
void	UnregisterBase (notnull SCR_MilitaryBaseComponent base)
int	GetBases (out array< SCR_MilitaryBaseComponent > bases)
bool	IsControlledByFaction (notnull Faction faction)
void	OnBaseFactionChanged (Faction faction)
void	OnCapturingFactionChanged (FactionKey faction)
override void	EOnInit (IEntity owner)
void	~SCR_MilitaryBaseLogicComponent ()

Static Public Member Functions
static void	SpawnAsOffline (bool val)
	The service will not be registered on init. For an example for Free Roam building - the registration will happen once the service is fully build.

Protected Member Functions
void	OnFactionChanged (FactionAffiliationComponent owner, Faction previousFaction, Faction faction)

Protected Attributes
SCR_EServicePointType	m_eType
EEditableEntityLabel	m_eBuildingLabel
ResourceName	m_sDelegatePrefab
SCR_EServicePointStatus	m_eServiceState = SCR_EServicePointStatus.OFFLINE
SCR_FactionAffiliationComponent	m_FactionControl
ref ScriptInvoker< SCR_ServicePointComponent, SCR_MilitaryBaseComponent >	m_OnBaseRegistered
ref ScriptInvoker< SCR_ServicePointComponent, SCR_MilitaryBaseComponent >	m_OnBaseUnregistered
ref ScriptInvoker	m_OnServiceStateChanged
SCR_ServicePointDelegateComponent	m_Delegate
Protected Attributes inherited from SCR_MilitaryBaseLogicComponent
ref array< SCR_MilitaryBaseComponent >	m_aBases = {}

Static Protected Attributes
static bool	s_bSpawnAsOffline

Member Function Documentation

GetDelegatePrefab()

ResourceName SCR_ServicePointComponent.GetDelegatePrefab

(

)

Returns

GetFaction()

Faction SCR_ServicePointComponent.GetFaction

(

)

Returns

GetLabel()

EEditableEntityLabel SCR_ServicePointComponent.GetLabel

(

)

Returns

GetOnBaseRegistered()

ScriptInvoker< SCR_ServicePointComponent, SCR_MilitaryBaseComponent > SCR_ServicePointComponent.GetOnBaseRegistered

(

)

Returns

Invoker that gets called when a base gets registered.

GetOnBaseUnregistered()

ScriptInvoker< SCR_ServicePointComponent, SCR_MilitaryBaseComponent > SCR_ServicePointComponent.GetOnBaseUnregistered

(

)

Returns

Invoker that gets called when a base gets unregistered.

GetOnServiceStateChanged()

ScriptInvoker SCR_ServicePointComponent.GetOnServiceStateChanged

(

)

Returns

GetServiceState()

SCR_EServicePointStatus SCR_ServicePointComponent.GetServiceState

(

)

Returns

GetType()

SCR_EServicePointType SCR_ServicePointComponent.GetType

(

)

Returns

OnBaseRegistered()

override void SCR_ServicePointComponent.OnBaseRegistered

(

notnull SCR_MilitaryBaseComponent

base

)

Parameters

[in]

base

Implements SCR_MilitaryBaseLogicComponent.

OnBaseUnregistered()

override void SCR_ServicePointComponent.OnBaseUnregistered

(

notnull SCR_MilitaryBaseComponent

base

)

Parameters

[in]

base

Implements SCR_MilitaryBaseLogicComponent.

OnDelete()

override void SCR_ServicePointComponent.OnDelete

(

IEntity

owner

)

Implemented in SCR_CatalogEntitySpawnerComponent.

OnFactionChanged()

void SCR_ServicePointComponent.OnFactionChanged ( FactionAffiliationComponent owner, Faction previousFaction, Faction faction )

protected

Implemented in SCR_AntennaServicePointComponent, SCR_CatalogEntitySpawnerComponent, and SCR_DefenderSpawnerComponent.

OnPostInit()

override void SCR_ServicePointComponent.OnPostInit

(

IEntity

owner

)

Implements SCR_MilitaryBaseLogicComponent.

Implemented in SCR_AntennaServicePointComponent, SCR_CatalogEntitySpawnerComponent, and SCR_DefenderSpawnerComponent.

RegisterService()

void SCR_ServicePointComponent.RegisterService

(

)

ServiceStateChanged()

void SCR_ServicePointComponent.ServiceStateChanged

(

)

Called from RplProp event.

SetDelegate()

void SCR_ServicePointComponent.SetDelegate

(

notnull SCR_ServicePointDelegateComponent

delegate

)

Parameters

[in]

delegate

SetServiceOnline()

void SCR_ServicePointComponent.SetServiceOnline

(

)

Switch service to online status.

SetServiceState()

void SCR_ServicePointComponent.SetServiceState

(

SCR_EServicePointStatus

state

)

Set the current operational state of the service.

SpawnAsOffline()

static void SCR_ServicePointComponent.SpawnAsOffline ( bool val )

static

The service will not be registered on init. For an example for Free Roam building - the registration will happen once the service is fully build.

Member Data Documentation

m_Delegate

SCR_ServicePointDelegateComponent SCR_ServicePointComponent.m_Delegate

protected

m_eBuildingLabel

EEditableEntityLabel SCR_ServicePointComponent.m_eBuildingLabel

protected

m_eServiceState

SCR_EServicePointStatus SCR_ServicePointComponent.m_eServiceState = SCR_EServicePointStatus.OFFLINE

protected

m_eType

SCR_EServicePointType SCR_ServicePointComponent.m_eType

protected

m_FactionControl

SCR_FactionAffiliationComponent SCR_ServicePointComponent.m_FactionControl

protected

m_OnBaseRegistered

ref ScriptInvoker<SCR_ServicePointComponent, SCR_MilitaryBaseComponent> SCR_ServicePointComponent.m_OnBaseRegistered

protected

m_OnBaseUnregistered

ref ScriptInvoker<SCR_ServicePointComponent, SCR_MilitaryBaseComponent> SCR_ServicePointComponent.m_OnBaseUnregistered

protected

m_OnServiceStateChanged

ref ScriptInvoker SCR_ServicePointComponent.m_OnServiceStateChanged

protected

m_sDelegatePrefab

ResourceName SCR_ServicePointComponent.m_sDelegatePrefab

protected

s_bSpawnAsOffline

bool SCR_ServicePointComponent.s_bSpawnAsOffline

staticprotected

---

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

• Game/GameMode/Components/SCR_ServicePointComponent.c