Interface for game mode extending components. More...

Inheritance diagram for SCR_CampaignBuildingManagerComponent:

Public Member Functions
ResourceName	GetCompositionPreviewMaterial ()

ResourceName	GetServerTriggerResourceName ()

ResourceName	GetClientTriggerResourceName ()

void	SetTemporaryProvider (IEntity ent)

IEntity	GetTemporaryProvider ()

bool	CanDisassembleSameFactionOnly ()

bool	CanDisassembleOnlyWhenCapturing ()

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 ()
	Get supplies from the composition cost that gets refunded on removal of composition.

override void	EOnInit (IEntity owner)

override void	OnPostInit (IEntity owner)

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)
	Search for a resource name of composition by given ID.

int	GetCompositionId (ResourceName resName)
	Returns composition id based on provided resource name.

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

void	PlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Event raised when the player disconnects.

void	EntitySpawnedByProvider (int prefabID, SCR_EditableEntityComponent editableEntity, int playerId)
	Event triggered when the entity is spawned by this provider.

bool	RemovePlayerIdFromProvider (int playerID, SCR_CampaignBuildingProviderComponent providerComponent)
	Remove the provided player id from list of active and available users, return true if the user was in the list of active users.

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

Public Member Functions inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	GetGameMode ()

void	OnGameEnd ()
	Called on all machines when the world ends.

void	OnGameStateChanged (SCR_EGameModeState state)
	Called when game mode state changes called on all machines.

void	OnGameModeStart ()
	Called on every machine when game mode starts.

void	OnGameModeEnd (SCR_GameModeEndData data)
	Called when game mode ends.

void	OnPlayerConnected (int playerId)
	Called after a player is connected.

void	OnPlayerAuditSuccess (int playerId)
	Event is called when player connecting Session hosting current Game Mode where is required authentication verification via.

void	OnPlayerAuditFail (int playerId)
	Event is called when player connecting Session hosting current Game Mode AuditFail() call may be called under two occasions: 1) verification is required but failed (account is not valid, player is banned, internet issues) 2) player cannot be verified as authentication is not required or possible - where it may be valid behavior (server online connectivity turned off for example) Basically non-audited player cannot access persistency/ etc.

void	OnPlayerAuditTimeouted (int playerId)
	Event is called when player connected to Session was kicked and did not reconnected in time This mean that slot reservation can be canceled.

void	OnPlayerAuditRevived (int playerId)
	Event is called when player reconnected successfully back to Session after kick This mean that slot reservation need to be finished (closed).

void	OnPlayerRegistered (int playerId)
	Called on every machine after a player is registered (identity, name etc.).

void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Called after a player is disconnected.

void	OnPlayerSpawned (int playerId, IEntity controlledEntity)
	Called after a player is spawned.

bool	PreparePlayerEntity_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)

void	OnSpawnPlayerEntityFailure_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, IEntity entity, SCR_SpawnData data, SCR_ESpawnResult reason)

void	OnPlayerSpawnFinalize_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)

bool	HandlePlayerKilled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	See SCR_BaseGameMode.HandlePlayerKilled.

void	OnPlayerKilled (notnull SCR_InstigatorContextData instigatorContextData)
	Called after a player gets killed.

void	OnPlayerKilledHandled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	Called after player gets killed in cases where the kill was handled by the game mode, supressing the default OnPlayerKilled behaviour.

void	OnPlayerDeleted (int playerId, IEntity player)
	Called after a player gets deleted.

void	OnPlayerRoleChange (int playerId, EPlayerRole roleFlags)
	Called when player role changes.

void	OnWorldPostProcess (World world)
	Called once loading of all entities of the world have been finished (still within the loading)

void	HandleOnLoadoutAssigned (int playerID, SCR_BasePlayerLoadout assignedLoadout)
	What happens when a player is assigned a loadout.

void	HandleOnFactionAssigned (int playerID, Faction assignedFaction)
	What happens when a player is assigned a faction.

void	HandleOnSpawnPointAssigned (int playerID, SCR_SpawnPoint spawnPoint)
	What happens when a player is assigned a spawn point.

void	OnControllableSpawned (IEntity entity)
	When a controllable entity is spawned, this event is raised.

void	OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
	When a controllable entity is destroyed, this event is raised.

void	OnControllableDeleted (IEntity entity)
	Prior to a controllable entity being DELETED, this event is raised.

void	SCR_BaseGameModeComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Protected Member Functions
int m_iBuildingCycle SCR_CampaignBuildingCompositionOutlineManager	GetOutlineManager ()

bool	GetResourceComponent (IEntity owner, out SCR_ResourceComponent component)

bool	GetSupplyComponent (IEntity ownerEntity, out SCR_CampaignSuppliesComponent suppliesComponent)
	Get supply component of the provider entity.

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

bool	IsProxy ()

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

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)
	Method called when the provider was destroyed.

void	ToggleEditorMode (notnull SCR_EditorManagerEntity editorManager)

void	RemoveEditorMode (int playerID)

SCR_EditorManagerEntity	GetEditorManagerEntity (int playerID)

