Classes
class	SCR_CampaignBuildingManagerComponentClass

Typedefs
typedef func	ScriptInvokerEntitySpawnedByProviderMethod
typedef ScriptInvokerBase< ScriptInvokerEntitySpawnedByProviderMethod >	ScriptInvokerEntitySpawnedByProvider
typedef func	ScriptInvokerCompositionUnregisteredMethod
typedef ScriptInvokerBase< ScriptInvokerCompositionUnregisteredMethod >	ScriptInvokerCompositionUnregistered

Functions
void	ScriptInvokerEntitySpawnedByProviderMethod (int prefabID, SCR_EditableEntityComponent editableEntity, int playerId, SCR_CampaignBuildingProviderComponent provider)
void	ScriptInvokerCompositionUnregisteredMethod (SCR_CampaignBuildingCompositionComponent composition)
SCR_CampaignBuildingManagerComponentClass SCR_BaseGameModeComponentClass	Attribute ("", UIWidgets.ResourcePickerThumbnail, "Prefab of trigger spawned on server to activate a building mode when player enters its range.", "et")] protected ResourceName m_sFreeRoamBuildingServerTrigger
SCR_CampaignBuildingCompositionOutlineManager	GetOutlineManager ()
bool	GetResourceComponent (IEntity owner, out SCR_ResourceComponent component)
ResourceName	GetCompositionPreviewMaterial ()
ResourceName	GetServerTriggerResourceName ()
ResourceName	GetClientTriggerResourceName ()
void	SetTemporaryProvider (IEntity ent)
IEntity	GetTemporaryProvider ()
bool	CanDisassembleSameFactionOnly ()
bool	CanDisassembleOnlyWhenCapturing ()
bool	GetSupplyComponent (IEntity ownerEntity, out SCR_CampaignSuppliesComponent suppliesComponent)
	Get supply component of the provider entity.
void	ProcesXPreward ()
	Check if the number of cycles reaches a defined limit. If so, restart counter and send an RPC on server to add XP reward.
int	GetCompositionRefundPercentage ()
void	OnEntityCoreBudgetUpdated (EEditableEntityBudget entityBudget, int originalBudgetValue, int budgetChange, int updatedBudgetValue, SCR_EditableEntityComponent entity)
void	SpawnCustomResourceHolder (IEntity entityOwner, out SCR_ResourceComponent component)
override void	EOnInit (IEntity owner)
override void	OnPostInit (IEntity owner)
	Editable Mine.
bool	IsProxy ()
void	GetPrefabListFromConfig ()
	Load all the available compositions at the beginning of the game to be accessible without the building mode entity.
ResourceName	GetCompositionResourceName (int prefabID)
array< ResourceName >	GetPlaceablePrefabs ()
int	GetCompositionId (ResourceName resName)
void	EnterEditorMode (int playerID, notnull IEntity provider, bool userActionActivationOnly=false, bool userActionUsed=false, bool useAllAvailableProviders=false)
void	SetEditorMode (notnull SCR_EditorManagerEntity editorManager, notnull SCR_EditorModeEntity modeEntity, int playerID, notnull IEntity provider, bool userActionActivationOnly=false, bool userActionUsed=false, bool useAllAvailableProviders=false)
bool	IsCommander (int playerId)
void	PlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
void	EntitySpawnedByProvider (int prefabID, SCR_EditableEntityComponent editableEntity, int playerId)
	Event triggered when the entity is spawned by this provider.
