Data Structures
class	SCR_CampaignBuildingProviderComponentClass

Functions
SCR_CampaignBuildingProviderComponentClass SCR_MilitaryBaseLogicComponentClass	Attribute ("", UIWidgets.EditBox, "Name of provider shown in provider interface", "")] protected string m_sProviderDisplayName

string	GetProviderDisplayName ()
	Return name of the provider. More...

bool	UseMasterProvider ()
	Should this provider use a master provider? More...

bool	IsMasterProvider ()
	Master provider can be for an example HQ where there are other services that can serve as providers (living area for an example) but master provider counts budget limits or define a building area. More...

bool	CanCommandAI ()

bool	ObstrucViewWhenEnemyInRange ()

IEntity	GetMasterProviderEntity ()
	Returns master provider entity of this provider if any. If not, return itself. More...

bool	UseMasterProviderBudget (EEditableEntityBudget budget, out SCR_CampaignBuildingProviderComponent masterProviderComponent)
	Check if for this budget should be used budget of master provider. More...

void	SetClientLock (bool lock, IEntity provider, int playerId)

void	SetCooldownClientLock (bool val)

void	SetPlayerCooldown (int playerId, int cooldownTime)
	Set the cooldown time. First calculate if there is a potential adjustment of the time, based on the budget setting of provider. Make loop running on server. More...

void	UpdateCooldownTimer ()
	Periodically called method to evaluate a current status of the cooldown. More...

bool	HasCooldownSet (int playerId)
	Is placing allowed for this player? More...

float	GetCooldownValue (int playerId)
	Return current value of the cooldown time for a given player. More...

ScriptInvokerVoid	GetOnCooldownLockUpdated ()

override void	RegisterBase (notnull SCR_MilitaryBaseComponent base)

bool	CanRegisterAtMilitaryBase ()

SCR_MilitaryBaseComponent	GetMilitaryBaseComponent ()

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. More...

int	GetCurrentPropValue ()

void	SetPropValue (int value)

void	AddPropValue (int value)

int	GetCurrentAIValue ()

void	SetAIValue (int value)

void	AddAIValue (int value)

protected void	OnAIRemoved (IEntity ent)
	An event called when AI spawned by this provider is killed or deleted. More...

void	SetOnEntityKilled (IEntity ent)
	Set an event called when entity spawned by this provider get killed. More...

protected void	RemoveEvents (IEntity ent)
	remove all methods invoked to entity and related to it's dead or delete. More...

array< EEditableEntityLabel >	GetAvailableTraits ()

override void	OnPostInit (IEntity owner)
	Called on PostInit when all components are added. More...

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	RequestBuildingMode (int playerID, bool userActionUsed)

void	RequestEnterBuildingMode (int playerID, bool userActionUsed)

void	SetOnPlayerTeleported (int playerID)

void	SetOnPlayerConsciousnessChanged ()
	Set even when player consciousness changed. More...

void	OnLifeStateChanged (ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState)
	Will be called when the life state of the character changes. More...

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. More...

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. More...

void	OnModeClosed ()

void	RemoveOnModeClosed ()

void	RemoveOnPlayerTeleported ()

bool	GetUserActionInitOnly ()

protected SCR_CampaignBuildingNetworkComponent	GetNetworkManager ()

protected SCR_EditorManagerEntity	GetEditorManager ()

protected SCR_EditorManagerEntity	GetEditorManagerByID (int playerId)

protected SCR_CharacterControllerComponent	GetCharacterControllerComponent (int playerID)

protected int	GetPlayerIdFromCharacterController (SCR_CharacterControllerComponent characterControllerComponent)

bool	IsCharacterFactionSame (notnull IEntity character)
	Does character faction match the provider faction. More...

protected Faction	GetEntityFaction (notnull IEntity ent)

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

SCR_ResourceComponent	GetResourceComponent ()
	Caches and returns the resource component. More...

