Inheritance diagram for SCR_ScenarioFrameworkLayerTaskDefend:

[legend]

Public Member Functions
float	GetDefendTime ()

void	SetDefendTime (float time)

SCR_CharacterTriggerEntity	GetCharacterTriggerEntity ()

void	FindCharacterTriggerEntity ()

override bool	SetSupportEntity ()

void	SCR_ScenarioFrameworkLayerTaskDefend (IEntityComponentSource src, IEntity ent, IEntity parent)

void	EvaluateStatus ()

void	SetupAttackerLayer ()

void	SetupEvaluation ()

override void	RestoreToDefault (bool includeChildren=false, bool reinitAfterRestoration=false)

override void	DynamicDespawn (SCR_ScenarioFrameworkLayerBase layer)

override void	AfterAllChildrenSpawned (SCR_ScenarioFrameworkLayerBase layer)

override void	OnPostInit (IEntity owner)

void	InitHUD ()

void	UpdateHUD ()

void	RpcDo_UpdateHUD (float countdown, int taskID)

void	CheckAttackerLayers ()

void	RemovePeriodicUpdates ()

override void	EOnFrame (IEntity owner, float timeSlice)

Public Member Functions inherited from SCR_ScenarioFrameworkLayerTask
SCR_TaskState	GetLayerTaskState ()

bool	GetLayerTaskResolvedBeforeLoad ()

void	SetLayerTaskState (SCR_TaskState state)

SCR_ScenarioFrameworkTask	GetTask ()

ResourceName	GetTaskPrefab ()

string	GetOverridenObjectDisplayName ()

void	SetOverridenObjectDisplayName (string name)

string	GetTaskTitle ()

string	GetOriginalTaskDescription ()

string	GetTaskDescription ()

SCR_ESFTaskType	GetTaskType ()

override void	RestoreToDefault (bool includeChildren=false, bool reinitAfterRestoration=false)

override void	DynamicReinit ()

override void	DynamicDespawn (SCR_ScenarioFrameworkLayerBase layer)

override void	FinishInit ()

void	OnTaskStateChanged (SCR_TaskState previousState, SCR_TaskState newState)

void	SetSlotTask (SCR_ScenarioFrameworkSlotTask slotTask)

SCR_ScenarioFrameworkSlotTask	GetSlotTask ()

void	InitTask (SCR_ScenarioFrameworkLayerBase layer)

override void	_WB_AfterWorldUpdate (IEntity owner, float timeSlice)

override bool	_WB_OnKeyChanged (IEntity owner, BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent)

void	~SCR_ScenarioFrameworkLayerTask ()

Public Member Functions inherited from SCR_ScenarioFrameworkLayerBase
string	GetName ()

void	SetEntity (IEntity entity)

bool	GetIsTerminated ()

void	SetIsTerminated (bool state)

void	SetRandomlySpawnedChildren (array< string > randomlySpawnedChildren)

array< SCR_ScenarioFrameworkLayerBase >	GetRandomlySpawnedChildren ()

int	GetPlayersCount (FactionKey factionName="")

int	GetMaxPlayersForGameMode (FactionKey factionName="")

SCR_ScenarioFrameworkArea	GetParentArea ()
	Get parent area the object is nested into.

SCR_ScenarioFrameworkLayerTask	GetLayerTask ()
	Get layer task the object is nested into if there is some.

SCR_ScenarioFrameworkSlotTask	GetSlotTask (array< SCR_ScenarioFrameworkLayerBase > aLayers)
	Get SlotTask from array of LayerBases if there is any.

void	SetParentLayer (SCR_ScenarioFrameworkLayerBase parentLayer)

SCR_ScenarioFrameworkLayerBase	GetParentLayer ()

SCR_EScenarioFrameworkSpawnChildrenType	GetSpawnChildrenType ()

bool	GetEnableRepeatedSpawn ()

void	SetEnableRepeatedSpawn (bool value)

SCR_ScenarioFrameworkEActivationType	GetActivationType ()

void	SetActivationType (SCR_ScenarioFrameworkEActivationType activationType)

bool	GetIsInitiated ()

bool	GetDynamicDespawnExcluded ()

void	SetDynamicDespawnExcluded (bool excluded)

array< IEntity >	GetSpawnedEntities ()

array< SCR_ScenarioFrameworkLayerBase >	GetChildrenEntities ()

SCR_ScenarioFrameworkLayerBase	GetRandomChildren ()
	Returns the random Slot.

void	GetChildren (out array< SCR_ScenarioFrameworkLayerBase > children)
	Goes through the hierarchy and returns all the child entities of LayerBase type.

