SCR_ScenarioFrameworkLayerTaskDefend.c File Reference

Go to the source code of this file.

Classes
class	SCR_ScenarioFrameworkLayerTaskDefendClass
class	SCR_ScenarioFrameworkTaskDefendFactionSettings
class	SCR_ScenarioFrameworkTaskDefendAttackingFactionTitle

Functions
SCR_ScenarioFrameworkLayerTaskDefendClass SCR_ScenarioFrameworkLayerTaskClass	Attribute (desc:"Will use trigger that is named for Defend params calculations", category:"Task")
float	GetDefendTime ()
void	SetDefendTime (float time)
SCR_CharacterTriggerEntity	GetCharacterTriggerEntity ()
void	FindCharacterTriggerEntity ()
	Finds character trigger entity by name.
void	CountAttackerDefenderNumbers (out int defenderCount, out int attackerCount)
void	EvaluateStatus ()
	Evaluates task status.
void	SetupAttackerLayer ()
	Sets up attacker layers from given names in the world.
void	SetupEvaluation ()
	Sets up evaluation time, triggers attacker layer, and checks for character trigger entities in scenario layers.
override void	RestoreToDefault (bool includeChildren=false, bool reinitAfterRestoration=false, bool affectRandomization=true, bool deleteSpawnedEntities=true)
override void	DynamicDespawn (SCR_ScenarioFrameworkLayerBase layer)
override void	AfterAllChildrenSpawned (SCR_ScenarioFrameworkLayerBase layer)
override void	OnPostInit (IEntity owner)
	Editable Mine.
void	InitHUD ()
	Initializes HUD layout, sets visibility of widgets, sets countdown time, and sets flavor text.
void	UpdateHUD ()
	Updates HUD based on task state, displays countdown or delayed evaluation text, hides HUD if task is cancelled.
void	RpcDo_UpdateHUD (float countdown)
void	CheckAttackerLayers ()
	Checks if attacker layers have repeated spawns, then iterates through spawned entities, checking if any character or group is alive or not.
void	RemovePeriodicUpdates ()
	Removes periodic updates and clears debug shapes during runtime if not shown.
override void	EOnFrame (IEntity owner, float timeSlice)
float	GetSecondsRemaining ()
void	SetSecondsRemaining (float seconds)
class SCR_ScenarioFrameworkTaskDefendFactionSettings	_WB_GetCustomTitle (BaseContainer source, out string title)
Faction	GetFaction ()
void	SetFactionKey (FactionKey factionKey)
bool	GetCountOnlyPlayers ()
SCR_ScenarioFrameworkTaskDefendAttackingFactionTitle BaseContainerCustomTitle	BaseContainerProps ()

Variables
UI layouts HUD CampaignMP CampaignMainHUD	layout
UI layouts HUD CampaignMP CampaignMainHUD	category
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
FactionKey	m_sFactionKey
bool	m_bCountOnlyPlayers

Function Documentation

_WB_GetCustomTitle()

class SCR_ScenarioFrameworkTaskDefendFactionSettings _WB_GetCustomTitle ( BaseContainer source, out string title )

protected

Defines custom title for defending faction.

Parameters

[in]	source	represents the container holding data.
[out]	title	Defending faction title represents the side being defended.

Returns

the custom title for the defending faction.

Sets custom title for attacking faction.

Parameters

[in]	source	Source represents the attacking faction's data container.
[out]	title	Faction title for attacking side.

Returns

the custom title for the attacking faction.

Definition at line 512 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

AfterAllChildrenSpawned()

override void AfterAllChildrenSpawned ( SCR_ScenarioFrameworkLayerBase layer )

protected

Initializes scenario, finds trigger entity, initializes HUD, sets up evaluation, and initializes post-init for owner.

Parameters

[in]

layer

that is to be used for this method

Definition at line 282 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

Attribute()

SCR_ScenarioFrameworkLayerTaskDefendClass SCR_ScenarioFrameworkLayerTaskClass Attribute	(	desc:"Will use trigger that is named for Defend params calculations"	,
		category:"Task"	)

Definition at line 1 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

BaseContainerProps()

SCR_ScenarioFrameworkTaskDefendAttackingFactionTitle BaseContainerCustomTitle BaseContainerProps ( )

protected

CheckAttackerLayers()

void CheckAttackerLayers ( )

protected

Checks if attacker layers have repeated spawns, then iterates through spawned entities, checking if any character or group is alive or not.

Definition at line 429 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

CountAttackerDefenderNumbers()

void CountAttackerDefenderNumbers ( out int defenderCount, out int attackerCount )

protected

Counts defenders and attackers inside trigger entity.

Parameters

[out]	defenderCount	DefenderCount represents the total number of defenders inside the trigger area.
[out]	attackerCount	Represents the total number of attackers inside the trigger entity's area.

Definition at line 109 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

DynamicDespawn()

override void DynamicDespawn ( SCR_ScenarioFrameworkLayerBase layer )

protected

Dynamic Despawn is disabled for Task Defend

Parameters

[in]

layer

Layer represents the scenario framework layer being dynamically despawned in the method.

Definition at line 275 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

EOnFrame()

override void EOnFrame ( IEntity owner, float timeSlice )

protected

Updates HUD, checks attacker layers based on time slice, evaluates status if not delayed evaluation.

Parameters

[in]	owner	The owner represents the entity (object) in the game world that this script is attached to, controlling its behavior.
[in]	timeSlice	represents the time interval for each frame update in the method.

Definition at line 475 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

EvaluateStatus()

void EvaluateStatus ( )

protected

Evaluates task status.

Definition at line 135 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

FindCharacterTriggerEntity()

void FindCharacterTriggerEntity ( )

protected

Finds character trigger entity by name.

Definition at line 88 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

GetCharacterTriggerEntity()