SCR_CampaignSuppliesComponent	GetSuppliesComponent ()

SCR_CampaignBuildingBudgetToEvaluateData	GetBudgetData (EEditableEntityBudget budget)
	Get data of given budget. More...

int	GetBudgetTypesToEvaluate (notnull out array< ref EEditableEntityBudget > budgets)
	Returns all budget types to evaluate with this provider. More...

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. More...

int	CalculateCooldownTime (int playerId, int cooldownTime)
	Checks the budget setting and calculate final cooldown time based on it. More...

void	RemoveActiveUsers ()
	Method called when the provider was destroyed or deleted to remove a provider. More...

void	RemoveCheckProviderMove ()

void	SetCheckProviderMove ()

private void	CheckProviderMove ()
	Check if the provider velocity in meters per second is faster then allowed. If so, terminate a building mode. More...

private bool	IsProviderDynamic ()
	Check if the provider is dynamic. If so, save his physic component for move check. More...

bool	IsEnemyFaction (notnull ChimeraCharacter char)

override bool	RplLoad (ScriptBitReader reader)

void	~SCR_CampaignBuildingProviderComponent ()

Variables
protected bool	m_bUserActionActivationOnly

protected bool	m_bIsMasterProvider

protected bool	m_bUseMasterProvider

protected bool	m_bRegisterAtBase

protected bool	m_bCanCommandAI

protected bool	m_bObstructViewWhenEnemyInRange

protected float	m_fBuildingRadius

protected SCR_ECharacterRank	m_iRank

protected ref array< ref SCR_CampaignBuildingBudgetToEvaluateData >	m_aBudgetsToEvaluate

protected ref array< EEditableEntityLabel >	m_aAvailableTraits

protected 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. More...

protected int	m_iCurrentAIValue
	Current AI Value represents, how many AI is currently spawned with this provider. The max number is limited by AI budget. More...

protected Physics	m_ProviderPhysics

protected SCR_ResourceComponent	m_ResourceComponent

protected ref array< int >	m_aActiveUsersIDs = {}

protected ref array< int >	m_aAvailableUsersIDs = {}

protected ref array< SCR_CampaignBuildingBudgetToEvaluateData >	m_aShownBudget = {}

protected ref ScriptInvokerVoid	m_OnCooldownLockUpdated

const protected int	MOVING_CHECK_PERIOD = 1000

const protected int	PROVIDER_SPEED_TO_REMOVE_BUILDING_SQ = 1

protected ref array< ref Tuple2< int, WorldTimestamp > >	m_aPlacingCooldown = {}

protected bool	m_bCooldownClientLock

SCR_CampaignBuildingProviderComponent	m_MasterProviderComponent

Function Documentation

◆ AddAIValue()

void AddAIValue ( int value )

Definition at line 373 of file SCR_CampaignBuildingProviderComponent.c.

◆ AddNewActiveUser()

void AddNewActiveUser ( int userID )

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

Parameters

[in] userID

Definition at line 445 of file SCR_CampaignBuildingProviderComponent.c.

◆ AddNewAvailableUser()

void AddNewAvailableUser ( int userID )

Parameters

[in] userID

Definition at line 479 of file SCR_CampaignBuildingProviderComponent.c.

◆ AddPropValue()

void AddPropValue ( int value )

Parameters

[in] value

Definition at line 336 of file SCR_CampaignBuildingProviderComponent.c.

◆ Attribute()

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

◆ BuildingModeCreated()

void BuildingModeCreated ( )

Definition at line 663 of file SCR_CampaignBuildingProviderComponent.c.

◆ CalculateCooldownTime()

int CalculateCooldownTime	(	int	playerId,
		int	cooldownTime
	)

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

Definition at line 944 of file SCR_CampaignBuildingProviderComponent.c.

◆ CanCommandAI()

bool CanCommandAI ( )

Returns: Can player from this provider control friendly AI in building radius.

Definition at line 91 of file SCR_CampaignBuildingProviderComponent.c.

