SCR_LayerEditableEntityUIComponent Interface Reference

Inheritance diagram for SCR_LayerEditableEntityUIComponent:

Public Member Functions
override void	OnInit (SCR_EditableEntityComponent entity, SCR_UIInfo info, SCR_EditableEntityBaseSlotUIComponent slot)
	Method called when the widget is initialised.
override void	HandlerDeattached (Widget w)
Public Member Functions inherited from SCR_BaseEditableEntityUIComponent
void	OnRefresh (SCR_EditableEntityBaseSlotUIComponent slot)
	Method called when the widget is updsted from the entity.
void	OnInit (SCR_EditableEntityComponent entity, SCR_UIInfo info, SCR_EditableEntityBaseSlotUIComponent slot)
	Method called when the widget is initialised.
void	OnShownOffScreen (bool offScreen)
	Method called the icon moves from on-screen to off-screen and vice versa.
void	Init (SCR_EditableEntityComponent entity, SCR_EditableEntityBaseSlotUIComponent slot)
	Initialise entity widget using editable entity.
sealed void	Init (SCR_UIInfo info, SCR_EditableEntityBaseSlotUIComponent slot)
	Initialise entity widget using UI info.
void	Exit (SCR_EditableEntityBaseSlotUIComponent slot)
	Terminate entity widget.
SCR_EditableEntityComponent	GetEntity ()
Widget	GetWidget ()
bool	IsVisible ()
void	SetVisible (bool visible)
	Set visibility of the widget.
bool	IsShownOffScreen ()
	Check if the icon is supposed to be shown on screen borders when its position is off-screen.
override void	HandlerAttached (Widget w)

Protected Member Functions
void	OnParentEntityChanged (SCR_EditableEntityComponent entity, SCR_EditableEntityComponent parent, SCR_EditableEntityComponent parentPrev)

Protected Attributes
string	m_sEmptyIconWidgetName
string	m_sLayerIconWidgetName
bool	m_bIsCustom
Protected Attributes inherited from SCR_BaseEditableEntityUIComponent
SCR_EditableEntityComponent	m_Entity

Member Function Documentation

HandlerDeattached()

override void SCR_LayerEditableEntityUIComponent.HandlerDeattached

(

Widget

w

)

OnInit()

override void SCR_LayerEditableEntityUIComponent.OnInit	(	SCR_EditableEntityComponent	entity,
		SCR_UIInfo	info,
		SCR_EditableEntityBaseSlotUIComponent	slot
	)

Method called when the widget is initialised.

Parameters

[in]	entity	Editable entity
[in]	slot	Slot to which this widget is attached to

Implements SCR_BaseEditableEntityUIComponent.

OnParentEntityChanged()

void SCR_LayerEditableEntityUIComponent.OnParentEntityChanged ( SCR_EditableEntityComponent  entity, SCR_EditableEntityComponent  parent, SCR_EditableEntityComponent  parentPrev  )

protected

Member Data Documentation

m_bIsCustom

bool SCR_LayerEditableEntityUIComponent.m_bIsCustom

protected

m_sEmptyIconWidgetName

string SCR_LayerEditableEntityUIComponent.m_sEmptyIconWidgetName

protected

m_sLayerIconWidgetName

string SCR_LayerEditableEntityUIComponent.m_sLayerIconWidgetName

protected

---

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

• Game/Editor/UI/Components/EditableEntities/SCR_LayerEditableEntityUIComponent.c