SCR_EditableEntityBaseChildComponent Interface Reference

Base class for child editable entity component. More...

Inheritance diagram for SCR_EditableEntityBaseChildComponent:

Public Member Functions
void	EOnStateChanged (EEditableEntityState states, EEditableEntityState changedState, bool toSet)
	Event called every time state of editable entity changes.
void	UpdateFromCurrentState ()
	Update based on current state of editable entity.
bool	CanApply (EEditableEntityState changedState)
	Check if effects controlled y this component can be applied when given state changes.
void	SCR_EditableEntityBaseChildComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Protected Attributes
EEditableEntityState	m_State
GenericEntity	m_Owner

Detailed Description

Base class for child editable entity component.

When this component is attached to editable entity or one of its children in hierarchy (default hierarchy, not editor one), it will receive events when state of the editable entity changes. Used to manage visualization of entity avatar's, e.g., to show virtual entity and change its color when it's selected.

Constructor & Destructor Documentation

SCR_EditableEntityBaseChildComponent()

void SCR_EditableEntityBaseChildComponent.SCR_EditableEntityBaseChildComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent
	)

Parameters

[in]	src
[in]	ent
[in]	parent

Member Function Documentation

CanApply()

bool SCR_EditableEntityBaseChildComponent.CanApply

(

EEditableEntityState

changedState

)

Check if effects controlled y this component can be applied when given state changes.

Parameters

[in]

changedState

Changed state

Returns

True if the component can be applied

EOnStateChanged()

void SCR_EditableEntityBaseChildComponent.EOnStateChanged	(	EEditableEntityState	states,
		EEditableEntityState	changedState,
		bool	toSet
	)

Event called every time state of editable entity changes.

Parameters

[in]	states	currently active states
[in]	changedState	changed state
[in]	toSet	true if the state was enabled, false if it was disabled

Implemented in SCR_EditableEntityMaterialChildComponent, and SCR_EditableEntityVisibilityChildComponent.

UpdateFromCurrentState()

void SCR_EditableEntityBaseChildComponent.UpdateFromCurrentState

(

)

Update based on current state of editable entity.

Member Data Documentation

m_Owner

GenericEntity SCR_EditableEntityBaseChildComponent.m_Owner

protected

m_State

EEditableEntityState SCR_EditableEntityBaseChildComponent.m_State

protected

---

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

• Game/Editor/Components/EditableEntityChild/SCR_EditableEntityBaseChildComponent.c