Classes
class	SCR_ScenarioFrameworkSlotTaskAIClass

Functions
SCR_ScenarioFrameworkSlotTaskAIClass SCR_ScenarioFrameworkSlotTaskClass	Attribute (desc:"Waypoint Groups if applicable", category:"Waypoints")
void	SetAIPrefabsForRemoval (array< ResourceName > arrayForRemoval)
array< ResourceName >	GetAIPrefabsForRemoval ()
override void	RestoreToDefault (bool includeChildren=false, bool reinitAfterRestoration=false, bool affectRandomization=true, bool deleteSpawnedEntities=true)
override void	DynamicDespawn (SCR_ScenarioFrameworkLayerBase layer)
void	OnAgentCompartmentEntered (AIAgent agent, IEntity targetEntity, BaseCompartmentManagerComponent manager, int mgrID, int slotID, bool move)
void	OnAgentCompartmentLeft (AIAgent agent, IEntity targetEntity, BaseCompartmentManagerComponent manager, int mgrID, int slotID, bool move)
override bool	InitOtherThings ()
override void	AfterAllChildrenSpawned (SCR_ScenarioFrameworkLayerBase layer)
void	AfterAllAgentsSpawned ()
	Initializes plugins, actions, and checks for parent layer spawn completion, then sets waypoints for AI if not initialized.
void	ActivateAI ()
	Activates AI group, removes unwanted prefabs, balances units count, sets on agent remove and add events,.
void	OnAgentAdded (AIAgent child)
void	InitGroupComponents ()
	Initializes AI group components, sets formation, and combat parameters for agents in the group.
void	InitWaypoints ()
	Initializes waypoints by finding them in specified layers, adding them to list, and processing them after initialization.
void	CheckWaypointsAfterInit (SCR_ScenarioFrameworkLayerBase layer)
void	ProcessWaypoints (SCR_ScenarioFrameworkLayerBase layer)
void	SetWaypointToAI (SCR_ScenarioFrameworkLayerBase layer)
AIWaypoint	CreateDefaultWaypoint ()
void	DecreaseAIGroupMemberCount (SCR_AIGroup group, AIAgent agent)
bool	CreateAIGroup ()

Variables
Prefabs AI Waypoints AIWaypoint_Defend	et
Prefabs AI Waypoints AIWaypoint_Defend	category
bool	m_bBalanceOnPlayersCount
int	m_iMinUnitsInGroup
bool	m_bExcludeFromDynamicDespawnOnVehicleEntered
SCR_EAIGroupFormation	m_eAIGroupFormation
EAISkill	m_eAISkill
float	m_fPerceptionFactor
ResourceName	m_sGroupPrefab
ref array< AIWaypoint >	m_aWaypoints = {}
SCR_AIGroup	m_AIGroup
ref array< ResourceName >	m_aAIPrefabsForRemoval = {}
ref array< SCR_ScenarioFrameworkSlotWaypoint >	m_aSlotWaypoints = {}
int	m_iCurrentlySpawnedWaypoints
bool	m_bWaypointsInitialized
bool	m_bGroupWasNull

Function Documentation

◆ AfterAllAgentsSpawned()

void AfterAllAgentsSpawned ( )

protected

Initializes plugins, actions, and checks for parent layer spawn completion, then sets waypoints for AI if not initialized.

Definition at line 192 of file SCR_ScenarioFrameworkSlotTaskAI.c.

◆ AfterAllChildrenSpawned()

override void AfterAllChildrenSpawned ( SCR_ScenarioFrameworkLayerBase layer )

protected

Initializes AI after all children spawned, removes event handler.

Parameters

[in] layer for which this is called

Definition at line 178 of file SCR_ScenarioFrameworkSlotTaskAI.c.

◆ Attribute()

SCR_ScenarioFrameworkSlotTaskAIClass SCR_ScenarioFrameworkSlotTaskClass Attribute	(	desc:"Waypoint Groups if applicable"	,
		category:"Waypoints"	)

Definition at line 1 of file SCR_ScenarioFrameworkSlotTaskAI.c.

◆ CheckWaypointsAfterInit()

void CheckWaypointsAfterInit ( SCR_ScenarioFrameworkLayerBase layer )

protected

Checks waypoints after init, adds/removes event handler for all waypoints spawned, increments spawned way

