Classes
class	SCR_CampaignBuildingProviderComponentClass

Functions
SCR_CampaignBuildingProviderComponentClass SCR_MilitaryBaseLogicComponentClass	Attribute ("", UIWidgets.EditBox, "Name of provider shown in provider interface", "")] protected string m_sProviderDisplayName
void	UpdateCooldownTimer ()
	Periodically called method to evaluate a current status of the cooldown.
bool	HasCooldownSet (int playerId)
	Is placing allowed for this player?
float	GetCooldownValue (int playerId)
	Return current value of the cooldown time for a given player.
ScriptInvokerVoid	GetOnCooldownLockUpdated ()
override void	RegisterBase (notnull SCR_MilitaryBaseComponent base)
bool	CanRegisterAtMilitaryBase ()
SCR_MilitaryBaseComponent	GetMilitaryBaseComponent ()
SCR_CampaignMilitaryBaseComponent	GetCampaignMilitaryBaseComponent ()
SCR_ECharacterRank	GetAccessRank ()
float	GetBuildingRadius ()
int	GetMaxBudgetValue (EEditableEntityBudget budget)
	Return max value of the given budget if this budget is added to be evaluated with this provider and has max value set.
int	GetMaxBudgetValueFromMasterIfNeeded (EEditableEntityBudget budget)
	Return max value of the given budget if this budget is added to be evaluated with this provider and has max value set.
int	GetCurrentPropValue ()
void	SetPropValue (int value)
void	AddPropValue (int value)
int	GetCurrentAIValue ()
void	SetAIValue (int value)
void	AddAIValue (int value)
void	OnAIRemoved (IEntity ent)
	An event called when AI spawned by this provider is killed or deleted.
void	SetOnEntityKilled (IEntity ent)
	Set an event called when entity spawned by this provider get killed.
void	RemoveEvents (IEntity ent)
	remove all methods invoked to entity and related to it's dead or delete.
array< EEditableEntityLabel >	GetAvailableTraits ()
override void	OnPostInit (IEntity owner)
	Editable Mine.
override void	EOnInit (IEntity owner)
void	AddNewActiveUser (int userID)
void	RemoveActiveUser (int userID)
int	GetActiveUsers (out notnull array< int > users)
bool	ContainActiveUsers (int playerId)
void	AddNewAvailableUser (int userID)
void	RemoveAvailableUser (int userID)
int	GetAvailableUsers (out array< int > users)
bool	ContainAvailableUsers (int playerId)
void	RequestEnterBuildingMode (int playerID, bool userActionUsed, bool useAllAvailableProviders=false)
void	SetOnPlayerTeleported (int playerID)
void	SetOnPlayerConsciousnessChanged ()
	Set even when player consciousness changed.
void	OnLifeStateChanged (ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState)
void	PlayerTeleported (SCR_EditableCharacterComponent character, bool isLongFade, SCR_EPlayerTeleportedReason teleportReason)
void	RemoveOnLifeStateChanged ()
void	SetOnProviderFactionChangedEvent ()
	Insert a method called when the provider faction is changed, e.g a base is taken by an enemy.
void	SetOnPlayerDeathActiveUserEvent (int userID)
void	SetOnPlayerDeathAvailableUserEvent (int userID)
void	OnActiveUserDeath (SCR_CharacterControllerComponent characterControllerComponent, IEntity instigatorEntity, notnull Instigator instigator)
void	OnAvailableUserDeath (SCR_CharacterControllerComponent characterControllerComponent, IEntity instigatorEntity, notnull Instigator instigator)
void	BuildingModeCreated ()
void	EntitySpawnedByProvider (int prefabID, SCR_EditableEntityComponent editableEntity)
	Event rised when the entity is spawned by this provider.
void	OnModeClosed ()
void	RemoveOnModeClosed ()
void	RemoveOnPlayerTeleported ()
bool	GetUserActionInitOnly ()
bool	CanBeUsedByAnyFaction ()
SCR_CampaignBuildingNetworkComponent	GetNetworkManager ()
SCR_EditorManagerEntity	GetEditorManager ()
SCR_EditorManagerEntity	GetEditorManagerByID (int playerId)
SCR_CharacterControllerComponent	GetCharacterControllerComponent (int playerID)
int	GetPlayerIdFromCharacterController (SCR_CharacterControllerComponent characterControllerComponent)
bool	IsEntityFactionSame (notnull IEntity ent1, notnull IEntity ent2)
Faction	GetEntityFaction (notnull IEntity ent)
void	OnBaseOwnerChanged (FactionAffiliationComponent owner, Faction previousFaction, Faction newFaction)
SCR_ResourceComponent	GetResourceComponent ()
	Caches and returns the resource component.
