SCR_BaseEditableEntityUIComponent Interface Reference

Component to manage visualisation of individual entity widget. More...

Inheritance diagram for SCR_BaseEditableEntityUIComponent:

Public Member Functions
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_EditableEntityComponent	m_Entity

Detailed Description

Component to manage visualisation of individual entity widget.

• Provides base from which more specialised entity widgets can inherit (e.g., SCR_GroupEditableEntityUIComponent for showing groups).
  • Naming convention of inherited classes should be SCR_<Something>EditableEntityUIComponent.
• Attached to root widget of a layout which is linked from SCR_EntitiesEditorUIComponent.
  • Refresh() is called continuously from there to update widget position.

Member Function Documentation

Exit()

void SCR_BaseEditableEntityUIComponent.Exit

(

SCR_EditableEntityBaseSlotUIComponent

slot

)

Terminate entity widget.

Parameters

[in]

slot

GetEntity()

SCR_EditableEntityComponent SCR_BaseEditableEntityUIComponent.GetEntity

(

)

Returns

the entity which the widget represents.

GetWidget()

Widget SCR_BaseEditableEntityUIComponent.GetWidget

(

)

Returns

widget root

HandlerAttached()

override void SCR_BaseEditableEntityUIComponent.HandlerAttached

(

Widget

w

)

Init() [1/2]

void SCR_BaseEditableEntityUIComponent.Init	(	SCR_EditableEntityComponent	entity,
		SCR_EditableEntityBaseSlotUIComponent	slot
	)

Initialise entity widget using editable entity.

Parameters

[in]	entity	Editable entity which the widget represents
[in]	slot	Slot in which the icon was created

Init() [2/2]

sealed void SCR_BaseEditableEntityUIComponent.Init	(	SCR_UIInfo	info,
		SCR_EditableEntityBaseSlotUIComponent	slot
	)

Initialise entity widget using UI info.

Parameters

[in]	info	UI info representing an entity
[in]	slot	Slot in which the icon was created

IsShownOffScreen()

bool SCR_BaseEditableEntityUIComponent.IsShownOffScreen

(

)

Check if the icon is supposed to be shown on screen borders when its position is off-screen.

Returns

true when marked to show off-screen

IsVisible()

bool SCR_BaseEditableEntityUIComponent.IsVisible

(

)

Returns

true if the widget is visible, false otherwise

OnInit()

void SCR_BaseEditableEntityUIComponent.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

Implemented in SCR_HighlightedEditorUIComponent, SCR_CharacterEditableEntityUIComponent, SCR_CommentEditableEntityUIComponent, SCR_CustomArrayEditableEntityUIComponent, SCR_CustomEditableEntityUIComponent, SCR_GroupEditableEntityUIComponent, SCR_LayerEditableEntityUIComponent, SCR_PlayerEditableEntityUIComponent, and SCR_VehicleEditableEntityUIComponent.

OnRefresh()

void SCR_BaseEditableEntityUIComponent.OnRefresh

(

SCR_EditableEntityBaseSlotUIComponent

slot

)

Method called when the widget is updsted from the entity.

Parameters

[in]

slot

Slot to which this widget is attached to

Implemented in SCR_GroupEditableEntityUIComponent, and SCR_VehicleEditableEntityUIComponent.

OnShownOffScreen()

void SCR_BaseEditableEntityUIComponent.OnShownOffScreen

(

bool

offScreen

)

Method called the icon moves from on-screen to off-screen and vice versa.

Parameters

[in]

offScreen

True when off-screen

Implemented in SCR_PlayerEditableEntityUIComponent.

SetVisible()

void SCR_BaseEditableEntityUIComponent.SetVisible

(

bool

visible

)

Set visibility of the widget.

Parameters

[in]

visible

True if visible

Member Data Documentation

m_Entity

SCR_EditableEntityComponent SCR_BaseEditableEntityUIComponent.m_Entity

protected

---

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

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