bool	TryAddHQ (notnull SCR_CampaignBuildingCompositionComponent composition)
bool	TryRemoveHQ (notnull SCR_CampaignBuildingCompositionComponent composition)
bool	IsHQService (notnull SCR_EditableEntityComponent editableEntity)
void	SetOnPlayerDeathEvent (int playerID)
void	RemoveOnPlayerDeathEvent (int playerID)
void	SetOnProviderDestroyedEvent (IEntity provider)
void	RemoveOnProviderDestroyedEvent (IEntity provider)
void	OnPlayerDeath (SCR_CharacterControllerComponent characterController, IEntity instigatorEntity, notnull Instigator killer)
void	OnProviderDestroyed (SCR_HitZone hitZone)
bool	RemovePlayerIdFromProvider (int playerID, SCR_CampaignBuildingProviderComponent providerComponent)
void	RemoveProvider (int playerID, SCR_CampaignBuildingProviderComponent providerComponent, bool isActiveUser)
void	ToggleEditorMode (notnull SCR_EditorManagerEntity editorManager)
void	RemoveEditorMode (int playerID)
SCR_EditorManagerEntity	GetEditorManagerEntity (int playerID)
void	RegisterComposition (notnull SCR_CampaignBuildingCompositionComponent composition)
void	UnregisterComposition (notnull SCR_CampaignBuildingCompositionComponent composition)
void	OnCompositionSpawned (bool spawned)
int	GetBuildingCompositions (SCR_CampaignMilitaryBaseComponent base, out array< SCR_CampaignBuildingCompositionComponent > compositions)
array< SCR_CampaignBuildingCompositionComponent >	GetHQBuildingCompositions ()
ScriptInvokerEntitySpawnedByProvider	GetOnEntitySpawnedByProvider ()
ScriptInvokerVoid	GetOnAnyCompositionSpawned ()
ScriptInvokerCompositionUnregistered	GetOnCompositionUnregistered ()

Variables
ResourceName	m_sFreeRoamBuildingClientTrigger
ResourceName	m_sPreviewMaterial
EEditableEntityBudget	m_BudgetType
int	m_iCompositionRefundPercentage
int	m_iXpRewardTreshold
int	m_iInitialRewardInterval
float	m_fRewardCurveIncrement
bool	m_bSameFactionDisassembleOnly
	Note: Provider is saved to composition only when it's built from base.
bool	m_bDisassembleOnlyWhenCapturing
ref SCR_CampaignBuildingCompositionOutlineManager	m_OutlineManager
ResourceName	m_sPrefabsToBuildResource
ResourceName	m_sPrefabToHoldSupplyOnRefund
ref array< ResourceName >	m_aPlaceablePrefabs = {}
ref map< SCR_CampaignMilitaryBaseComponent, ref array< SCR_CampaignBuildingCompositionComponent > >	m_mCampaignBuildingComponents
ref array< SCR_CampaignBuildingCompositionComponent >	m_aHQBuildingCompositions = {}
SCR_EditableEntityCore	m_EntityCore
IEntity	m_TemporaryProvider
RplComponent	m_RplComponent
int	m_iBuildingCycle
float	m_fRewardCurveProgress
ref ScriptInvokerEntitySpawnedByProvider	m_OnEntitySpawnedByProvider
ref ScriptInvokerVoid	m_OnAnyCompositionSpawned
ref ScriptInvokerCompositionUnregistered	m_OnCompositionUnregistered

Typedef Documentation

◆ ScriptInvokerCompositionUnregistered

typedef ScriptInvokerBase<ScriptInvokerCompositionUnregisteredMethod> ScriptInvokerCompositionUnregistered

Definition at line 7 of file SCR_CampaignBuildingManagerComponent.c.

◆ ScriptInvokerCompositionUnregisteredMethod

typedef func ScriptInvokerCompositionUnregisteredMethod

Definition at line 6 of file SCR_CampaignBuildingManagerComponent.c.

◆ ScriptInvokerEntitySpawnedByProvider

typedef ScriptInvokerBase<ScriptInvokerEntitySpawnedByProviderMethod> ScriptInvokerEntitySpawnedByProvider

Definition at line 3 of file SCR_CampaignBuildingManagerComponent.c.

◆ ScriptInvokerEntitySpawnedByProviderMethod

typedef func ScriptInvokerEntitySpawnedByProviderMethod

Definition at line 2 of file SCR_CampaignBuildingManagerComponent.c.

Function Documentation

◆ Attribute()

SCR_CampaignBuildingManagerComponentClass SCR_BaseGameModeComponentClass Attribute	(	""	,
		UIWidgets.	ResourcePickerThumbnail,
		"Prefab of trigger spawned on server to activate a building mode when player enters its range."	,
		"et"	)

Interface for game mode extending components. Must be attached to a GameMode entity.

◆ CanDisassembleOnlyWhenCapturing()

bool CanDisassembleOnlyWhenCapturing ( )

protected

Returns: Can the enemy faction disassemble base structures ONLY while capturing.

Definition at line 151 of file SCR_CampaignBuildingManagerComponent.c.

◆ CanDisassembleSameFactionOnly()

bool CanDisassembleSameFactionOnly ( )

protected

Returns

