Inheritance diagram for SCR_SeizingComponent:

Public Member Functions
int	GetRadius ()

int	GetMaximumAltitude ()

void	AllowNotifications (bool allow)

bool	NotificationsAllowed ()

ScriptInvoker	GetOnCaptureStart ()

ScriptInvoker	GetOnCaptureInterrupt ()

ScriptInvoker	GetOnCaptureFinish ()

OnTimerChangeInvoker	GetOnTimerChange ()

void	RefreshSeizingTimer ()

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	OnBaseRegistered (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)

void	~SCR_MilitaryBaseLogicComponent ()

Protected Member Functions
bool	IsProxy ()

void	EvaluatePrevailingFaction ()

void	OnQueryFinished (BaseGameTriggerEntity trigger)

SCR_Faction	EvaluateEntityFaction (IEntity ent)

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
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 = {}

Static Protected Attributes
static const float	TRIGGER_CHECK_PERIOD_IDLE = 3

static const float	TRIGGER_CHECK_PERIOD_ACTIVE = 1

Constructor & Destructor Documentation

◆ ~SCR_SeizingComponent()

void SCR_SeizingComponent.~SCR_SeizingComponent ( )

Member Function Documentation

◆ AllowNotifications()

void SCR_SeizingComponent.AllowNotifications ( bool allow )

Parameters

[in] allow

◆ Disable()

void SCR_SeizingComponent.Disable ( )

◆ EOnFrame()

override void SCR_SeizingComponent.EOnFrame	(	IEntity	owner,
		float	timeSlice )

◆ EvaluateEntityFaction()

SCR_Faction SCR_SeizingComponent.EvaluateEntityFaction ( IEntity ent )

protected

Implemented in SCR_CampaignSeizingComponent, and SCR_TutorialSeizingComponent.

◆ EvaluatePrevailingFaction()

void SCR_SeizingComponent.EvaluatePrevailingFaction ( )

protected

◆ GetFaction()

Faction SCR_SeizingComponent.GetFaction ( )

Returns

◆ GetIsLocalPlayerPresent()

bool SCR_SeizingComponent.GetIsLocalPlayerPresent ( )

protected

◆ GetMaximumAltitude()

int SCR_SeizingComponent.GetMaximumAltitude ( )

◆ GetOnCaptureFinish()

ScriptInvoker SCR_SeizingComponent.GetOnCaptureFinish ( )

Returns

◆ GetOnCaptureInterrupt()

ScriptInvoker SCR_SeizingComponent.GetOnCaptureInterrupt ( )

Returns

◆ GetOnCaptureStart()

ScriptInvoker SCR_SeizingComponent.GetOnCaptureStart ( )

Returns

◆ GetOnTimerChange()

OnTimerChangeInvoker SCR_SeizingComponent.GetOnTimerChange ( )

Returns

◆ GetRadius()

int SCR_SeizingComponent.GetRadius ( )

Returns

◆ GetSeizingEndTimestamp()

WorldTimestamp SCR_SeizingComponent.GetSeizingEndTimestamp ( )

Returns

◆ GetSeizingStartTimestamp()

WorldTimestamp SCR_SeizingComponent.GetSeizingStartTimestamp ( )

Returns

◆ HandleGradualReset()

void SCR_SeizingComponent.HandleGradualReset ( )

protected

When capture started after getting interrupted, take into account the time spent on it.

◆ IsDisabledAI()

bool SCR_SeizingComponent.IsDisabledAI ( IEntity ent )

Implemented in SCR_TutorialSeizingComponent.

◆ IsProxy()

bool SCR_SeizingComponent.IsProxy ( )

protected

◆ NotificationsAllowed()

bool SCR_SeizingComponent.NotificationsAllowed ( )

Returns

◆ NotifyPlayerInRadius()

void SCR_SeizingComponent.NotifyPlayerInRadius ( notnull SCR_Faction faction )

protected

◆ OnBaseFactionChanged()

override void SCR_SeizingComponent.OnBaseFactionChanged ( Faction faction )

Parameters

[in] faction

Implements SCR_MilitaryBaseLogicComponent.

◆ OnPlayerSpawned()

void SCR_SeizingComponent.OnPlayerSpawned	(	int	playerId,
		IEntity	controlledEntity )

protected

◆ OnPostInit()

override void SCR_SeizingComponent.OnPostInit ( IEntity owner )