◆ CanRegisterAtMilitaryBase()

bool CanRegisterAtMilitaryBase ( )

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

Definition at line 265 of file SCR_CampaignBuildingProviderComponent.c.

◆ CheckProviderMove()

private void CheckProviderMove ( )

Check if the provider velocity in meters per second is faster then allowed. If so, terminate a building mode.

Definition at line 1019 of file SCR_CampaignBuildingProviderComponent.c.

◆ ContainActiveUsers()

bool ContainActiveUsers ( int playerId )

Parameters

[in] playerId

Returns

Definition at line 471 of file SCR_CampaignBuildingProviderComponent.c.

◆ ContainAvailableUsers()

bool ContainAvailableUsers ( int playerId )

Parameters

[in] playerId

Returns

Definition at line 505 of file SCR_CampaignBuildingProviderComponent.c.

◆ EntitySpawnedByProvider()

void EntitySpawnedByProvider	(	int	prefabID,
		SCR_EditableEntityComponent	editableEntity
	)

Event rised when the entity is spawned by this provider.

Definition at line 684 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetAccessRank()

SCR_ECharacterRank GetAccessRank ( )

Returns

Definition at line 285 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetActiveUsers()

int GetActiveUsers ( out notnull array< int > users )

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

Parameters

[out] users

Definition at line 462 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetAvailableTraits()

array<EEditableEntityLabel> GetAvailableTraits ( )

Definition at line 418 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetAvailableUsers()

int GetAvailableUsers ( out array< int > users )

Parameters

[out] users

Returns

Definition at line 496 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetBudgetData()

SCR_CampaignBuildingBudgetToEvaluateData GetBudgetData ( EEditableEntityBudget budget )

Get data of given budget.

Definition at line 886 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetBudgetTypesToEvaluate()

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

Returns all budget types to evaluate with this provider.

Definition at line 899 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetBuildingRadius()

float GetBuildingRadius ( )

Returns

Definition at line 292 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetCharacterControllerComponent()

protected SCR_CharacterControllerComponent GetCharacterControllerComponent ( int playerID )

Definition at line 788 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetCooldownValue()

float GetCooldownValue ( int playerId )

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

Definition at line 225 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetCurrentAIValue()

int GetCurrentAIValue ( )

Definition at line 349 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetCurrentPropValue()

int GetCurrentPropValue ( )

Returns

Definition at line 314 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetEditorManager()

protected SCR_EditorManagerEntity GetEditorManager ( )

Returns: local Editor Manager

Definition at line 767 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetEditorManagerByID()

protected SCR_EditorManagerEntity GetEditorManagerByID ( int playerId )

Returns: Editor manager by player ID

Definition at line 778 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetEntityFaction()

protected Faction GetEntityFaction ( notnull IEntity ent )

Definition at line 833 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetMasterProviderEntity()

IEntity GetMasterProviderEntity ( )

Returns master provider entity of this provider if any. If not, return itself.

Definition at line 105 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetMaxBudgetValue()

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.

Definition at line 299 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetMilitaryBaseComponent()

SCR_MilitaryBaseComponent GetMilitaryBaseComponent ( )

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 272 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetNetworkManager()

protected SCR_CampaignBuildingNetworkComponent GetNetworkManager ( )

Returns: Network Manager

Definition at line 756 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetOnCooldownLockUpdated()

ScriptInvokerVoid GetOnCooldownLockUpdated ( )

Definition at line 246 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetPlayerIdFromCharacterController()

protected int GetPlayerIdFromCharacterController ( SCR_CharacterControllerComponent characterControllerComponent )

Definition at line 798 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetProviderDisplayName()

string GetProviderDisplayName ( )

Return name of the provider.

Definition at line 70 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetResourceComponent()

SCR_ResourceComponent GetResourceComponent ( )

Caches and returns the resource component.

Definition at line 868 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetShownBudget()