Protected Attributes
ResourceName	m_sFreeRoamBuildingServerTrigger

ResourceName	m_sFreeRoamBuildingClientTrigger

ResourceName	m_sPreviewMaterial

EEditableEntityBudget	m_BudgetType

int	m_iCompositionRefundPercentage

int	m_iXpRewardTreshold

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

ref array< ResourceName >	m_aPlaceablePrefabs = {}

SCR_EditableEntityCore	m_EntityCore

IEntity	m_TemporaryProvider

RplComponent	m_RplComponent

Protected Attributes inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	m_pGameMode
	The game mode entity this component is attached to.

Detailed Description

Interface for game mode extending components.

Must be attached to a GameMode entity.

Member Function Documentation

◆ CanDisassembleOnlyWhenCapturing()

bool SCR_CampaignBuildingManagerComponent.CanDisassembleOnlyWhenCapturing ( )

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

◆ CanDisassembleSameFactionOnly()

bool SCR_CampaignBuildingManagerComponent.CanDisassembleSameFactionOnly ( )

Returns

◆ EntitySpawnedByProvider()

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

Event triggered when the entity is spawned by this provider.

◆ EOnInit()

override void SCR_CampaignBuildingManagerComponent.EOnInit ( IEntity owner )

◆ GetClientTriggerResourceName()

ResourceName SCR_CampaignBuildingManagerComponent.GetClientTriggerResourceName ( )

Returns

◆ GetCompositionId()

int SCR_CampaignBuildingManagerComponent.GetCompositionId ( ResourceName resName )

Returns composition id based on provided resource name.

Parameters

[in] resName

Returns

◆ GetCompositionPreviewMaterial()

ResourceName SCR_CampaignBuildingManagerComponent.GetCompositionPreviewMaterial ( )

Returns

◆ GetCompositionRefundPercentage()

int SCR_CampaignBuildingManagerComponent.GetCompositionRefundPercentage ( )

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

Returns: Percentage of supplies refunded

◆ GetCompositionResourceName()

ResourceName SCR_CampaignBuildingManagerComponent.GetCompositionResourceName ( int prefabID )

Search for a resource name of composition by given ID.

Parameters

[in] prefabID

Returns

◆ GetEditorManagerEntity()

SCR_EditorManagerEntity SCR_CampaignBuildingManagerComponent.GetEditorManagerEntity ( int playerID )

protected

◆ GetEditorMode()

void SCR_CampaignBuildingManagerComponent.GetEditorMode	(	int	playerID,
		notnull IEntity	provider,
		bool	userActionActivationOnly = `false`,
		bool	userActionUsed = `false`
	)

Parameters

[in]	playerID
[in]	provider
[in]	userActionActivationOnly
[in]	userActionUsed

◆ GetOutlineManager()

int m_iBuildingCycle SCR_CampaignBuildingCompositionOutlineManager SCR_CampaignBuildingManagerComponent.GetOutlineManager ( )

protected

Returns

◆ GetPrefabListFromConfig()

void SCR_CampaignBuildingManagerComponent.GetPrefabListFromConfig ( )

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

◆ GetResourceComponent()

bool SCR_CampaignBuildingManagerComponent.GetResourceComponent	(	IEntity	owner,
		out SCR_ResourceComponent	component
	)

protected

◆ GetServerTriggerResourceName()

ResourceName SCR_CampaignBuildingManagerComponent.GetServerTriggerResourceName ( )

Returns

◆ GetSupplyComponent()

bool SCR_CampaignBuildingManagerComponent.GetSupplyComponent	(	IEntity	ownerEntity,
		out SCR_CampaignSuppliesComponent	suppliesComponent
	)

protected

Get supply component of the provider entity.

◆ GetTemporaryProvider()

IEntity SCR_CampaignBuildingManagerComponent.GetTemporaryProvider ( )

Returns

◆ IsProxy()

bool SCR_CampaignBuildingManagerComponent.IsProxy ( )

protected

◆ OnEntityCoreBudgetUpdated()

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

protected

◆ OnPlayerDeath()

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

protected

◆ OnPostInit()

override void SCR_CampaignBuildingManagerComponent.OnPostInit ( IEntity owner )

◆ OnProviderDestroyed()

void SCR_CampaignBuildingManagerComponent.OnProviderDestroyed ( SCR_HitZone hitZone )

protected

Method called when the provider was destroyed.

Parameters

[in] hitZone

◆ PlayerDisconnected()

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

Event raised when the player disconnects.

Parameters

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

◆ ProcesXPreward()

void SCR_CampaignBuildingManagerComponent.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.

◆ RemoveEditorMode()

void SCR_CampaignBuildingManagerComponent.RemoveEditorMode ( int playerID )

protected

◆ RemoveOnPlayerDeathEvent()

void SCR_CampaignBuildingManagerComponent.RemoveOnPlayerDeathEvent ( int playerID )

protected

◆ RemoveOnProviderDestroyedEvent()

void SCR_CampaignBuildingManagerComponent.RemoveOnProviderDestroyedEvent ( IEntity provider )

protected

◆ RemovePlayerIdFromProvider()