SCR_CampaignSuppliesComponent	GetSuppliesComponent ()
SCR_CampaignBuildingBudgetToEvaluateData	GetBudgetData (EEditableEntityBudget budget)
	Get data of given budget.
int	GetBudgetTypesToEvaluate (notnull out array< ref EEditableEntityBudget > budgets)
	Returns all budget types to evaluate with this provider.
bool	IsBudgetToEvaluate (EEditableEntityBudget blockingBudget)
EEditableEntityBudget	GetShownBudget ()
	Evaluate all set budgets with this provider and return first one that is marked as to be shown in UI.
int	CalculateCooldownTime (int playerId, int cooldownTime)
	Checks the budget setting and calculate final cooldown time based on it.
void	RemoveActiveUsers ()
	Method called when the provider was destroyed or deleted to remove a provider.
void	RemoveCheckProviderMove ()
void	SetCheckProviderMove ()

Variables
bool	m_bUserActionActivationOnly
bool	m_bAnyFactionCanUse
bool	m_bIsMasterProvider
bool	m_bUseMasterProvider
bool	m_bUseAllAvailableProviders
bool	m_bRegisterAtBase
bool	m_bCanCommandAI
bool	m_bObstructViewWhenEnemyInRange
float	m_fBuildingRadius
SCR_ECharacterRank	m_iRank
ref array< ref SCR_CampaignBuildingBudgetToEvaluateData >	m_aBudgetsToEvaluate
ref array< EEditableEntityLabel >	m_aAvailableTraits
int	m_iCurrentPropValue
	Current props Value represents, how many entities with set prop budget can be spawned with this provider. The max number is limited by Prop budget.
int	m_iCurrentAIValue
	Current AI Value represents, how many AI is currently spawned with this provider. The max number is limited by AI budget.
SCR_ResourceComponent	m_ResourceComponent
ref array< int >	m_aActiveUsersIDs = {}
ref array< int >	m_aAvailableUsersIDs = {}
ref array< SCR_CampaignBuildingBudgetToEvaluateData >	m_aShownBudget = {}
ref ScriptInvokerVoid	m_OnCooldownLockUpdated
const int	MOVING_CHECK_PERIOD = 1000
const int	PROVIDER_SPEED_TO_REMOVE_BUILDING_SQ = 1
ref array< ref Tuple2< int, WorldTimestamp > >	m_aPlacingCooldown = {}
bool	m_bCooldownClientLock
bool	m_bUseAllAvailableProvidersByPlayer
SCR_CampaignBuildingProviderComponent	m_MasterProviderComponent

Function Documentation

◆ AddAIValue()

void AddAIValue ( int value )

protected

Definition at line 601 of file SCR_CampaignBuildingProviderComponent.c.

◆ AddNewActiveUser()

void AddNewActiveUser ( int userID )

protected

Add an ID of a user on the list of those who are currently in use of provider

Parameters

[in] userID

Definition at line 754 of file SCR_CampaignBuildingProviderComponent.c.

◆ AddNewAvailableUser()

void AddNewAvailableUser ( int userID )

protected

Parameters

[in] userID

Definition at line 788 of file SCR_CampaignBuildingProviderComponent.c.

◆ AddPropValue()

void AddPropValue ( int value )

protected

Parameters

[in] value

Definition at line 564 of file SCR_CampaignBuildingProviderComponent.c.

◆ Attribute()

SCR_CampaignBuildingProviderComponentClass SCR_MilitaryBaseLogicComponentClass Attribute	(	""	,
		UIWidgets.	EditBox,
		"Name of provider shown in provider interface"	,
		""	)

◆ BuildingModeCreated()

void BuildingModeCreated ( )

protected

Definition at line 964 of file SCR_CampaignBuildingProviderComponent.c.

◆ CalculateCooldownTime()

int CalculateCooldownTime	(	int	playerId,
		int	cooldownTime )

protected

Checks the budget setting and calculate final cooldown time based on it.

Definition at line 1247 of file SCR_CampaignBuildingProviderComponent.c.

◆ CanBeUsedByAnyFaction()

bool CanBeUsedByAnyFaction ( )

protected

Returns

Definition at line 1057 of file SCR_CampaignBuildingProviderComponent.c.

◆ CanRegisterAtMilitaryBase()

bool CanRegisterAtMilitaryBase ( )

protected

Returns: if the provider can be registered at base or not.

Definition at line 453 of file SCR_CampaignBuildingProviderComponent.c.

◆ ContainActiveUsers()

bool ContainActiveUsers ( int playerId )

protected

Parameters

[in] playerId

Returns

Definition at line 780 of file SCR_CampaignBuildingProviderComponent.c.

◆ ContainAvailableUsers()

bool ContainAvailableUsers ( int playerId )

protected

Parameters

[in] playerId

Returns

Definition at line 814 of file SCR_CampaignBuildingProviderComponent.c.