EEditableEntityBudget GetShownBudget ( )

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

Definition at line 928 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetSuppliesComponent()

SCR_CampaignSuppliesComponent GetSuppliesComponent ( )

Returns: provider supply component - obsolete

Definition at line 879 of file SCR_CampaignBuildingProviderComponent.c.

◆ GetUserActionInitOnly()

bool GetUserActionInitOnly ( )

Returns

Definition at line 749 of file SCR_CampaignBuildingProviderComponent.c.

◆ HasCooldownSet()

bool HasCooldownSet ( int playerId )

Is placing allowed for this player?

Definition at line 218 of file SCR_CampaignBuildingProviderComponent.c.

◆ IsBudgetToEvaluate()

bool IsBudgetToEvaluate ( EEditableEntityBudget blockingBudget )

Parameters

[in] blockingBudget

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

Definition at line 912 of file SCR_CampaignBuildingProviderComponent.c.

◆ IsCharacterFactionSame()

bool IsCharacterFactionSame ( notnull IEntity character )

Does character faction match the provider faction.

Parameters

[in] character

Returns

Definition at line 815 of file SCR_CampaignBuildingProviderComponent.c.

◆ IsEnemyFaction()

bool IsEnemyFaction ( notnull ChimeraCharacter char )

Check if given character faction is a hostile to player, or not.

Parameters

[in] char Character to be evaluated if is enemy or not.

Definition at line 1043 of file SCR_CampaignBuildingProviderComponent.c.

◆ IsMasterProvider()

bool IsMasterProvider ( )

Master provider can be for an example HQ where there are other services that can serve as providers (living area for an example) but master provider counts budget limits or define a building area.

Definition at line 84 of file SCR_CampaignBuildingProviderComponent.c.

◆ IsProviderDynamic()

private bool IsProviderDynamic ( )

Check if the provider is dynamic. If so, save his physic component for move check.

Definition at line 1029 of file SCR_CampaignBuildingProviderComponent.c.

◆ ObstrucViewWhenEnemyInRange()

bool ObstrucViewWhenEnemyInRange ( )

Returns: bool When true, view will be obstructed when an enemy is present within the radius of the building.

Definition at line 98 of file SCR_CampaignBuildingProviderComponent.c.

◆ OnActiveUserDeath()

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

Parameters

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

Definition at line 647 of file SCR_CampaignBuildingProviderComponent.c.

◆ OnAIRemoved()

protected void OnAIRemoved ( IEntity ent )

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

Definition at line 387 of file SCR_CampaignBuildingProviderComponent.c.

◆ OnAvailableUserDeath()

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

Parameters

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

Definition at line 656 of file SCR_CampaignBuildingProviderComponent.c.

◆ OnBaseOwnerChanged()

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

Method triggered when owning faction of provider has changed.

Parameters

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

Definition at line 860 of file SCR_CampaignBuildingProviderComponent.c.

◆ OnModeClosed()

void OnModeClosed ( )

Definition at line 699 of file SCR_CampaignBuildingProviderComponent.c.

◆ PlayerTeleported()

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

Parameters

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

Definition at line 587 of file SCR_CampaignBuildingProviderComponent.c.

◆ RegisterBase()

override void RegisterBase ( notnull SCR_MilitaryBaseComponent base )

Definition at line 255 of file SCR_CampaignBuildingProviderComponent.c.

◆ RemoveActiveUser()

void RemoveActiveUser ( int userID )

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

Parameters

[in] userID

Definition at line 454 of file SCR_CampaignBuildingProviderComponent.c.

◆ RemoveActiveUsers()

void RemoveActiveUsers ( )

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

Definition at line 965 of file SCR_CampaignBuildingProviderComponent.c.

◆ RemoveAvailableUser()

void RemoveAvailableUser ( int userID )

Parameters

[in] userID

Definition at line 488 of file SCR_CampaignBuildingProviderComponent.c.