Parameters

[in] layer for which this is called

Definition at line 447 of file SCR_ScenarioFrameworkSlotTaskAI.c.

◆ CreateAIGroup()

bool CreateAIGroup ( )

protected

Creates an AI group, sets its faction, adds entity to group, and optionally sets entity's position.

Returns: true if AI group creation is successful, false otherwise.

Definition at line 645 of file SCR_ScenarioFrameworkSlotTaskAI.c.

◆ CreateDefaultWaypoint()

AIWaypoint CreateDefaultWaypoint ( )

protected

Creates default waypoint for AI entity, spawns it in world space, adds it to list.

Returns: an AIWaypoint object if successful, otherwise null.

Definition at line 583 of file SCR_ScenarioFrameworkSlotTaskAI.c.

◆ DecreaseAIGroupMemberCount()

void DecreaseAIGroupMemberCount	(	SCR_AIGroup	group,
		AIAgent	agent )

protected

Decreases AI group member count, handles termination if group empty, adds removed AI entity prefab to removal list.

Parameters

[in]	group	Decreases AI group member count, checks for termination conditions, adds removed AI entity prefab to removal list.
[in]	agent	Agent represents an AI entity in the game world, controlled by AI group, which is decreased from the group count in this

Definition at line 608 of file SCR_ScenarioFrameworkSlotTaskAI.c.

◆ DynamicDespawn()

override void DynamicDespawn ( SCR_ScenarioFrameworkLayerBase layer )

Dynamically despawns this layer.

Parameters

[in] layer Layer represents the scenario framework layer for dynamic despawning entities in the method.

Definition at line 83 of file SCR_ScenarioFrameworkSlotTaskAI.c.

◆ GetAIPrefabsForRemoval()

array< ResourceName > GetAIPrefabsForRemoval ( )

Returns: Array of AI prefab names for removal.

Definition at line 58 of file SCR_ScenarioFrameworkSlotTaskAI.c.

◆ InitGroupComponents()

void InitGroupComponents ( )

protected

Initializes AI group components, sets formation, and combat parameters for agents in the group.

Definition at line 292 of file SCR_ScenarioFrameworkSlotTaskAI.c.

◆ InitOtherThings()

override bool InitOtherThings ( )

protected

Clears cached values and handles Waypoint Sets

Returns: true if all initialization steps succeed, false otherwise.

Definition at line 161 of file SCR_ScenarioFrameworkSlotTaskAI.c.

◆ InitWaypoints()

void InitWaypoints ( )

protected

Initializes waypoints by finding them in specified layers, adding them to list, and processing them after initialization.

Definition at line 390 of file SCR_ScenarioFrameworkSlotTaskAI.c.

◆ OnAgentCompartmentEntered()

void OnAgentCompartmentEntered	(	AIAgent	agent,
		IEntity	targetEntity,
		BaseCompartmentManagerComponent	manager,
		int	mgrID,
		int	slotID,
		bool	move )

protected

Definition at line 120 of file SCR_ScenarioFrameworkSlotTaskAI.c.

◆ OnAgentCompartmentLeft()

void OnAgentCompartmentLeft	(	AIAgent	agent,
		IEntity	targetEntity,
		BaseCompartmentManagerComponent	manager,
		int	mgrID,
		int	slotID,
		bool	move )

protected

Definition at line 132 of file SCR_ScenarioFrameworkSlotTaskAI.c.

◆ ProcessWaypoints()

void ProcessWaypoints ( SCR_ScenarioFrameworkLayerBase layer )

protected

Initializes waypoints for AI if scenario is initiated, otherwise waits for all children to spawn before setting waypoints.

Parameters

[in] layer for which this is called

Definition at line 477 of file SCR_ScenarioFrameworkSlotTaskAI.c.

◆ RestoreToDefault()

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

Restores default settings, clears waypoints, AI group, prefabs, slots, and initializes randomization.

Parameters

[in]	includeChildren	Includes restoring default settings for child objects as well.
[in]	reinitAfterRestoration	Resets object state after restoration, allowing for fresh initialization.
[in]	affectRandomization	Affects whether randomization is reset during default restoration.

Definition at line 68 of file SCR_ScenarioFrameworkSlotTaskAI.c.