bool SCR_CampaignBuildingManagerComponent.RemovePlayerIdFromProvider	(	int	playerID,
		SCR_CampaignBuildingProviderComponent	providerComponent
	)

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

◆ RemoveProvider()

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

Parameters

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

◆ SetEditorMode()

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

protected

◆ SetOnPlayerDeathEvent()

void SCR_CampaignBuildingManagerComponent.SetOnPlayerDeathEvent ( int playerID )

protected

◆ SetOnProviderDestroyedEvent()

void SCR_CampaignBuildingManagerComponent.SetOnProviderDestroyedEvent ( IEntity provider )

protected

◆ SetTemporaryProvider()

void SCR_CampaignBuildingManagerComponent.SetTemporaryProvider ( IEntity ent )

Parameters

[in] ent

◆ ToggleEditorMode()

void SCR_CampaignBuildingManagerComponent.ToggleEditorMode ( notnull SCR_EditorManagerEntity editorManager )

protected

Member Data Documentation

◆ m_aPlaceablePrefabs

ref array<ResourceName> SCR_CampaignBuildingManagerComponent.m_aPlaceablePrefabs = {}

protected

◆ m_bDisassembleOnlyWhenCapturing

bool SCR_CampaignBuildingManagerComponent.m_bDisassembleOnlyWhenCapturing

protected

◆ m_bSameFactionDisassembleOnly

bool SCR_CampaignBuildingManagerComponent.m_bSameFactionDisassembleOnly

protected

Note: Provider is saved to composition only when it's built from base.

◆ m_BudgetType

EEditableEntityBudget SCR_CampaignBuildingManagerComponent.m_BudgetType

protected

◆ m_EntityCore

SCR_EditableEntityCore SCR_CampaignBuildingManagerComponent.m_EntityCore

protected

◆ m_iCompositionRefundPercentage

int SCR_CampaignBuildingManagerComponent.m_iCompositionRefundPercentage

protected

◆ m_iXpRewardTreshold

int SCR_CampaignBuildingManagerComponent.m_iXpRewardTreshold

protected

◆ m_OutlineManager

ref SCR_CampaignBuildingCompositionOutlineManager SCR_CampaignBuildingManagerComponent.m_OutlineManager

protected

◆ m_RplComponent

RplComponent SCR_CampaignBuildingManagerComponent.m_RplComponent

protected

◆ m_sFreeRoamBuildingClientTrigger

ResourceName SCR_CampaignBuildingManagerComponent.m_sFreeRoamBuildingClientTrigger

protected

◆ m_sFreeRoamBuildingServerTrigger

ResourceName SCR_CampaignBuildingManagerComponent.m_sFreeRoamBuildingServerTrigger

protected

◆ m_sPrefabsToBuildResource

ResourceName SCR_CampaignBuildingManagerComponent.m_sPrefabsToBuildResource

protected

◆ m_sPreviewMaterial

ResourceName SCR_CampaignBuildingManagerComponent.m_sPreviewMaterial

protected

◆ m_TemporaryProvider

IEntity SCR_CampaignBuildingManagerComponent.m_TemporaryProvider

protected

The documentation for this interface was generated from the following file:

Game/Campaign/SCR_CampaignBuildingManagerComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ CanDisassembleOnlyWhenCapturing()

◆ CanDisassembleSameFactionOnly()

◆ EntitySpawnedByProvider()

◆ EOnInit()

◆ GetClientTriggerResourceName()

◆ GetCompositionId()

◆ GetCompositionPreviewMaterial()

◆ GetCompositionRefundPercentage()

◆ GetCompositionResourceName()

◆ GetEditorManagerEntity()

◆ GetEditorMode()

◆ GetOutlineManager()

◆ GetPrefabListFromConfig()

◆ GetResourceComponent()

◆ GetServerTriggerResourceName()

◆ GetSupplyComponent()

◆ GetTemporaryProvider()

◆ IsProxy()

◆ OnEntityCoreBudgetUpdated()

◆ OnPlayerDeath()

◆ OnPostInit()

◆ OnProviderDestroyed()

◆ PlayerDisconnected()

◆ ProcesXPreward()

◆ RemoveEditorMode()

◆ RemoveOnPlayerDeathEvent()

◆ RemoveOnProviderDestroyedEvent()

◆ RemovePlayerIdFromProvider()

◆ RemoveProvider()

◆ SetEditorMode()

◆ SetOnPlayerDeathEvent()

◆ SetOnProviderDestroyedEvent()

◆ SetTemporaryProvider()

◆ ToggleEditorMode()

Member Data Documentation

◆ m_aPlaceablePrefabs

◆ m_bDisassembleOnlyWhenCapturing

◆ m_bSameFactionDisassembleOnly

◆ m_BudgetType

◆ m_EntityCore

◆ m_iCompositionRefundPercentage

◆ m_iXpRewardTreshold

◆ m_OutlineManager

◆ m_RplComponent

◆ m_sFreeRoamBuildingClientTrigger

◆ m_sFreeRoamBuildingServerTrigger

◆ m_sPrefabsToBuildResource

◆ m_sPreviewMaterial

◆ m_TemporaryProvider