SCR_CampaignBuildingCompositionComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_CampaignBuildingCompositionComponentClass

Functions
SCR_CampaignBuildingCompositionComponentClass ScriptComponentClass	Attribute ()] protected ref SCR_AudioSourceConfiguration m_AudioSourceConfigurationSpawn
override void	OnPostInit (IEntity owner)
	Called on PostInit when all components are added. More...
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. More...
override void	EOnInit (IEntity owner)
void	SetDestroyEvents ()
	Set the destroy event to root entity, when all direct child are destructible. More...
void	DestructibleEntityDestroyed (SCR_DestructionMultiPhaseComponent component)
void	CheckExistingChild ()
	Check if this entity doesn't have any child. If so, delete it. More...
protected void	SetIsCompositionSpawned ()
protected void	OnCompositionSpawned ()
	An event called on proxi when composition is spawned. More...
ScriptInvokerBool	GetOnCompositionSpawned ()
protected void	SetCompositionCost (notnull SCR_EditableEntityComponent editableEnt)
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. More...
void	SetBuilderId (int id)
int	GetBuilderId ()
void	SetInteractionLock (bool lockState)
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. More...
void	SetClearProviderEvent (notnull SCR_EditorModeEntity ent)
void	SetProviderFromRplID ()
	Set a provider, loaded from RPL ID. More...
void	CompositionBuildSound ()
	Play the sound when the composition is fully spawned. More...
protected bool	IsProxy ()
protected void	RpcDo_RemoveProviderEntity ()
protected void	RpcDo_SetProviderEntity (RplId rplCompId)
protected void	RpcDo_SetCompositionLock (bool lockState)
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)
override void	OnDelete (IEntity owner)

Variables
protected ref SCR_AudioSourceConfiguration	m_AudioSourceConfigurationDespawn
protected IEntity	m_ProviderEntity
protected RplId	m_RplCompId
private SCR_EditorModeEntity	m_EditorModeEntity
protected int	m_iBuilderId = INVALID_PLAYER_ID
protected int	m_iCost
protected int	m_iPrefabId
protected bool	m_bInteractionLock
protected bool	m_bCompositionIsSpawned
protected ref ScriptInvokerVoid	m_OnBuilderSet
protected ref ScriptInvokerBool	m_OnCompositionSpawned

Function Documentation

AfterLockChanged()

void AfterLockChanged

(

bool

lockState

)

Parameters

[in]

lockState

Definition at line 361 of file SCR_CampaignBuildingCompositionComponent.c.

Attribute()

SCR_CampaignBuildingCompositionComponentClass ScriptComponentClass Attribute

(

)

CheckExistingChild()

void CheckExistingChild

(

)

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

Definition at line 190 of file SCR_CampaignBuildingCompositionComponent.c.

CompositionBuildSound()

void CompositionBuildSound

(

)

Play the sound when the composition is fully spawned.

Definition at line 445 of file SCR_CampaignBuildingCompositionComponent.c.

DestructibleEntityDestroyed()

void DestructibleEntityDestroyed

(

SCR_DestructionMultiPhaseComponent

component

)

A destructible entity in composition was destroyed. Evaluate if there is any other left.

Parameters

[in]

component

Definition at line 182 of file SCR_CampaignBuildingCompositionComponent.c.

GetBuilderId()

int GetBuilderId

(

)

Returns

Definition at line 328 of file SCR_CampaignBuildingCompositionComponent.c.

GetCompositionCost()

int GetCompositionCost

(

)

Returns

Definition at line 266 of file SCR_CampaignBuildingCompositionComponent.c.

GetOnBuilderSet()

ScriptInvokerVoid GetOnBuilderSet

(

)

Returns

Definition at line 288 of file SCR_CampaignBuildingCompositionComponent.c.

GetOnCompositionSpawned()

ScriptInvokerBool GetOnCompositionSpawned

(

)

Returns

Definition at line 231 of file SCR_CampaignBuildingCompositionComponent.c.

GetOutlineToSpawn()

ResourceName GetOutlineToSpawn

(

notnull SCR_EditableEntityComponent

entity

)

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

Definition at line 109 of file SCR_CampaignBuildingCompositionComponent.c.

GetPrefabId()

int GetPrefabId

(

)

Returns

Definition at line 273 of file SCR_CampaignBuildingCompositionComponent.c.

GetProviderEntity()

IEntity GetProviderEntity

(

)

Returns

Definition at line 307 of file SCR_CampaignBuildingCompositionComponent.c.

IsCompositionSpawned()

bool IsCompositionSpawned

(

)

Returns

Definition at line 281 of file SCR_CampaignBuildingCompositionComponent.c.

IsInteractionLocked()

bool IsInteractionLocked

(

)

Returns

Definition at line 352 of file SCR_CampaignBuildingCompositionComponent.c.

IsProxy()

protected bool IsProxy

(

)

Definition at line 456 of file SCR_CampaignBuildingCompositionComponent.c.

OnCompositionSpawned()

protected void OnCompositionSpawned

(

)

An event called on proxi when composition is spawned.

Definition at line 221 of file SCR_CampaignBuildingCompositionComponent.c.

RemoveProviderEntity()

void RemoveProviderEntity

(

)

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

Definition at line 314 of file SCR_CampaignBuildingCompositionComponent.c.

