Inheritance diagram for SCR_CampaignBuildingCompositionComponent:

Public Member Functions
override void	OnPostInit (IEntity owner)

void	SpawnCompositionLayout (int prefabId, SCR_EditableEntityComponent entity)

ResourceName	GetOutlineToSpawn (notnull SCR_EditableEntityComponent entity)
	Search for the outline that is assigned to this composition to be spawned.

override void	EOnInit (IEntity owner)

void	SetDestroyEvents ()
	Set the destroy event to root entity, when all direct child are destructible.

void	DestructibleEntityDestroyed (SCR_DestructionMultiPhaseComponent component)
	A destructible entity in composition was destroyed.

void	CheckExistingChild ()
	Check if this entity doesn't have any child. If so, delete it.

ScriptInvokerBool	GetOnCompositionSpawned ()

void	SetPrefabId (int prefabId)

int	GetCompositionCost ()

int	GetPrefabId ()

bool	IsCompositionSpawned ()

ScriptInvokerVoid	GetOnBuilderSet ()

void	SetProviderEntity (IEntity newOwner)

IEntity	GetProviderEntity ()

void	RemoveProviderEntity ()
	Remove provider entity when the provider is not a base and the building mode was terminated.

void	SetBuilderId (int id)

int	GetBuilderId ()

void	SetInteractionLock (bool lockState)
	Set the lock of the composition.

void	SetInteractionLockServer (bool lockState)

bool	IsInteractionLocked ()

void	AfterLockChanged (bool lockState)

void	SetProviderEntityServer (IEntity newOwner)

void	RemoveProviderEntityServer ()
	Remove provider entity when the provider is not a base and the building mode was terminated. Called on server from invoker.

void	SetClearProviderEvent (notnull SCR_EditorModeEntity ent)
	Set an event to remove a provider from composition component when the building mode is terminated.

void	SetProviderFromRplID ()
	Set a provider, loaded from RPL ID.

void	CompositionBuildSound ()
	Play the sound when the composition is fully spawned.

void	SetCanPlaySoundOnDeletion (bool val)

override bool	RplSave (ScriptBitWriter writer)

override bool	RplLoad (ScriptBitReader reader)

override void	OnDelete (IEntity owner)

Protected Member Functions
void	SetIsCompositionSpawned ()

void	OnCompositionSpawned ()
	An event called on proxi when composition is spawned.

void	SetCompositionCost (notnull SCR_EditableEntityComponent editableEnt)
	Gets the composition cost from editable entity component.

bool	IsProxy ()

void	RpcDo_RemoveProviderEntity ()

void	RpcDo_SetProviderEntity (RplId rplCompId)

void	RpcDo_SetCompositionLock (bool lockState)

Protected Attributes
ref SCR_AudioSourceConfiguration	m_AudioSourceConfigurationSpawn

ref SCR_AudioSourceConfiguration	m_AudioSourceConfigurationDespawn

IEntity	m_ProviderEntity

RplId	m_RplCompId

int	m_iBuilderId = INVALID_PLAYER_ID

int	m_iCost

int	m_iPrefabId

bool	m_bInteractionLock

bool	m_bPlaySoundOnDeletion

bool	m_bCompositionIsSpawned

ref ScriptInvokerVoid	m_OnBuilderSet

ref ScriptInvokerBool	m_OnCompositionSpawned

Static Protected Attributes
static const int	INVALID_PLAYER_ID = 0

Member Function Documentation

◆ AfterLockChanged()

void SCR_CampaignBuildingCompositionComponent.AfterLockChanged ( bool lockState )

Parameters

[in] lockState

◆ CheckExistingChild()

void SCR_CampaignBuildingCompositionComponent.CheckExistingChild ( )

Check if this entity doesn't have any child. If so, delete it.

◆ CompositionBuildSound()

void SCR_CampaignBuildingCompositionComponent.CompositionBuildSound ( )

Play the sound when the composition is fully spawned.

◆ DestructibleEntityDestroyed()

void SCR_CampaignBuildingCompositionComponent.DestructibleEntityDestroyed ( SCR_DestructionMultiPhaseComponent component )

A destructible entity in composition was destroyed.

Evaluate if there is any other left.

Parameters

[in] component

◆ EOnInit()

override void SCR_CampaignBuildingCompositionComponent.EOnInit ( IEntity owner )

◆ GetBuilderId()

int SCR_CampaignBuildingCompositionComponent.GetBuilderId ( )

Returns

◆ GetCompositionCost()

int SCR_CampaignBuildingCompositionComponent.GetCompositionCost ( )

Returns

