SCR_EditorLinkComponent Interface Reference

Link which creates replicated entity. More...

Inheritance diagram for SCR_EditorLinkComponent:

Public Member Functions
ScriptInvoker	GetOnLinkedEntitiesSpawned ()
bool	IsSpawningIgnored ()
bool	IsSpawned ()
override void	EOnInit (IEntity owner)
override void	OnPostInit (IEntity owner)
void	SpawnComposition ()

Static Public Member Functions
static void	IgnoreSpawning (bool ignore)
	Ignore spawning entity links in the next spawned prefab with this component.
static bool	IsSpawned (SCR_EditableEntityComponent entity)
	Check if linked children of editable entity were spawned.

Protected Attributes
bool	m_bIsSpawned
ref ScriptInvoker	m_OnLinkedEntitiesSpawned

Static Protected Attributes
static bool	s_bIgnoreSpawning

Detailed Description

Link which creates replicated entity.

To be use in composition prefabs which cannot contain nested replicated entities;

Member Function Documentation

EOnInit()

override void SCR_EditorLinkComponent.EOnInit

(

IEntity

owner

)

GetOnLinkedEntitiesSpawned()

ScriptInvoker SCR_EditorLinkComponent.GetOnLinkedEntitiesSpawned

(

)

Returns

Event called after all linked entities were spawned

IgnoreSpawning()

static void SCR_EditorLinkComponent.IgnoreSpawning ( bool  ignore )

static

Ignore spawning entity links in the next spawned prefab with this component.

Used when some other system handles spawning independently. Has to be set before spawning the prefab, is reset to false afterwards.

Parameters

ignore

True to ignore spawning

IsSpawned() [1/2]

bool SCR_EditorLinkComponent.IsSpawned

(

)

Returns

True if all linked children were spawned

IsSpawned() [2/2]

static bool SCR_EditorLinkComponent.IsSpawned ( SCR_EditableEntityComponent  entity )

static

Check if linked children of editable entity were spawned.

Parameters

entity

Editable entity

Returns

True if all linked children were spawned

IsSpawningIgnored()

bool SCR_EditorLinkComponent.IsSpawningIgnored

(

)

Returns

true if spawning is set to be ignored

OnPostInit()

override void SCR_EditorLinkComponent.OnPostInit

(

IEntity

owner

)

SpawnComposition()

void SCR_EditorLinkComponent.SpawnComposition

(

)

Member Data Documentation

m_bIsSpawned

bool SCR_EditorLinkComponent.m_bIsSpawned

protected

m_OnLinkedEntitiesSpawned

ref ScriptInvoker SCR_EditorLinkComponent.m_OnLinkedEntitiesSpawned

protected

s_bIgnoreSpawning

bool SCR_EditorLinkComponent.s_bIgnoreSpawning

staticprotected

---

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

• Game/Editor/Components/Misc/SCR_EditorLinkComponent.c