◆ EntitySpawnedByProvider()

void EntitySpawnedByProvider	(	int	prefabID,
		SCR_EditableEntityComponent	editableEntity )

protected

Event rised when the entity is spawned by this provider.

Definition at line 985 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetAccessRank()

SCR_ECharacterRank GetAccessRank ( )

protected

Returns

Definition at line 491 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetActiveUsers()

int GetActiveUsers ( out notnull array< int > users )

protected

Return the array of users id and it's count.

Parameters

[out] users

Definition at line 771 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetAvailableTraits()

array< EEditableEntityLabel > GetAvailableTraits ( )

protected

Definition at line 646 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetAvailableUsers()

int GetAvailableUsers ( out array< int > users )

protected

Parameters

[out] users

Returns

Definition at line 805 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetBudgetData()

SCR_CampaignBuildingBudgetToEvaluateData GetBudgetData ( EEditableEntityBudget budget )

protected

Get data of given budget.

Definition at line 1189 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetBudgetTypesToEvaluate()

int GetBudgetTypesToEvaluate ( notnull out array< ref EEditableEntityBudget > budgets )

protected

Returns all budget types to evaluate with this provider.

Definition at line 1202 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetBuildingRadius()

float GetBuildingRadius ( )

protected

Returns

Definition at line 498 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetCampaignMilitaryBaseComponent()

SCR_CampaignMilitaryBaseComponent GetCampaignMilitaryBaseComponent ( )

protected

Returns: a Campaign military base component of the base this provider is registered to.

Definition at line 473 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetCharacterControllerComponent()

SCR_CharacterControllerComponent GetCharacterControllerComponent ( int playerID )

protected

Definition at line 1096 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetCooldownValue()

float GetCooldownValue ( int playerId )

protected

Return current value of the cooldown time for a given player.

Definition at line 415 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetCurrentAIValue()

int GetCurrentAIValue ( )

protected

Definition at line 577 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetCurrentPropValue()

int GetCurrentPropValue ( )

protected

Returns

Definition at line 542 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetEditorManager()

SCR_EditorManagerEntity GetEditorManager ( )

protected

Returns: local Editor Manager

Definition at line 1075 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetEditorManagerByID()

SCR_EditorManagerEntity GetEditorManagerByID ( int playerId )

protected

Returns: Editor manager by player ID

Definition at line 1086 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetEntityFaction()

Faction GetEntityFaction ( notnull IEntity ent )

protected

Definition at line 1136 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetMaxBudgetValue()

int GetMaxBudgetValue ( EEditableEntityBudget budget )

protected

Return max value of the given budget if this budget is added to be evaluated with this provider and has max value set.

Definition at line 505 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetMaxBudgetValueFromMasterIfNeeded()

int GetMaxBudgetValueFromMasterIfNeeded ( EEditableEntityBudget budget )

protected

Return max value of the given budget if this budget is added to be evaluated with this provider and has max value set.

Definition at line 520 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetMilitaryBaseComponent()

SCR_MilitaryBaseComponent GetMilitaryBaseComponent ( )

protected

Returns: a military base component of the base this provider is registered to. If is registered to more than one, it returns the first one.

Definition at line 460 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetNetworkManager()

SCR_CampaignBuildingNetworkComponent GetNetworkManager ( )

protected

Returns: Network Manager

Definition at line 1064 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetOnCooldownLockUpdated()

ScriptInvokerVoid GetOnCooldownLockUpdated ( )

protected

Definition at line 434 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetPlayerIdFromCharacterController()

int GetPlayerIdFromCharacterController ( SCR_CharacterControllerComponent characterControllerComponent )

protected

Definition at line 1106 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetResourceComponent()

SCR_ResourceComponent GetResourceComponent ( )

protected

Caches and returns the resource component.

Definition at line 1171 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetShownBudget()

EEditableEntityBudget GetShownBudget ( )

protected

Evaluate all set budgets with this provider and return first one that is marked as to be shown in UI.

Definition at line 1231 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetSuppliesComponent()

SCR_CampaignSuppliesComponent GetSuppliesComponent ( )

protected

Returns: provider supply component - obsolete

Definition at line 1182 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetUserActionInitOnly()

bool GetUserActionInitOnly ( )

protected

Returns

Definition at line 1050 of file SCR_CampaignBuildingProviderComponent.c.

◆ HasCooldownSet()

bool HasCooldownSet ( int playerId )

protected

Is placing allowed for this player?

Definition at line 408 of file SCR_CampaignBuildingProviderComponent.c.

◆ IsBudgetToEvaluate()

bool IsBudgetToEvaluate ( EEditableEntityBudget blockingBudget )

protected

Parameters

[in] blockingBudget

Returns: whether or not this budget is suppose to be taken into account with this provider.