void	GetLogics (out array< SCR_ScenarioFrameworkLogic > logics)

array< SCR_ScenarioFrameworkLogic >	GetSpawnedLogics ()

array< ref SCR_ScenarioFrameworkPlugin >	GetSpawnedPlugins ()

int	GetRepeatedSpawnNumber ()

void	SetRepeatedSpawnNumber (int number)

ScriptInvokerScenarioFrameworkLayer	GetOnAllChildrenSpawned ()

void	InvokeAllChildrenSpawned ()

void	CheckAllChildrenSpawned (SCR_ScenarioFrameworkLayerBase layer=null)

void	SpawnChildren (bool previouslyRandomized=false)

void	SpawnPreviouslyRandomizedChildren ()

void	SpawnRandomOneChild (bool previouslyRandomized=false)

void	SpawnRandomMultipleChildren (bool previouslyRandomized=false)

void	InitChild (SCR_ScenarioFrameworkLayerBase child)

IEntity	GetSpawnedEntity ()

void	RestoreToDefault (bool includeChildren=false, bool reinitAfterRestoration=false)

void	DynamicDespawn (SCR_ScenarioFrameworkLayerBase layer)

void	DynamicReinit ()

bool	InitAlreadyHappened ()

bool	InitParentLayer ()

bool	InitNotTerminated ()

bool	InitDynDespawnAndActivation (SCR_ScenarioFrameworkEActivationType activation)

bool	InitActivationConditions ()

bool	InitArea (SCR_ScenarioFrameworkArea area)

void	InitFactionSettings ()
	Handles inheritance of faction settings from parents.

bool	InitOtherThings ()
	For situations where some other logic is to be appended in these checks and is to be performed before FinishInit.

void	FinishInitChildrenInsert ()
	For situations where some other logic is needed to be performed before or after this Insert.

void	FinishInit ()

void	Init (SCR_ScenarioFrameworkArea area=null, SCR_ScenarioFrameworkEActivationType activation=SCR_ScenarioFrameworkEActivationType.SAME_AS_PARENT)

void	AfterAllChildrenSpawned (SCR_ScenarioFrameworkLayerBase layer)

override void	EOnFrame (IEntity owner, float timeSlice)

override void	OnPostInit (IEntity owner)

void	SetDebugShapeSize (float fSize)

override void	_WB_OnCreate (IEntity owner, IEntitySource src)

void	RenameOwnerEntity (IEntity owner)

void	SCR_ScenarioFrameworkLayerBase (IEntityComponentSource src, IEntity ent, IEntity parent)

void	~SCR_ScenarioFrameworkLayerBase ()

Protected Member Functions
void	CountAttackerDefenderNumbers (out int defenderCount, out int attackerCount)

Protected Member Functions inherited from SCR_ScenarioFrameworkLayerTask
bool	SetTaskPrefab ()

bool	SetSupportEntity ()

bool	CreateTask ()

void	SetupTask ()

Protected Member Functions inherited from SCR_ScenarioFrameworkLayerBase
void	SetFactionKey (FactionKey factionKey)

FactionKey	GetFactionKey ()

void	RepeatedSpawn ()

void	RepeatedSpawnCalled ()

void	ActivateLogic ()

void	DrawDebugShape (bool draw)

Protected Attributes
string	m_sTriggerName

LocalizedString	m_sCountdownTitleText

float	m_fDefendTime

bool	m_bDisplayCountdownHUD

ResourceName	m_sCountdownHUD

ref array< ref SCR_ScenarioFrameworkTaskDefendFactionSettings >	m_aFactionSettings

float	m_fMinDefenderPercentageRatio

ref array< string >	m_aAttackerLayerNames

bool	m_bEarlierEvaluation

bool	m_bDelayedEvaluation

bool	m_bDisplayDelayedEvaluationText

LocalizedString	m_sDelayedEvaluationText

SCR_CharacterTriggerEntity	m_CharacterTriggerEntity

float	m_fTempCountdown = m_fDefendTime

string	m_sFormattedCountdownTitle = string.Format(WidgetManager.Translate("<color rgba=\"226, 168, 80, 255\">%1</color>", m_sCountdownTitleText))

string	m_sFormattedDelayedEvaluationText = string.Format(WidgetManager.Translate("<color rgba=\"226, 168, 80, 255\">%1</color>", m_sDelayedEvaluationText))

ref array< SCR_ScenarioFrameworkLayerBase >	m_aAttackerLayer = {}

float	m_fTempTimeSlice

bool	m_bTaskEvaluated