RemoveProviderEntityServer()

void RemoveProviderEntityServer

(

)

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

Definition at line 414 of file SCR_CampaignBuildingCompositionComponent.c.

RpcDo_RemoveProviderEntity()

protected void RpcDo_RemoveProviderEntity

(

)

Definition at line 464 of file SCR_CampaignBuildingCompositionComponent.c.

RpcDo_SetCompositionLock()

protected void RpcDo_SetCompositionLock

(

bool

lockState

)

Definition at line 484 of file SCR_CampaignBuildingCompositionComponent.c.

RpcDo_SetProviderEntity()

protected void RpcDo_SetProviderEntity

(

RplId

rplCompId

)

Definition at line 471 of file SCR_CampaignBuildingCompositionComponent.c.

RplLoad()

override bool RplLoad

(

ScriptBitReader

reader

)

Definition at line 514 of file SCR_CampaignBuildingCompositionComponent.c.

RplSave()

override bool RplSave

(

ScriptBitWriter

writer

)

Definition at line 490 of file SCR_CampaignBuildingCompositionComponent.c.

SetBuilderId()

void SetBuilderId

(

int

id

)

Parameters

[in]

id

Definition at line 321 of file SCR_CampaignBuildingCompositionComponent.c.

SetClearProviderEvent()

void SetClearProviderEvent

(

notnull SCR_EditorModeEntity

ent

)

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

Parameters

[in]

ent

Definition at line 425 of file SCR_CampaignBuildingCompositionComponent.c.

SetCompositionCost()

protected void SetCompositionCost

(

notnull SCR_EditableEntityComponent

editableEnt

)

Gets the composition cost from editable entity component.

Parameters

[in]

editableEnt

Definition at line 242 of file SCR_CampaignBuildingCompositionComponent.c.

SetDestroyEvents()

void SetDestroyEvents

(

)

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

Definition at line 144 of file SCR_CampaignBuildingCompositionComponent.c.

SetInteractionLock()

void 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

Definition at line 336 of file SCR_CampaignBuildingCompositionComponent.c.

SetInteractionLockServer()

void SetInteractionLockServer

(

bool

lockState

)

Parameters

[in]

lockState

Definition at line 344 of file SCR_CampaignBuildingCompositionComponent.c.

SetIsCompositionSpawned()

protected void SetIsCompositionSpawned

(

)

Definition at line 198 of file SCR_CampaignBuildingCompositionComponent.c.

SetPrefabId()

void SetPrefabId

(

int

prefabId

)

Parameters

[in]

prefabId

Definition at line 259 of file SCR_CampaignBuildingCompositionComponent.c.

SetProviderEntity()

void SetProviderEntity

(

IEntity

newOwner

)

Parameters

[in]

newOwner

Definition at line 298 of file SCR_CampaignBuildingCompositionComponent.c.

SetProviderEntityServer()

void SetProviderEntityServer

(

IEntity

newOwner

)

Parameters

[in]

newOwner

Definition at line 396 of file SCR_CampaignBuildingCompositionComponent.c.

SetProviderFromRplID()

void SetProviderFromRplID

(

)

Set a provider, loaded from RPL ID.

Definition at line 433 of file SCR_CampaignBuildingCompositionComponent.c.

SpawnCompositionLayout()

void SpawnCompositionLayout	(	int	prefabId,
		SCR_EditableEntityComponent	entity
	)

Parameters

[in]	prefabId
[in]	entity

Definition at line 73 of file SCR_CampaignBuildingCompositionComponent.c.

Variable Documentation

m_AudioSourceConfigurationDespawn

protected ref SCR_AudioSourceConfiguration m_AudioSourceConfigurationDespawn

Definition at line 12 of file SCR_CampaignBuildingCompositionComponent.c.

m_bCompositionIsSpawned

protected bool m_bCompositionIsSpawned

Definition at line 24 of file SCR_CampaignBuildingCompositionComponent.c.

m_bInteractionLock

protected bool m_bInteractionLock

Definition at line 21 of file SCR_CampaignBuildingCompositionComponent.c.

m_EditorModeEntity

private SCR_EditorModeEntity m_EditorModeEntity

Definition at line 17 of file SCR_CampaignBuildingCompositionComponent.c.

m_iBuilderId

protected int m_iBuilderId = INVALID_PLAYER_ID

Definition at line 18 of file SCR_CampaignBuildingCompositionComponent.c.

m_iCost

protected int m_iCost

Definition at line 19 of file SCR_CampaignBuildingCompositionComponent.c.

m_iPrefabId

protected int m_iPrefabId

Definition at line 20 of file SCR_CampaignBuildingCompositionComponent.c.

m_OnBuilderSet

protected ref ScriptInvokerVoid m_OnBuilderSet

Definition at line 26 of file SCR_CampaignBuildingCompositionComponent.c.

m_OnCompositionSpawned

protected ref ScriptInvokerBool m_OnCompositionSpawned

Definition at line 27 of file SCR_CampaignBuildingCompositionComponent.c.

m_ProviderEntity

protected IEntity m_ProviderEntity

Definition at line 15 of file SCR_CampaignBuildingCompositionComponent.c.

m_RplCompId

protected RplId m_RplCompId

Definition at line 16 of file SCR_CampaignBuildingCompositionComponent.c.