Definition at line 1215 of file SCR_CampaignBuildingProviderComponent.c.

◆ IsEntityFactionSame()

bool IsEntityFactionSame	(	notnull IEntity	ent1,
		notnull IEntity	ent2 )

protected

Does entity faction one match faction of entity two.

Parameters

[in] entity

Returns

Definition at line 1122 of file SCR_CampaignBuildingProviderComponent.c.

◆ OnActiveUserDeath()

void OnActiveUserDeath	(	SCR_CharacterControllerComponent	characterControllerComponent,
		IEntity	instigatorEntity,
		notnull Instigator	instigator )

protected

Parameters

[in]	characterControllerComponent
[in]	instigatorEntity
[in]	instigator

Definition at line 948 of file SCR_CampaignBuildingProviderComponent.c.

◆ OnAIRemoved()

void OnAIRemoved ( IEntity ent )

protected

An event called when AI spawned by this provider is killed or deleted.

Definition at line 615 of file SCR_CampaignBuildingProviderComponent.c.

◆ OnAvailableUserDeath()

void OnAvailableUserDeath	(	SCR_CharacterControllerComponent	characterControllerComponent,
		IEntity	instigatorEntity,
		notnull Instigator	instigator )

protected

Parameters

[in]	characterControllerComponent
[in]	instigatorEntity
[in]	instigator

Definition at line 957 of file SCR_CampaignBuildingProviderComponent.c.

◆ OnBaseOwnerChanged()

void OnBaseOwnerChanged	(	FactionAffiliationComponent	owner,
		Faction	previousFaction,
		Faction	newFaction )

protected

Method triggered when owning faction of provider has changed.

Parameters

[in]	owner
[in]	previousFaction
[in]	newFaction

Definition at line 1163 of file SCR_CampaignBuildingProviderComponent.c.

◆ OnLifeStateChanged()

void OnLifeStateChanged	(	ECharacterLifeState	previousLifeState,
		ECharacterLifeState	newLifeState )

protected

Parameters

[in] conscious

Definition at line 871 of file SCR_CampaignBuildingProviderComponent.c.

◆ OnModeClosed()

void OnModeClosed ( )

protected

Definition at line 1000 of file SCR_CampaignBuildingProviderComponent.c.

◆ PlayerTeleported()

void PlayerTeleported	(	SCR_EditableCharacterComponent	character,
		bool	isLongFade,
		SCR_EPlayerTeleportedReason	teleportReason )

protected

Parameters

[in]	character
[in]	isLongFade
[in]	teleportReason

Definition at line 888 of file SCR_CampaignBuildingProviderComponent.c.

◆ RegisterBase()

override void RegisterBase ( notnull SCR_MilitaryBaseComponent base )

protected

Definition at line 443 of file SCR_CampaignBuildingProviderComponent.c.

◆ RemoveActiveUser()

void RemoveActiveUser ( int userID )

protected

Remove an ID of a user from the list of those who are currently in use of provider

Parameters

[in] userID

Definition at line 763 of file SCR_CampaignBuildingProviderComponent.c.

◆ RemoveActiveUsers()

void RemoveActiveUsers ( )

protected

Method called when the provider was destroyed or deleted to remove a provider.

Definition at line 1268 of file SCR_CampaignBuildingProviderComponent.c.

◆ RemoveAvailableUser()

void RemoveAvailableUser ( int userID )

protected

Parameters

[in] userID

Definition at line 797 of file SCR_CampaignBuildingProviderComponent.c.

◆ RemoveCheckProviderMove()

void RemoveCheckProviderMove ( )

protected

Definition at line 1306 of file SCR_CampaignBuildingProviderComponent.c.

◆ RemoveEvents()

void RemoveEvents ( IEntity ent )

protected

remove all methods invoked to entity and related to it's dead or delete.

Definition at line 635 of file SCR_CampaignBuildingProviderComponent.c.

◆ RemoveOnLifeStateChanged()

void RemoveOnLifeStateChanged ( )

protected

Definition at line 900 of file SCR_CampaignBuildingProviderComponent.c.

◆ RemoveOnModeClosed()

void RemoveOnModeClosed ( )

protected

Definition at line 1024 of file SCR_CampaignBuildingProviderComponent.c.

◆ RemoveOnPlayerTeleported()

void RemoveOnPlayerTeleported ( )

protected

Definition at line 1035 of file SCR_CampaignBuildingProviderComponent.c.

◆ RequestEnterBuildingMode()

void RequestEnterBuildingMode	(	int	playerID,
		bool	userActionUsed,
		bool	useAllAvailableProviders = false )

protected

Requesting a building mode. If trigger exist (was spawned with provider, because "Y" can be used to enter the mode, it will open the mode directly. If not, it 1st spawn the building area trigger.

Parameters