bool	m_bEvaluationSet

WorldTimestamp	m_fEvaluateTimeStart

WorldTimestamp	m_fEvaluateTimeEnd

Widget	m_wRoot

Widget	m_wInfoOverlay

Widget	m_wCountdownOverlay

RichTextWidget	m_wCountdown

RichTextWidget	m_wFlavour

Protected Attributes inherited from SCR_ScenarioFrameworkLayerTask
bool	m_bShowDebugShapesInWorkbench

Additional Inherited Members
Public Attributes inherited from SCR_ScenarioFrameworkLayerTask
string	m_sTaskTitle

string	m_sTaskDescription

SCR_ESFTaskType	m_eTypeOfTask = SCR_ESFTaskType.DEFAULT

ResourceName	m_sTaskPrefab

bool	m_bPlaceMarkerOnSubjectSlot

string	m_sOverrideObjectDisplayName

ref array< ref SCR_ScenarioFrameworkActionBase >	m_aTriggerActionsOnFinish

SCR_ScenarioFrameworkSlotTask	m_SlotTask

SCR_ScenarioFrameworkTask	m_Task

SCR_ScenarioFrameworkTaskSupportEntity	m_SupportEntity

SCR_TaskState	m_eLayerTaskState

bool	m_bTaskResolvedBeforeLoad

Public Attributes inherited from SCR_ScenarioFrameworkLayerBase
SCR_EScenarioFrameworkSpawnChildrenType	m_SpawnChildren

FactionKey	m_sFactionKey

int	m_iRandomPercent

bool	m_bEnableRepeatedSpawn

int	m_iRepeatedSpawnNumber

float	m_fRepeatedSpawnTimer

bool	m_bShowDebugShapesDuringRuntime

SCR_ScenarioFrameworkEActivationType	m_eActivationType

ref array< ref SCR_ScenarioFrameworkActivationConditionBase >	m_aActivationConditions

ref array< ref SCR_ScenarioFrameworkActionBase >	m_aActivationActions

bool	m_bExcludeFromDynamicDespawn

ref array< ref SCR_ScenarioFrameworkPlugin >	m_aPlugins

ref array< SCR_ScenarioFrameworkLayerBase >	m_aChildren = {}

ref array< SCR_ScenarioFrameworkLayerBase >	m_aRandomlySpawnedChildren = {}

ref array< SCR_ScenarioFrameworkLogic >	m_aLogic = {}

ref ScriptInvokerBase< ScriptInvokerScenarioFrameworkLayerMethod >	m_OnAllChildrenSpawned

ref array< IEntity >	m_aSpawnedEntities = {}

IEntity	m_Entity

SCR_ScenarioFrameworkArea	m_Area

SCR_ScenarioFrameworkLayerBase	m_ParentLayer

float	m_fDebugShapeRadius = 0.25

WorldTimestamp	m_fRepeatSpawnTimeStart

WorldTimestamp	m_fRepeatSpawnTimeEnd

int	m_iDebugShapeColor = ARGB(32, 0xFF, 0x00, 0x12)

int	m_iCurrentlySpawnedChildren

int	m_iSupposedSpawnedChildren

bool	m_bInitiated

bool	m_bIsRegistered

bool	m_bDynamicallyDespawned

bool	m_bIsTerminated

int	m_iRepeatedSpawnNumberDefault = m_iRepeatedSpawnNumber

SCR_ScenarioFrameworkEActivationType	m_eActivationTypeDefault = m_eActivationType

Static Public Attributes inherited from SCR_ScenarioFrameworkLayerTask
static const ref ScriptInvoker	s_OnTaskSetup = new ScriptInvoker()

Static Public Attributes inherited from SCR_ScenarioFrameworkLayerBase
static const int	SPAWN_DELAY = 200

Constructor & Destructor Documentation

◆ SCR_ScenarioFrameworkLayerTaskDefend()

void SCR_ScenarioFrameworkLayerTaskDefend.SCR_ScenarioFrameworkLayerTaskDefend	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent
	)

Parameters

[in]	src
[in]	ent
[in]	parent

Member Function Documentation

◆ AfterAllChildrenSpawned()

override void SCR_ScenarioFrameworkLayerTaskDefend.AfterAllChildrenSpawned ( SCR_ScenarioFrameworkLayerBase layer )

Implements SCR_ScenarioFrameworkLayerBase.

◆ CheckAttackerLayers()

void SCR_ScenarioFrameworkLayerTaskDefend.CheckAttackerLayers ( )

◆ CountAttackerDefenderNumbers()

