SCR_CommentEditableEntityUIComponent Interface Reference

Inheritance diagram for SCR_CommentEditableEntityUIComponent:

Public Member Functions
override void	OnInit (SCR_EditableEntityComponent entity, SCR_UIInfo info, SCR_EditableEntityBaseSlotUIComponent slot)
	Method called when the widget is initialised.
void	OnEntityChanged (SCR_CompositionSlotManagerComponent slotManager, IEntity slot)
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 Attributes
SCR_ContentBrowserEditorComponent	m_ContentBrowserComponent
Widget	m_wExtendedIcon
Protected Attributes inherited from SCR_BaseEditableEntityUIComponent
SCR_EditableEntityComponent	m_Entity

Static Protected Attributes
static const string	WIDGET_TEXT = "Text"
static const string	WIDGET_ICON = "Icon"
static const string	WIDGET_EXTENDED_ICON = "Icon_ExtendablePrefabs"

Member Function Documentation

OnEntityChanged()

void SCR_CommentEditableEntityUIComponent.OnEntityChanged	(	SCR_CompositionSlotManagerComponent	slotManager,
		IEntity	slot
	)

Parameters

[in]	slotManager
[in]	slot

OnInit()

override void SCR_CommentEditableEntityUIComponent.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.

Member Data Documentation

m_ContentBrowserComponent

SCR_ContentBrowserEditorComponent SCR_CommentEditableEntityUIComponent.m_ContentBrowserComponent

protected

m_wExtendedIcon

Widget SCR_CommentEditableEntityUIComponent.m_wExtendedIcon

protected

WIDGET_EXTENDED_ICON

const string SCR_CommentEditableEntityUIComponent.WIDGET_EXTENDED_ICON = "Icon_ExtendablePrefabs"

staticprotected

WIDGET_ICON

const string SCR_CommentEditableEntityUIComponent.WIDGET_ICON = "Icon"

staticprotected

WIDGET_TEXT

const string SCR_CommentEditableEntityUIComponent.WIDGET_TEXT = "Text"

staticprotected

---

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

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