◆ GetOnBuilderSet()

ScriptInvokerVoid SCR_CampaignBuildingCompositionComponent.GetOnBuilderSet ( )

Returns

◆ GetOnCompositionSpawned()

ScriptInvokerBool SCR_CampaignBuildingCompositionComponent.GetOnCompositionSpawned ( )

Returns

◆ GetOutlineToSpawn()

ResourceName SCR_CampaignBuildingCompositionComponent.GetOutlineToSpawn ( notnull SCR_EditableEntityComponent entity )

Search for the outline that is assigned to this composition to be spawned.

◆ GetPrefabId()

int SCR_CampaignBuildingCompositionComponent.GetPrefabId ( )

Returns

◆ GetProviderEntity()

IEntity SCR_CampaignBuildingCompositionComponent.GetProviderEntity ( )

Returns

◆ IsCompositionSpawned()

bool SCR_CampaignBuildingCompositionComponent.IsCompositionSpawned ( )

Returns

◆ IsInteractionLocked()

bool SCR_CampaignBuildingCompositionComponent.IsInteractionLocked ( )

Returns

◆ IsProxy()

bool SCR_CampaignBuildingCompositionComponent.IsProxy ( )

protected

◆ OnCompositionSpawned()

void SCR_CampaignBuildingCompositionComponent.OnCompositionSpawned ( )

protected

An event called on proxi when composition is spawned.

◆ OnDelete()

override void SCR_CampaignBuildingCompositionComponent.OnDelete ( IEntity owner )

◆ OnPostInit()

override void SCR_CampaignBuildingCompositionComponent.OnPostInit ( IEntity owner )

◆ RemoveProviderEntity()

void SCR_CampaignBuildingCompositionComponent.RemoveProviderEntity ( )

Remove provider entity when the provider is not a base and the building mode was terminated.

◆ RemoveProviderEntityServer()

void SCR_CampaignBuildingCompositionComponent.RemoveProviderEntityServer ( )

Remove provider entity when the provider is not a base and the building mode was terminated. Called on server from invoker.

◆ RpcDo_RemoveProviderEntity()

void SCR_CampaignBuildingCompositionComponent.RpcDo_RemoveProviderEntity ( )

protected

◆ RpcDo_SetCompositionLock()

void SCR_CampaignBuildingCompositionComponent.RpcDo_SetCompositionLock ( bool lockState )

protected

◆ RpcDo_SetProviderEntity()

void SCR_CampaignBuildingCompositionComponent.RpcDo_SetProviderEntity ( RplId rplCompId )

protected

◆ RplLoad()

override bool SCR_CampaignBuildingCompositionComponent.RplLoad ( ScriptBitReader reader )

◆ RplSave()

override bool SCR_CampaignBuildingCompositionComponent.RplSave ( ScriptBitWriter writer )

◆ SetBuilderId()

void SCR_CampaignBuildingCompositionComponent.SetBuilderId ( int id )

Parameters

[in] id

◆ SetCanPlaySoundOnDeletion()

void SCR_CampaignBuildingCompositionComponent.SetCanPlaySoundOnDeletion ( bool val )

◆ SetClearProviderEvent()

void SCR_CampaignBuildingCompositionComponent.SetClearProviderEvent ( notnull SCR_EditorModeEntity ent )

Set an event to remove a provider from composition component when the building mode is terminated.

Parameters

[in] ent

◆ SetCompositionCost()

void SCR_CampaignBuildingCompositionComponent.SetCompositionCost ( notnull SCR_EditableEntityComponent editableEnt )

protected

Gets the composition cost from editable entity component.

Parameters

[in] editableEnt

◆ SetDestroyEvents()

void SCR_CampaignBuildingCompositionComponent.SetDestroyEvents ( )

Set the destroy event to root entity, when all direct child are destructible.

◆ SetInteractionLock()

void SCR_CampaignBuildingCompositionComponent.SetInteractionLock ( bool lockState )

Set the lock of the composition.

When set, the composition can't be moved or deleted from Free Roam mode anymore.

Parameters

[in] lockState

◆ SetInteractionLockServer()

void SCR_CampaignBuildingCompositionComponent.SetInteractionLockServer ( bool lockState )

Parameters

[in] lockState

◆ SetIsCompositionSpawned()

void SCR_CampaignBuildingCompositionComponent.SetIsCompositionSpawned ( )

protected

◆ SetPrefabId()

void SCR_CampaignBuildingCompositionComponent.SetPrefabId ( int prefabId )

Parameters

[in] prefabId

◆ SetProviderEntity()