void SCR_ScenarioFrameworkLayerTaskDefend.CountAttackerDefenderNumbers	(	out int	defenderCount,
		out int	attackerCount
	)

protected

◆ DynamicDespawn()

override void SCR_ScenarioFrameworkLayerTaskDefend.DynamicDespawn ( SCR_ScenarioFrameworkLayerBase layer )

Implements SCR_ScenarioFrameworkLayerTask.

◆ EOnFrame()

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

Implements SCR_ScenarioFrameworkLayerBase.

◆ EvaluateStatus()

void SCR_ScenarioFrameworkLayerTaskDefend.EvaluateStatus ( )

◆ FindCharacterTriggerEntity()

void SCR_ScenarioFrameworkLayerTaskDefend.FindCharacterTriggerEntity ( )

◆ GetCharacterTriggerEntity()

SCR_CharacterTriggerEntity SCR_ScenarioFrameworkLayerTaskDefend.GetCharacterTriggerEntity ( )

Returns

◆ GetDefendTime()

float SCR_ScenarioFrameworkLayerTaskDefend.GetDefendTime ( )

Returns

◆ InitHUD()

void SCR_ScenarioFrameworkLayerTaskDefend.InitHUD ( )

◆ OnPostInit()

override void SCR_ScenarioFrameworkLayerTaskDefend.OnPostInit ( IEntity owner )

Implements SCR_ScenarioFrameworkLayerBase.

◆ RemovePeriodicUpdates()

void SCR_ScenarioFrameworkLayerTaskDefend.RemovePeriodicUpdates ( )

◆ RestoreToDefault()

override void SCR_ScenarioFrameworkLayerTaskDefend.RestoreToDefault	(	bool	includeChildren = `false`,
		bool	reinitAfterRestoration = `false`
	)

Implements SCR_ScenarioFrameworkLayerTask.

◆ RpcDo_UpdateHUD()

void SCR_ScenarioFrameworkLayerTaskDefend.RpcDo_UpdateHUD	(	float	countdown,
		int	taskID
	)

Parameters

[in]	countdown
[in]	taskID

◆ SetDefendTime()

void SCR_ScenarioFrameworkLayerTaskDefend.SetDefendTime ( float time )

Parameters

[in] time

◆ SetSupportEntity()

override bool SCR_ScenarioFrameworkLayerTaskDefend.SetSupportEntity ( )

Implements SCR_ScenarioFrameworkLayerTask.

◆ SetupAttackerLayer()

void SCR_ScenarioFrameworkLayerTaskDefend.SetupAttackerLayer ( )

◆ SetupEvaluation()

void SCR_ScenarioFrameworkLayerTaskDefend.SetupEvaluation ( )

◆ UpdateHUD()

void SCR_ScenarioFrameworkLayerTaskDefend.UpdateHUD ( )

Member Data Documentation

◆ m_aAttackerLayer

ref array<SCR_ScenarioFrameworkLayerBase> SCR_ScenarioFrameworkLayerTaskDefend.m_aAttackerLayer = {}

protected

◆ m_aAttackerLayerNames

ref array<string> SCR_ScenarioFrameworkLayerTaskDefend.m_aAttackerLayerNames

protected

◆ m_aFactionSettings

ref array<ref SCR_ScenarioFrameworkTaskDefendFactionSettings> SCR_ScenarioFrameworkLayerTaskDefend.m_aFactionSettings

protected

◆ m_bDelayedEvaluation

bool SCR_ScenarioFrameworkLayerTaskDefend.m_bDelayedEvaluation

protected

◆ m_bDisplayCountdownHUD

bool SCR_ScenarioFrameworkLayerTaskDefend.m_bDisplayCountdownHUD

protected

◆ m_bDisplayDelayedEvaluationText

bool SCR_ScenarioFrameworkLayerTaskDefend.m_bDisplayDelayedEvaluationText

protected

◆ m_bEarlierEvaluation

bool SCR_ScenarioFrameworkLayerTaskDefend.m_bEarlierEvaluation

protected

◆ m_bEvaluationSet

bool SCR_ScenarioFrameworkLayerTaskDefend.m_bEvaluationSet

protected

◆ m_bTaskEvaluated

bool SCR_ScenarioFrameworkLayerTaskDefend.m_bTaskEvaluated

protected

◆ m_CharacterTriggerEntity

SCR_CharacterTriggerEntity SCR_ScenarioFrameworkLayerTaskDefend.m_CharacterTriggerEntity

protected

◆ m_fDefendTime

float SCR_ScenarioFrameworkLayerTaskDefend.m_fDefendTime

protected

