SCR_CampaignSeizingComponent Interface Reference

Inheritance diagram for SCR_CampaignSeizingComponent:

Public Member Functions
OnCaptureStateChangedInvoker	GetOnCaptureStateChanged ()
int	GetContestingFactionsCount ()
override void	RefreshSeizingTimer ()
override void	OnBaseRegistered (notnull SCR_MilitaryBaseComponent base)
Public Member Functions inherited from SCR_SeizingComponent
int	GetRadius ()
int	GetMaximumAltitude ()
void	AllowNotifications (bool allow)
bool	NotificationsAllowed ()
ScriptInvoker	GetOnCaptureStart ()
ScriptInvoker	GetOnCaptureInterrupt ()
ScriptInvoker	GetOnCaptureFinish ()
OnTimerChangeInvoker	GetOnTimerChange ()
WorldTimestamp	GetSeizingStartTimestamp ()
WorldTimestamp	GetSeizingEndTimestamp ()
Faction	GetFaction ()
override void	OnBaseFactionChanged (Faction faction)
bool	IsDisabledAI (IEntity ent)
void	Disable ()
override void	OnPostInit (IEntity owner)
override void	EOnFrame (IEntity owner, float timeSlice)
void	~SCR_SeizingComponent ()
Public Member Functions inherited from SCR_MilitaryBaseLogicComponent
void	RegisterBase (notnull SCR_MilitaryBaseComponent base)
void	UnregisterBase (notnull SCR_MilitaryBaseComponent base)
void	OnBaseUnregistered (notnull SCR_MilitaryBaseComponent base)
int	GetBases (out array< SCR_MilitaryBaseComponent > bases)
bool	IsControlledByFaction (notnull Faction faction)
void	OnCapturingFactionChanged (FactionKey faction)
override void	EOnInit (IEntity owner)
override void	OnDelete (IEntity owner)

Protected Member Functions
override SCR_Faction	EvaluateEntityFaction (IEntity ent)
override void	OnQueryFinished (BaseGameTriggerEntity trigger)
void	RpcDo_OnCaptureStateChanged ()
Protected Member Functions inherited from SCR_SeizingComponent
bool	IsProxy ()
void	EvaluatePrevailingFaction ()
void	OnPrevailingFactionChanged ()
void	OnSeizingTimestampChanged ()
void	HandleGradualReset ()
	When capture started after getting interrupted, take into account the time spent on it.
void	RpcDo_OnCaptureStart (int factionIndex)
void	RpcDo_OnCaptureInterrupt (int factionIndex)
void	RpcDo_OnCaptureFinish (int factionIndex)
void	OnPlayerSpawned (int playerId, IEntity controlledEntity)
void	UpdateFlagsInHierarchy (notnull SCR_Faction faction)
bool	GetIsLocalPlayerPresent ()
void	NotifyPlayerInRadius (notnull SCR_Faction faction)

Protected Attributes
float	m_fExtraTimePerService
float	m_fExtraTimePerRadioConnection
SCR_CampaignMilitaryBaseComponent	m_Base
SCR_EBaseCaptureState	m_eCaptureState
ref OnCaptureStateChangedInvoker	m_OnCaptureStateChanged
int	m_iContestingFactionsCount
Protected Attributes inherited from SCR_SeizingComponent
int	m_iRadius
int	m_iMaximumAltitude
float	m_fMaximumSeizingTime
float	m_fMinimumSeizingTime
int	m_iMaximumSeizingCharacters
float	m_fRespawnCooldownPeriod
bool	m_bGradualTimerReset
bool	m_bIgnoreNonPlayableAttackers
bool	m_bIgnoreNonPlayableDefenders
bool	m_bCapturingRequiresPlayer
bool	m_bShowNotifications
ENotification	m_eCapturedByFriendliesNotification
ENotification	m_eCapturedByEnemiesNotification
WorldTimestamp	m_fSeizingStartTimestamp
WorldTimestamp	m_fSeizingEndTimestamp
ref ScriptInvoker	m_OnCaptureStart
ref ScriptInvoker	m_OnCaptureInterrupt
ref ScriptInvoker	m_OnCaptureFinish
ref OnTimerChangeInvoker	m_OnTimerChange
WorldTimestamp	m_fInterruptedCaptureTimestamp
float	m_fCurrentSeizingTime
float	m_fInterruptedCaptureDuration
SCR_Faction	m_PrevailingFaction
SCR_Faction	m_PrevailingFactionPrevious
BaseGameTriggerEntity	m_Trigger
bool	m_bQueryFinished = true
bool	m_bEnabled = true
RplComponent	m_RplComponent
bool	m_bCharacterPresent
SCR_FactionAffiliationComponent	m_FactionControl
int	m_iSeizingCharacters
ref map< int, WorldTimestamp >	m_mSpawnTimers = new map<int, WorldTimestamp>()
bool	m_bDeleteDisabledAIs = false
Protected Attributes inherited from SCR_MilitaryBaseLogicComponent
ref array< SCR_MilitaryBaseComponent >	m_aBases = {}

Additional Inherited Members
Static Protected Attributes inherited from SCR_SeizingComponent
static const float	TRIGGER_CHECK_PERIOD_IDLE = 3
static const float	TRIGGER_CHECK_PERIOD_ACTIVE = 1

Member Function Documentation

EvaluateEntityFaction()

override SCR_Faction SCR_CampaignSeizingComponent.EvaluateEntityFaction ( IEntity ent )

protected

Implements SCR_SeizingComponent.

GetContestingFactionsCount()

int SCR_CampaignSeizingComponent.GetContestingFactionsCount

(

)

GetOnCaptureStateChanged()

OnCaptureStateChangedInvoker SCR_CampaignSeizingComponent.GetOnCaptureStateChanged

(

)

Returns

OnBaseRegistered()

override void SCR_CampaignSeizingComponent.OnBaseRegistered

(

notnull SCR_MilitaryBaseComponent

base

)

Parameters

[in]

base

Implements SCR_MilitaryBaseLogicComponent.

OnQueryFinished()

override void SCR_CampaignSeizingComponent.OnQueryFinished ( BaseGameTriggerEntity trigger )

protected

Implements SCR_SeizingComponent.

RefreshSeizingTimer()

override void SCR_CampaignSeizingComponent.RefreshSeizingTimer

(

)

Implements SCR_SeizingComponent.

RpcDo_OnCaptureStateChanged()

void SCR_CampaignSeizingComponent.RpcDo_OnCaptureStateChanged ( )

protected

Member Data Documentation

m_Base

SCR_CampaignMilitaryBaseComponent SCR_CampaignSeizingComponent.m_Base

protected

m_eCaptureState

SCR_EBaseCaptureState SCR_CampaignSeizingComponent.m_eCaptureState

protected

m_fExtraTimePerRadioConnection

float SCR_CampaignSeizingComponent.m_fExtraTimePerRadioConnection

protected

m_fExtraTimePerService

float SCR_CampaignSeizingComponent.m_fExtraTimePerService

protected

m_iContestingFactionsCount

int SCR_CampaignSeizingComponent.m_iContestingFactionsCount

protected

m_OnCaptureStateChanged

ref OnCaptureStateChangedInvoker SCR_CampaignSeizingComponent.m_OnCaptureStateChanged

protected

---

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

• Game/GameMode/Components/SCR_CampaignSeizingComponent.c