Definition at line 144 of file SCR_CampaignBuildingManagerComponent.c.

◆ EnterEditorMode()

void EnterEditorMode	(	int	playerID,
		notnull IEntity	provider,
		bool	userActionActivationOnly = false,
		bool	userActionUsed = false,
		bool	useAllAvailableProviders = false )

protected

Parameters

[in]	playerID
[in]	provider
[in]	userActionActivationOnly
[in]	userActionUsed
[in]	useAllAvailableProviders	true if game should use all available providers from that base

Definition at line 421 of file SCR_CampaignBuildingManagerComponent.c.

◆ EntitySpawnedByProvider()

void EntitySpawnedByProvider	(	int	prefabID,
		SCR_EditableEntityComponent	editableEntity,
		int	playerId )

protected

Event triggered when the entity is spawned by this provider.

Definition at line 517 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetBuildingCompositions()

int GetBuildingCompositions	(	SCR_CampaignMilitaryBaseComponent	base,
		out array< SCR_CampaignBuildingCompositionComponent >	compositions )

protected

Definition at line 873 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetClientTriggerResourceName()

ResourceName GetClientTriggerResourceName ( )

protected

Returns

Definition at line 122 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetCompositionId()

int GetCompositionId ( ResourceName resName )

protected

Returns composition id based on provided resource name.

Parameters

[in] resName

Returns

Definition at line 410 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetCompositionPreviewMaterial()

ResourceName GetCompositionPreviewMaterial ( )

protected

Returns

Definition at line 108 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetCompositionRefundPercentage()

int GetCompositionRefundPercentage ( )

protected

Get supplies from the composition cost that gets refunded on removal of composition

Returns: Percentage of supplies refunded

Definition at line 211 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetCompositionResourceName()

ResourceName GetCompositionResourceName ( int prefabID )

protected

Search for a resource name of composition by given ID.

Parameters

[in] prefabID

Returns

Definition at line 386 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetEditorManagerEntity()

SCR_EditorManagerEntity GetEditorManagerEntity ( int playerID )

protected

Definition at line 772 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetHQBuildingCompositions()

array< SCR_CampaignBuildingCompositionComponent > GetHQBuildingCompositions ( )

protected

Returns: spawned HQ building compositions

Definition at line 887 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetOnAnyCompositionSpawned()

ScriptInvokerVoid GetOnAnyCompositionSpawned ( )

protected

Definition at line 902 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetOnCompositionUnregistered()

ScriptInvokerCompositionUnregistered GetOnCompositionUnregistered ( )

protected

Definition at line 911 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetOnEntitySpawnedByProvider()

ScriptInvokerEntitySpawnedByProvider GetOnEntitySpawnedByProvider ( )

protected

Definition at line 893 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetOutlineManager()

SCR_CampaignBuildingCompositionOutlineManager GetOutlineManager ( )

protected

Returns

Definition at line 74 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetPlaceablePrefabs()

array< ResourceName > GetPlaceablePrefabs ( )

protected

Definition at line 396 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetPrefabListFromConfig()

void GetPrefabListFromConfig ( )

protected

Load all the available compositions at the beginning of the game to be accessible without the building mode entity.

Definition at line 369 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetResourceComponent()

bool GetResourceComponent	(	IEntity	owner,
		out SCR_ResourceComponent	component )

protected

Definition at line 80 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetServerTriggerResourceName()

ResourceName GetServerTriggerResourceName ( )

protected

Returns

Definition at line 115 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetSupplyComponent()

bool GetSupplyComponent	(	IEntity	ownerEntity,
		out SCR_CampaignSuppliesComponent	suppliesComponent )

protected

Get supply component of the provider entity.

Definition at line 159 of file SCR_CampaignBuildingManagerComponent.c.

◆ GetTemporaryProvider()

IEntity GetTemporaryProvider ( )

protected

Returns

Definition at line 136 of file SCR_CampaignBuildingManagerComponent.c.

◆ IsCommander()

bool IsCommander ( int playerId )

protected

Checks if given player is a faction commander

Parameters

[in] playerId

Returns: true if player with provided id is the commander of his faction, otherwise false

Definition at line 487 of file SCR_CampaignBuildingManagerComponent.c.

◆ IsHQService()

bool IsHQService ( notnull SCR_EditableEntityComponent editableEntity )

protected

Definition at line 578 of file SCR_CampaignBuildingManagerComponent.c.