Implements SCR_MilitaryBaseLogicComponent.

◆ OnPrevailingFactionChanged()

void SCR_SeizingComponent.OnPrevailingFactionChanged ( )

protected

◆ OnQueryFinished()

void SCR_SeizingComponent.OnQueryFinished ( BaseGameTriggerEntity trigger )

protected

Implemented in SCR_CampaignSeizingComponent.

◆ OnSeizingTimestampChanged()

void SCR_SeizingComponent.OnSeizingTimestampChanged ( )

protected

◆ RefreshSeizingTimer()

void SCR_SeizingComponent.RefreshSeizingTimer ( )

Implemented in SCR_CampaignSeizingComponent.

◆ RpcDo_OnCaptureFinish()

void SCR_SeizingComponent.RpcDo_OnCaptureFinish ( int factionIndex )

protected

◆ RpcDo_OnCaptureInterrupt()

void SCR_SeizingComponent.RpcDo_OnCaptureInterrupt ( int factionIndex )

protected

◆ RpcDo_OnCaptureStart()

void SCR_SeizingComponent.RpcDo_OnCaptureStart ( int factionIndex )

protected

◆ UpdateFlagsInHierarchy()

void SCR_SeizingComponent.UpdateFlagsInHierarchy ( notnull SCR_Faction faction )

protected

Member Data Documentation

◆ m_bCapturingRequiresPlayer

bool SCR_SeizingComponent.m_bCapturingRequiresPlayer

protected

◆ m_bCharacterPresent

bool SCR_SeizingComponent.m_bCharacterPresent

protected

◆ m_bDeleteDisabledAIs

bool SCR_SeizingComponent.m_bDeleteDisabledAIs = false

protected

◆ m_bEnabled

bool SCR_SeizingComponent.m_bEnabled = true

protected

◆ m_bGradualTimerReset

bool SCR_SeizingComponent.m_bGradualTimerReset

protected

◆ m_bIgnoreNonPlayableAttackers

bool SCR_SeizingComponent.m_bIgnoreNonPlayableAttackers

protected

◆ m_bIgnoreNonPlayableDefenders

bool SCR_SeizingComponent.m_bIgnoreNonPlayableDefenders

protected

◆ m_bQueryFinished

bool SCR_SeizingComponent.m_bQueryFinished = true

protected

◆ m_bShowNotifications

bool SCR_SeizingComponent.m_bShowNotifications

protected

◆ m_eCapturedByEnemiesNotification

ENotification SCR_SeizingComponent.m_eCapturedByEnemiesNotification

protected

◆ m_eCapturedByFriendliesNotification

ENotification SCR_SeizingComponent.m_eCapturedByFriendliesNotification

protected

◆ m_FactionControl

SCR_FactionAffiliationComponent SCR_SeizingComponent.m_FactionControl

protected

◆ m_fCurrentSeizingTime

float SCR_SeizingComponent.m_fCurrentSeizingTime

protected

◆ m_fInterruptedCaptureDuration

float SCR_SeizingComponent.m_fInterruptedCaptureDuration

protected

◆ m_fInterruptedCaptureTimestamp

WorldTimestamp SCR_SeizingComponent.m_fInterruptedCaptureTimestamp

protected

◆ m_fMaximumSeizingTime

float SCR_SeizingComponent.m_fMaximumSeizingTime

protected

◆ m_fMinimumSeizingTime

float SCR_SeizingComponent.m_fMinimumSeizingTime

protected

◆ m_fRespawnCooldownPeriod

float SCR_SeizingComponent.m_fRespawnCooldownPeriod

protected

◆ m_fSeizingEndTimestamp

WorldTimestamp SCR_SeizingComponent.m_fSeizingEndTimestamp

protected

◆ m_fSeizingStartTimestamp

WorldTimestamp SCR_SeizingComponent.m_fSeizingStartTimestamp

protected

◆ m_iMaximumAltitude

int SCR_SeizingComponent.m_iMaximumAltitude

protected

◆ m_iMaximumSeizingCharacters

int SCR_SeizingComponent.m_iMaximumSeizingCharacters

protected

◆ m_iRadius

int SCR_SeizingComponent.m_iRadius

protected

◆ m_iSeizingCharacters

int SCR_SeizingComponent.m_iSeizingCharacters

protected

