Service providing group of defenders defined in faction. Requires SCR_EnableDefenderAction on ActionManager for players to manage its functionality. More...

Inheritance diagram for SCR_DefenderSpawnerComponent:

Protected Member Functions
SCR_ECharacterRank	GetMinimumRank ()
bool	UserRankCheck (IEntity user)
OnDefenderGroupSpawnedInvoker	GetOnDefenderGroupSpawned ()
void	SetWaypoint (SCR_AIWaypoint wp)
void	AssignDefenderGroupDataFromOwningFaction ()
	Set Defender group data from Entity catalog on owning faction.
void	AssignSupplyComponent (notnull SCR_CampaignSuppliesComponent supplyComp)
SCR_CampaignSuppliesComponent	GetSpawnerSupplyComponent ()
float	GetSpawnerSupplies ()
	Get available supplies.
void	AddSupplies (float value)
bool	IsSpawningEnabled ()
	Returns true if spawner is currently activated.
void	EnableSpawning (bool enable, int playerID)
bool	IsProxy ()
void	SpawnUnit (ResourceName unitResource, bool consumeSupplies=true)
void	OnMovingCharacterDeath (SCR_CharacterControllerComponent characterController, IEntity killerEntity, Instigator killer)
void	OnMoveFinished (SCR_AIActionBase action)
SCR_EntitySpawnerSlotComponent	GetFreeSlot ()
void	ReinforceGroup ()
	Refills AI's in defender group.
void	SpawnGroup ()
AIWaypoint	GetWaypoint ()
SCR_EDefenderSpawnerState	GetPlayerDistanceState ()
void	HandleGroup ()
	Manages automatic group spawning.
override void	OnFactionChanged (FactionAffiliationComponent owner, Faction previousFaction, Faction faction)
override void	EOnInit (IEntity owner)
override void	OnPostInit (IEntity owner)
void	~SCR_DefenderSpawnerComponent ()

Protected Attributes
ref array< EEditableEntityLabel >	m_aAllowedLabels
ref array< EEditableEntityLabel >	m_aIgnoredLabels
float	m_fRespawnDelay
bool	m_bEnableSpawning
float	m_fMinHostilePlayerDistance
bool	m_bSuppliesConsumptionEnabled
int	m_iCustomSupplies
SCR_ECharacterRank	m_eMinimumRankForEnabling
RplComponent	m_RplComponent
SCR_CampaignSuppliesComponent	m_SupplyComponent
SCR_ResourceComponent	m_ResourceComponent
SCR_SpawnerAIGroupManagerComponent	m_GroupSpawningManager
WorldTimestamp	m_fNextRespawnTime
SCR_EntityCatalogEntry	m_GroupEntry
SCR_AIGroup	m_AIgroup
AIWaypoint	m_Waypoint
int	m_iDespawnedGroupMembers
ref array< ref Tuple3< SCR_AIActionBase, AIAgent, WorldTimestamp > >	m_aUnitsOnMove = {}
ref array< ResourceName >	m_aRefillQueue
ref array< SCR_AIGroup >	m_aPreviousGroups
ref array< IEntity >	m_aOldUnits
ref OnDefenderGroupSpawnedInvoker	m_OnDefenderGroupSpawned

Static Protected Attributes
static const int	SPAWN_CHECK_INTERVAL = 1000
static const int	SPAWN_GROUP_JOIN_TIMEOUT = 20
static const int	SPAWN_RADIUS_MIN = Math.Pow(500, 2)
static const int	SPAWN_RADIUS_MAX = Math.Pow(1000, 2)

Detailed Description

Service providing group of defenders defined in faction. Requires SCR_EnableDefenderAction on ActionManager for players to manage its functionality.

Definition at line 40 of file SCR_DefenderSpawnerComponent.c.

Constructor & Destructor Documentation

◆ ~SCR_DefenderSpawnerComponent()

void SCR_DefenderSpawnerComponent::~SCR_DefenderSpawnerComponent ( )

inlineprotected

Definition at line 825 of file SCR_DefenderSpawnerComponent.c.

Member Function Documentation

◆ AddSupplies()

void SCR_DefenderSpawnerComponent::AddSupplies ( float value )

inlineprotected

Set the spawner supplies value

Parameters

[in] value

Definition at line 193 of file SCR_DefenderSpawnerComponent.c.

◆ AssignDefenderGroupDataFromOwningFaction()

void SCR_DefenderSpawnerComponent::AssignDefenderGroupDataFromOwningFaction ( )

inlineprotected

Set Defender group data from Entity catalog on owning faction.

Definition at line 130 of file SCR_DefenderSpawnerComponent.c.

◆ AssignSupplyComponent()

void SCR_DefenderSpawnerComponent::AssignSupplyComponent ( notnull SCR_CampaignSuppliesComponent supplyComp )

inlineprotected

Assign supply component to handle supplies of spawner. Currently uses Campaign specific supplies (temporarily)

Parameters

[in] supplyComp

Definition at line 157 of file SCR_DefenderSpawnerComponent.c.

◆ EnableSpawning()

void SCR_DefenderSpawnerComponent::EnableSpawning	(	bool	enable,
		int	playerID )

inlineprotected

Enable spawning of defender groups

Parameters

[in]	enable	bool to enable or disable spawning
[in]	playerID	id of player using this action