◆ OnCompositionSpawned()

void OnCompositionSpawned ( bool spawned )

protected

Definition at line 863 of file SCR_CampaignBuildingManagerComponent.c.

◆ OnEntityCoreBudgetUpdated()

void OnEntityCoreBudgetUpdated	(	EEditableEntityBudget	entityBudget,
		int	originalBudgetValue,
		int	budgetChange,
		int	updatedBudgetValue,
		SCR_EditableEntityComponent	entity )

protected

Definition at line 217 of file SCR_CampaignBuildingManagerComponent.c.

◆ OnPlayerDeath()

void OnPlayerDeath	(	SCR_CharacterControllerComponent	characterController,
		IEntity	instigatorEntity,
		notnull Instigator	killer )

protected

Definition at line 642 of file SCR_CampaignBuildingManagerComponent.c.

◆ OnProviderDestroyed()

void OnProviderDestroyed ( SCR_HitZone hitZone )

protected

Method called when the provider was destroyed.

Parameters

[in] hitZone

Definition at line 662 of file SCR_CampaignBuildingManagerComponent.c.

◆ PlayerDisconnected()

void PlayerDisconnected	(	int	playerId,
		KickCauseCode	cause,
		int	timeout )

protected

Event raised when the player disconnects

Parameters

[in]	playerId
[in]	cause
[in]	timeout

Definition at line 506 of file SCR_CampaignBuildingManagerComponent.c.

◆ ProcesXPreward()

void ProcesXPreward ( )

protected

Check if the number of cycles reaches a defined limit. If so, restart counter and send an RPC on server to add XP reward.

Definition at line 184 of file SCR_CampaignBuildingManagerComponent.c.

◆ RegisterComposition()

void RegisterComposition ( notnull SCR_CampaignBuildingCompositionComponent composition )

protected

Parameters

[in] composition

Definition at line 784 of file SCR_CampaignBuildingManagerComponent.c.

◆ RemoveEditorMode()

void RemoveEditorMode ( int playerID )

protected

Definition at line 758 of file SCR_CampaignBuildingManagerComponent.c.

◆ RemoveOnPlayerDeathEvent()

void RemoveOnPlayerDeathEvent ( int playerID )

protected

Definition at line 604 of file SCR_CampaignBuildingManagerComponent.c.

◆ RemoveOnProviderDestroyedEvent()

void RemoveOnProviderDestroyedEvent ( IEntity provider )

protected

Definition at line 630 of file SCR_CampaignBuildingManagerComponent.c.

◆ RemovePlayerIdFromProvider()

bool RemovePlayerIdFromProvider	(	int	playerID,
		SCR_CampaignBuildingProviderComponent	providerComponent )

protected

Remove the provided player id from list of active and available users, return true if the user was in the list of active users

Parameters

[in]	playerID
[in]	providerComponent

Returns

Definition at line 697 of file SCR_CampaignBuildingManagerComponent.c.

◆ RemoveProvider()

void RemoveProvider	(	int	playerID,
		SCR_CampaignBuildingProviderComponent	providerComponent,
		bool	isActiveUser )

protected

Parameters

[in]	playerID
[in]	providerComponent
[in]	isActiveUser

Definition at line 712 of file SCR_CampaignBuildingManagerComponent.c.

◆ ScriptInvokerCompositionUnregisteredMethod()

void ScriptInvokerCompositionUnregisteredMethod ( SCR_CampaignBuildingCompositionComponent composition )

◆ ScriptInvokerEntitySpawnedByProviderMethod()

void ScriptInvokerEntitySpawnedByProviderMethod	(	int	prefabID,
		SCR_EditableEntityComponent	editableEntity,
		int	playerId,
		SCR_CampaignBuildingProviderComponent	provider )

◆ SetEditorMode()

void SetEditorMode	(	notnull SCR_EditorManagerEntity	editorManager,
		notnull SCR_EditorModeEntity	modeEntity,
		int	playerID,
		notnull IEntity	provider,
		bool	userActionActivationOnly = false,
		bool	userActionUsed = false,
		bool	useAllAvailableProviders = false )

protected

Parameters

[in]	editorManager
[in]	modeEntity
[in]	playerID
[in]	provider
[in]	userActionActivationOnly
[in]	userActionUsed
[in]	useAllAvailableProviders	true if game should use all available providers from that base