◆ m_mSpawnTimers

ref map<int, WorldTimestamp> SCR_SeizingComponent.m_mSpawnTimers = new map<int, WorldTimestamp>()

protected

◆ m_OnCaptureFinish

ref ScriptInvoker SCR_SeizingComponent.m_OnCaptureFinish

protected

◆ m_OnCaptureInterrupt

ref ScriptInvoker SCR_SeizingComponent.m_OnCaptureInterrupt

protected

◆ m_OnCaptureStart

ref ScriptInvoker SCR_SeizingComponent.m_OnCaptureStart

protected

◆ m_OnTimerChange

ref OnTimerChangeInvoker SCR_SeizingComponent.m_OnTimerChange

protected

◆ m_PrevailingFaction

SCR_Faction SCR_SeizingComponent.m_PrevailingFaction

protected

◆ m_PrevailingFactionPrevious

SCR_Faction SCR_SeizingComponent.m_PrevailingFactionPrevious

protected

◆ m_RplComponent

RplComponent SCR_SeizingComponent.m_RplComponent

protected

◆ m_Trigger

BaseGameTriggerEntity SCR_SeizingComponent.m_Trigger

protected

◆ TRIGGER_CHECK_PERIOD_ACTIVE

const float SCR_SeizingComponent.TRIGGER_CHECK_PERIOD_ACTIVE = 1

staticprotected

◆ TRIGGER_CHECK_PERIOD_IDLE

const float SCR_SeizingComponent.TRIGGER_CHECK_PERIOD_IDLE = 3

staticprotected

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

Game/GameMode/Components/SCR_SeizingComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ ~SCR_SeizingComponent()

Member Function Documentation

◆ AllowNotifications()

◆ Disable()

◆ EOnFrame()

◆ EvaluateEntityFaction()

◆ EvaluatePrevailingFaction()

◆ GetFaction()

◆ GetIsLocalPlayerPresent()

◆ GetMaximumAltitude()

◆ GetOnCaptureFinish()

◆ GetOnCaptureInterrupt()

◆ GetOnCaptureStart()

◆ GetOnTimerChange()

◆ GetRadius()

◆ GetSeizingEndTimestamp()

◆ GetSeizingStartTimestamp()

◆ HandleGradualReset()

◆ IsDisabledAI()

◆ IsProxy()

◆ NotificationsAllowed()

◆ NotifyPlayerInRadius()

◆ OnBaseFactionChanged()

◆ OnPlayerSpawned()

◆ OnPostInit()

◆ OnPrevailingFactionChanged()

◆ OnQueryFinished()

◆ OnSeizingTimestampChanged()

◆ RefreshSeizingTimer()

◆ RpcDo_OnCaptureFinish()

◆ RpcDo_OnCaptureInterrupt()

◆ RpcDo_OnCaptureStart()

◆ UpdateFlagsInHierarchy()

Member Data Documentation

◆ m_bCapturingRequiresPlayer

◆ m_bCharacterPresent

◆ m_bDeleteDisabledAIs

◆ m_bEnabled

◆ m_bGradualTimerReset

◆ m_bIgnoreNonPlayableAttackers

◆ m_bIgnoreNonPlayableDefenders

◆ m_bQueryFinished

◆ m_bShowNotifications

◆ m_eCapturedByEnemiesNotification

◆ m_eCapturedByFriendliesNotification

◆ m_FactionControl

◆ m_fCurrentSeizingTime

◆ m_fInterruptedCaptureDuration

◆ m_fInterruptedCaptureTimestamp

◆ m_fMaximumSeizingTime

◆ m_fMinimumSeizingTime

◆ m_fRespawnCooldownPeriod

◆ m_fSeizingEndTimestamp

◆ m_fSeizingStartTimestamp

◆ m_iMaximumAltitude

◆ m_iMaximumSeizingCharacters

◆ m_iRadius

◆ m_iSeizingCharacters

◆ m_mSpawnTimers

◆ m_OnCaptureFinish

◆ m_OnCaptureInterrupt

◆ m_OnCaptureStart

◆ m_OnTimerChange

◆ m_PrevailingFaction

◆ m_PrevailingFactionPrevious

◆ m_RplComponent

◆ m_Trigger

◆ TRIGGER_CHECK_PERIOD_ACTIVE

◆ TRIGGER_CHECK_PERIOD_IDLE