Definition at line 241 of file SCR_DefenderSpawnerComponent.c.

◆ EOnInit()

override void SCR_DefenderSpawnerComponent::EOnInit ( IEntity owner )

inlineprotected

Definition at line 782 of file SCR_DefenderSpawnerComponent.c.

◆ GetFreeSlot()

SCR_EntitySpawnerSlotComponent SCR_DefenderSpawnerComponent::GetFreeSlot ( )

inlineprotected

Returns: free slot or null if not found

Definition at line 450 of file SCR_DefenderSpawnerComponent.c.

◆ GetMinimumRank()

SCR_ECharacterRank SCR_DefenderSpawnerComponent::GetMinimumRank ( )

inlineprotected

Returns

Definition at line 89 of file SCR_DefenderSpawnerComponent.c.

◆ GetOnDefenderGroupSpawned()

OnDefenderGroupSpawnedInvoker SCR_DefenderSpawnerComponent::GetOnDefenderGroupSpawned ( )

inlineprotected

Returns

Definition at line 111 of file SCR_DefenderSpawnerComponent.c.

◆ GetPlayerDistanceState()

SCR_EDefenderSpawnerState SCR_DefenderSpawnerComponent::GetPlayerDistanceState ( )

inlineprotected

Returns: state according to current players vicinities to DefenderSpawner

Definition at line 600 of file SCR_DefenderSpawnerComponent.c.

◆ GetSpawnerSupplies()

float SCR_DefenderSpawnerComponent::GetSpawnerSupplies ( )

inlineprotected

Get available supplies.

Definition at line 174 of file SCR_DefenderSpawnerComponent.c.

◆ GetSpawnerSupplyComponent()

SCR_CampaignSuppliesComponent SCR_DefenderSpawnerComponent::GetSpawnerSupplyComponent ( )

inlineprotected

Returns: supply component assigned to spawner, temporary

Definition at line 167 of file SCR_DefenderSpawnerComponent.c.

◆ GetWaypoint()

AIWaypoint SCR_DefenderSpawnerComponent::GetWaypoint ( )

inlineprotected

Definition at line 562 of file SCR_DefenderSpawnerComponent.c.

◆ HandleGroup()

void SCR_DefenderSpawnerComponent::HandleGroup ( )

inlineprotected

Manages automatic group spawning.

Definition at line 648 of file SCR_DefenderSpawnerComponent.c.

◆ IsProxy()

bool SCR_DefenderSpawnerComponent::IsProxy ( )

inlineprotected

Returns

Definition at line 260 of file SCR_DefenderSpawnerComponent.c.

◆ IsSpawningEnabled()

bool SCR_DefenderSpawnerComponent::IsSpawningEnabled ( )

inlineprotected

Returns true if spawner is currently activated.

Definition at line 232 of file SCR_DefenderSpawnerComponent.c.

◆ OnFactionChanged()

override void SCR_DefenderSpawnerComponent::OnFactionChanged	(	FactionAffiliationComponent	owner,
		Faction	previousFaction,
		Faction	faction )

inlineprotected

Definition at line 765 of file SCR_DefenderSpawnerComponent.c.

◆ OnMoveFinished()

void SCR_DefenderSpawnerComponent::OnMoveFinished ( SCR_AIActionBase action )

inlineprotected

Definition at line 401 of file SCR_DefenderSpawnerComponent.c.

◆ OnMovingCharacterDeath()

void SCR_DefenderSpawnerComponent::OnMovingCharacterDeath	(	SCR_CharacterControllerComponent	characterController,
		IEntity	killerEntity,
		Instigator	killer )

inlineprotected

Definition at line 378 of file SCR_DefenderSpawnerComponent.c.

◆ OnPostInit()

override void SCR_DefenderSpawnerComponent::OnPostInit ( IEntity owner )

inlineprotected

Definition at line 813 of file SCR_DefenderSpawnerComponent.c.

◆ ReinforceGroup()

void SCR_DefenderSpawnerComponent::ReinforceGroup ( )

inlineprotected

Refills AI's in defender group.

Definition at line 469 of file SCR_DefenderSpawnerComponent.c.

◆ SetWaypoint()

void SCR_DefenderSpawnerComponent::SetWaypoint ( SCR_AIWaypoint wp )

inlineprotected

Assign custom waypoint to be used by defender group

Parameters

[in] wp

Definition at line 122 of file SCR_DefenderSpawnerComponent.c.

◆ SpawnGroup()

void SCR_DefenderSpawnerComponent::SpawnGroup ( )

inlineprotected

Spawn defender AI group from faction prefab. Also handles price per spawned unit. Should some units be despawned because of player distance, spawn price will be reduced by it

Definition at line 516 of file SCR_DefenderSpawnerComponent.c.

◆ SpawnUnit()

void SCR_DefenderSpawnerComponent::SpawnUnit	(	ResourceName	unitResource,
		bool	consumeSupplies = true )

inlineprotected

Spawn Units with given ResourceName and assign it to group

Parameters

[in]	unitResource	resource name of unit to be spawned
[in]	consumeSupplies	if false, spawning this unit won't consume supplies. Is used for respawning units, which were previously despawned to save performance

Definition at line 269 of file SCR_DefenderSpawnerComponent.c.