◆ RemoveCheckProviderMove()

void RemoveCheckProviderMove ( )

Definition at line 1003 of file SCR_CampaignBuildingProviderComponent.c.

◆ RemoveEvents()

protected void RemoveEvents ( IEntity ent )

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

Definition at line 407 of file SCR_CampaignBuildingProviderComponent.c.

◆ RemoveOnLifeStateChanged()

void RemoveOnLifeStateChanged ( )

Definition at line 599 of file SCR_CampaignBuildingProviderComponent.c.

◆ RemoveOnModeClosed()

void RemoveOnModeClosed ( )

Definition at line 723 of file SCR_CampaignBuildingProviderComponent.c.

◆ RemoveOnPlayerTeleported()

void RemoveOnPlayerTeleported ( )

Definition at line 734 of file SCR_CampaignBuildingProviderComponent.c.

◆ RequestBuildingMode()

void RequestBuildingMode	(	int	playerID,
		bool	userActionUsed
	)

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

[in]	playerID
[in]	userActionUsed

Definition at line 514 of file SCR_CampaignBuildingProviderComponent.c.

◆ RequestEnterBuildingMode()

void RequestEnterBuildingMode	(	int	playerID,
		bool	userActionUsed
	)

Parameters

[in]	playerID
[in]	userActionUsed

Definition at line 523 of file SCR_CampaignBuildingProviderComponent.c.

◆ RplLoad()

override bool RplLoad ( ScriptBitReader reader )

Definition at line 1065 of file SCR_CampaignBuildingProviderComponent.c.

◆ SetAIValue()

void SetAIValue ( int value )

Definition at line 360 of file SCR_CampaignBuildingProviderComponent.c.

◆ SetCheckProviderMove()

void SetCheckProviderMove ( )

Definition at line 1011 of file SCR_CampaignBuildingProviderComponent.c.

◆ SetClientLock()

void SetClientLock	(	bool	lock,
		IEntity	provider,
		int	playerId
	)

Definition at line 153 of file SCR_CampaignBuildingProviderComponent.c.

◆ SetCooldownClientLock()

void SetCooldownClientLock ( bool val )

Definition at line 167 of file SCR_CampaignBuildingProviderComponent.c.

◆ SetOnEntityKilled()

void SetOnEntityKilled ( IEntity ent )

Set an event called when entity spawned by this provider get killed.

Definition at line 395 of file SCR_CampaignBuildingProviderComponent.c.

◆ SetOnPlayerConsciousnessChanged()

void SetOnPlayerConsciousnessChanged ( )

Set even when player consciousness changed.

Definition at line 557 of file SCR_CampaignBuildingProviderComponent.c.

◆ SetOnPlayerDeathActiveUserEvent()

void SetOnPlayerDeathActiveUserEvent ( int userID )

Parameters

[in] userID

Definition at line 623 of file SCR_CampaignBuildingProviderComponent.c.

◆ SetOnPlayerDeathAvailableUserEvent()

void SetOnPlayerDeathAvailableUserEvent ( int userID )

Parameters

[in] userID

Definition at line 634 of file SCR_CampaignBuildingProviderComponent.c.

◆ SetOnPlayerTeleported()

void SetOnPlayerTeleported ( int playerID )

Parameters

[in] playerID

Definition at line 542 of file SCR_CampaignBuildingProviderComponent.c.

◆ SetOnProviderFactionChangedEvent()

void SetOnProviderFactionChangedEvent ( )

Insert a method called when the provider faction is changed, e.g a base is taken by an enemy.

Definition at line 612 of file SCR_CampaignBuildingProviderComponent.c.

◆ SetPlayerCooldown()

void SetPlayerCooldown	(	int	playerId,
		int	cooldownTime
	)

Set the cooldown time. First calculate if there is a potential adjustment of the time, based on the budget setting of provider. Make loop running on server.

Definition at line 177 of file SCR_CampaignBuildingProviderComponent.c.