◆ m_fEvaluateTimeEnd

WorldTimestamp SCR_ScenarioFrameworkLayerTaskDefend.m_fEvaluateTimeEnd

protected

◆ m_fEvaluateTimeStart

WorldTimestamp SCR_ScenarioFrameworkLayerTaskDefend.m_fEvaluateTimeStart

protected

◆ m_fMinDefenderPercentageRatio

float SCR_ScenarioFrameworkLayerTaskDefend.m_fMinDefenderPercentageRatio

protected

◆ m_fTempCountdown

float SCR_ScenarioFrameworkLayerTaskDefend.m_fTempCountdown = m_fDefendTime

protected

◆ m_fTempTimeSlice

float SCR_ScenarioFrameworkLayerTaskDefend.m_fTempTimeSlice

protected

◆ m_sCountdownHUD

ResourceName SCR_ScenarioFrameworkLayerTaskDefend.m_sCountdownHUD

protected

◆ m_sCountdownTitleText

LocalizedString SCR_ScenarioFrameworkLayerTaskDefend.m_sCountdownTitleText

protected

◆ m_sDelayedEvaluationText

LocalizedString SCR_ScenarioFrameworkLayerTaskDefend.m_sDelayedEvaluationText

protected

◆ m_sFormattedCountdownTitle

string SCR_ScenarioFrameworkLayerTaskDefend.m_sFormattedCountdownTitle = string.Format(WidgetManager.Translate("<color rgba=\"226, 168, 80, 255\">%1</color>", m_sCountdownTitleText))

protected

◆ m_sFormattedDelayedEvaluationText

string SCR_ScenarioFrameworkLayerTaskDefend.m_sFormattedDelayedEvaluationText = string.Format(WidgetManager.Translate("<color rgba=\"226, 168, 80, 255\">%1</color>", m_sDelayedEvaluationText))

protected

◆ m_sTriggerName

string SCR_ScenarioFrameworkLayerTaskDefend.m_sTriggerName

protected

◆ m_wCountdown

RichTextWidget SCR_ScenarioFrameworkLayerTaskDefend.m_wCountdown

protected

◆ m_wCountdownOverlay

Widget SCR_ScenarioFrameworkLayerTaskDefend.m_wCountdownOverlay

protected

◆ m_wFlavour

RichTextWidget SCR_ScenarioFrameworkLayerTaskDefend.m_wFlavour

protected

◆ m_wInfoOverlay

Widget SCR_ScenarioFrameworkLayerTaskDefend.m_wInfoOverlay

protected

◆ m_wRoot

Widget SCR_ScenarioFrameworkLayerTaskDefend.m_wRoot

protected

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

Game/ScenarioFramework/Components/SCR_ScenarioFrameworkLayerTaskDefend.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ SCR_ScenarioFrameworkLayerTaskDefend()

Member Function Documentation

◆ AfterAllChildrenSpawned()

◆ CheckAttackerLayers()

◆ CountAttackerDefenderNumbers()

◆ DynamicDespawn()

◆ EOnFrame()

◆ EvaluateStatus()

◆ FindCharacterTriggerEntity()

◆ GetCharacterTriggerEntity()

◆ GetDefendTime()

◆ InitHUD()

◆ OnPostInit()

◆ RemovePeriodicUpdates()

◆ RestoreToDefault()

◆ RpcDo_UpdateHUD()

◆ SetDefendTime()

◆ SetSupportEntity()

◆ SetupAttackerLayer()

◆ SetupEvaluation()

◆ UpdateHUD()

Member Data Documentation

◆ m_aAttackerLayer

◆ m_aAttackerLayerNames

◆ m_aFactionSettings

◆ m_bDelayedEvaluation

◆ m_bDisplayCountdownHUD

◆ m_bDisplayDelayedEvaluationText

◆ m_bEarlierEvaluation

◆ m_bEvaluationSet

◆ m_bTaskEvaluated

◆ m_CharacterTriggerEntity

◆ m_fDefendTime

◆ m_fEvaluateTimeEnd

◆ m_fEvaluateTimeStart

◆ m_fMinDefenderPercentageRatio

◆ m_fTempCountdown

◆ m_fTempTimeSlice

◆ m_sCountdownHUD

◆ m_sCountdownTitleText

◆ m_sDelayedEvaluationText

◆ m_sFormattedCountdownTitle

◆ m_sFormattedDelayedEvaluationText

◆ m_sTriggerName

◆ m_wCountdown

◆ m_wCountdownOverlay

◆ m_wFlavour

◆ m_wInfoOverlay

◆ m_wRoot