SCR_CharacterTriggerEntity GetCharacterTriggerEntity ( )

protected

Returns

Character trigger entity reference for character interaction.

Definition at line 81 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

GetCountOnlyPlayers()

bool _WB_GetCustomTitle::GetCountOnlyPlayers ( )

protected

Returns

Represents whether only players should be counted.

Definition at line 589 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

GetDefendTime()

float GetDefendTime ( )

protected

Returns

Represents time in seconds for defending an object or position.

Definition at line 67 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

GetFaction()

Faction _WB_GetCustomTitle::GetFaction ( )

protected

Returns

the Faction object associated with the provided key, or null if not found.

Definition at line 571 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

GetSecondsRemaining()

float GetSecondsRemaining ( )

protected

Definition at line 506 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

InitHUD()

void InitHUD ( )

protected

Initializes HUD layout, sets visibility of widgets, sets countdown time, and sets flavor text.

Definition at line 307 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

RemovePeriodicUpdates()

void RemovePeriodicUpdates ( )

protected

Removes periodic updates and clears debug shapes during runtime if not shown.

Definition at line 463 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

RestoreToDefault()

override void RestoreToDefault ( bool includeChildren = false, bool reinitAfterRestoration = false, bool affectRandomization = true, bool deleteSpawnedEntities = true )

protected

Restores default settings, clears attacker layer, nullifies entities, and calls superclass method.

Parameters

[in]	includeChildren	Restores default settings, optionally including children entities.
[in]	reinitAfterRestoration	Resets object state after restoration, optionally reinitializing it afterwards.
[in]	affectRandomization	Affects randomization parameters during restoration process.

Definition at line 254 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

RpcDo_UpdateHUD()

void RpcDo_UpdateHUD ( float countdown )

protected

Updates HUD with countdown or delayed evaluation text based on task state, displays countdown or title, hides or

Parameters

[in]

countdown

Countdown displays remaining time for active task in HUD.

Definition at line 389 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

SetDefendTime()

void SetDefendTime ( float time )

protected

Parameters

[in]

time

Defend time sets duration for defending.

Definition at line 74 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

SetFactionKey()

void _WB_GetCustomTitle::SetFactionKey ( FactionKey factionKey )

protected

Parameters

[in]

factionKey

Faction key is an identifier for a faction in the game

Definition at line 582 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

SetSecondsRemaining()

void SetSecondsRemaining ( float seconds )

protected

Definition at line 512 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

SetupAttackerLayer()

void SetupAttackerLayer ( )

protected

Sets up attacker layers from given names in the world.

Definition at line 196 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

SetupEvaluation()

void SetupEvaluation ( )

protected

Sets up evaluation time, triggers attacker layer, and checks for character trigger entities in scenario layers.

Definition at line 216 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

UpdateHUD()

void UpdateHUD ( )

protected

Updates HUD based on task state, displays countdown or delayed evaluation text, hides HUD if task is cancelled.

Definition at line 349 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

Variable Documentation

category

UI layouts HUD CampaignMP CampaignMainHUD category

Definition at line 20 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

layout

UI layouts HUD CampaignMP CampaignMainHUD layout

Definition at line 20 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_aAttackerLayer

ref array<SCR_ScenarioFrameworkLayerBase> m_aAttackerLayer = {}

protected

Definition at line 51 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_aAttackerLayerNames

ref array<string> m_aAttackerLayerNames

protected

Definition at line 30 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_aFactionSettings

ref array<ref SCR_ScenarioFrameworkTaskDefendFactionSettings> m_aFactionSettings

protected

Definition at line 24 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_bCountOnlyPlayers

bool m_bCountOnlyPlayers

protected

Definition at line 567 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_bDelayedEvaluation

bool m_bDelayedEvaluation

protected

Definition at line 36 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_bDisplayDelayedEvaluationText

bool m_bDisplayDelayedEvaluationText

protected

Definition at line 39 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_bEarlierEvaluation

bool m_bEarlierEvaluation

protected

Definition at line 33 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_bEvaluationSet

bool m_bEvaluationSet

protected

Definition at line 55 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_bTaskEvaluated

bool m_bTaskEvaluated

protected

Definition at line 54 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_CharacterTriggerEntity

SCR_CharacterTriggerEntity m_CharacterTriggerEntity

protected

Definition at line 44 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_fEvaluateTimeEnd

WorldTimestamp m_fEvaluateTimeEnd

protected

Definition at line 57 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_fEvaluateTimeStart

WorldTimestamp m_fEvaluateTimeStart

protected

Definition at line 56 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_fMinDefenderPercentageRatio

float m_fMinDefenderPercentageRatio

protected

Definition at line 27 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_fTempCountdown

float m_fTempCountdown = m_fDefendTime

protected

Definition at line 46 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_fTempTimeSlice

float m_fTempTimeSlice

protected

Definition at line 53 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_sDelayedEvaluationText

LocalizedString m_sDelayedEvaluationText

protected

Definition at line 42 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_sFactionKey

FactionKey m_sFactionKey

protected

Definition at line 564 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_sFormattedCountdownTitle

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

protected

Definition at line 48 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_sFormattedDelayedEvaluationText

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

protected

Definition at line 49 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_wCountdown

RichTextWidget m_wCountdown

protected

Definition at line 62 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_wCountdownOverlay

Widget m_wCountdownOverlay

protected

Definition at line 61 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_wFlavour

RichTextWidget m_wFlavour

protected

Definition at line 63 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_wInfoOverlay

Widget m_wInfoOverlay

protected

Definition at line 60 of file SCR_ScenarioFrameworkLayerTaskDefend.c.

m_wRoot

Widget m_wRoot

protected

Definition at line 59 of file SCR_ScenarioFrameworkLayerTaskDefend.c.