void SCR_CampaignBuildingCompositionComponent.SetProviderEntity ( IEntity newOwner )

Parameters

[in] newOwner

◆ SetProviderEntityServer()

void SCR_CampaignBuildingCompositionComponent.SetProviderEntityServer ( IEntity newOwner )

Parameters

[in] newOwner

◆ SetProviderFromRplID()

void SCR_CampaignBuildingCompositionComponent.SetProviderFromRplID ( )

Set a provider, loaded from RPL ID.

◆ SpawnCompositionLayout()

void SCR_CampaignBuildingCompositionComponent.SpawnCompositionLayout	(	int	prefabId,
		SCR_EditableEntityComponent	entity )

Parameters

[in]	prefabId
[in]	entity

Member Data Documentation

◆ INVALID_PLAYER_ID

const int SCR_CampaignBuildingCompositionComponent.INVALID_PLAYER_ID = 0

staticprotected

◆ m_AudioSourceConfigurationDespawn

ref SCR_AudioSourceConfiguration SCR_CampaignBuildingCompositionComponent.m_AudioSourceConfigurationDespawn

protected

◆ m_AudioSourceConfigurationSpawn

ref SCR_AudioSourceConfiguration SCR_CampaignBuildingCompositionComponent.m_AudioSourceConfigurationSpawn

protected

◆ m_bCompositionIsSpawned

bool SCR_CampaignBuildingCompositionComponent.m_bCompositionIsSpawned

protected

◆ m_bInteractionLock

bool SCR_CampaignBuildingCompositionComponent.m_bInteractionLock

protected

◆ m_bPlaySoundOnDeletion

bool SCR_CampaignBuildingCompositionComponent.m_bPlaySoundOnDeletion

protected

◆ m_iBuilderId

int SCR_CampaignBuildingCompositionComponent.m_iBuilderId = INVALID_PLAYER_ID

protected

◆ m_iCost

int SCR_CampaignBuildingCompositionComponent.m_iCost

protected

◆ m_iPrefabId

int SCR_CampaignBuildingCompositionComponent.m_iPrefabId

protected

◆ m_OnBuilderSet

ref ScriptInvokerVoid SCR_CampaignBuildingCompositionComponent.m_OnBuilderSet

protected

◆ m_OnCompositionSpawned

ref ScriptInvokerBool SCR_CampaignBuildingCompositionComponent.m_OnCompositionSpawned

protected

◆ m_ProviderEntity

IEntity SCR_CampaignBuildingCompositionComponent.m_ProviderEntity

protected

◆ m_RplCompId

RplId SCR_CampaignBuildingCompositionComponent.m_RplCompId

protected

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

Game/Building/SCR_CampaignBuildingCompositionComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Function Documentation

◆ AfterLockChanged()

◆ CheckExistingChild()

◆ CompositionBuildSound()

◆ DestructibleEntityDestroyed()

◆ EOnInit()

◆ GetBuilderId()

◆ GetCompositionCost()

◆ GetOnBuilderSet()

◆ GetOnCompositionSpawned()

◆ GetOutlineToSpawn()

◆ GetPrefabId()

◆ GetProviderEntity()

◆ IsCompositionSpawned()

◆ IsInteractionLocked()

◆ IsProxy()

◆ OnCompositionSpawned()

◆ OnDelete()

◆ OnPostInit()

◆ RemoveProviderEntity()

◆ RemoveProviderEntityServer()

◆ RpcDo_RemoveProviderEntity()

◆ RpcDo_SetCompositionLock()

◆ RpcDo_SetProviderEntity()

◆ RplLoad()

◆ RplSave()

◆ SetBuilderId()

◆ SetCanPlaySoundOnDeletion()

◆ SetClearProviderEvent()

◆ SetCompositionCost()

◆ SetDestroyEvents()

◆ SetInteractionLock()

◆ SetInteractionLockServer()

◆ SetIsCompositionSpawned()

◆ SetPrefabId()

◆ SetProviderEntity()

◆ SetProviderEntityServer()

◆ SetProviderFromRplID()

◆ SpawnCompositionLayout()

Member Data Documentation

◆ INVALID_PLAYER_ID

◆ m_AudioSourceConfigurationDespawn

◆ m_AudioSourceConfigurationSpawn

◆ m_bCompositionIsSpawned

◆ m_bInteractionLock

◆ m_bPlaySoundOnDeletion

◆ m_iBuilderId

◆ m_iCost

◆ m_iPrefabId

◆ m_OnBuilderSet

◆ m_OnCompositionSpawned

◆ m_ProviderEntity

◆ m_RplCompId