SCR_GroupEditableEntityUIComponent Interface Reference

Inheritance diagram for SCR_GroupEditableEntityUIComponent:

Public Member Functions
override void	OnRefresh (SCR_EditableEntityBaseSlotUIComponent slot)
	Method called when the widget is updsted from the entity.
override void	OnInit (SCR_EditableEntityComponent entity, SCR_UIInfo info, SCR_EditableEntityBaseSlotUIComponent slot)
	Method called when the widget is initialised.
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
bool	RefreshSymbol (SCR_EditableEntityComponent entity)
bool	RefreshSymbol (SCR_UIInfo info)
bool	RefreshSymbol (SCR_MilitarySymbol symbol)

Protected Attributes
ref array< ref SCR_GroupEditableEntityTextureUIComponent >	m_Textures
string	m_sIconWidgetName
SCR_MilitarySymbolUIComponent	m_SymbolUI
Protected Attributes inherited from SCR_BaseEditableEntityUIComponent
SCR_EditableEntityComponent	m_Entity

Member Function Documentation

OnInit()

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

OnRefresh()

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

Implements SCR_BaseEditableEntityUIComponent.

RefreshSymbol() [1/3]

bool SCR_GroupEditableEntityUIComponent.RefreshSymbol ( SCR_EditableEntityComponent  entity )

protected

RefreshSymbol() [2/3]

bool SCR_GroupEditableEntityUIComponent.RefreshSymbol ( SCR_MilitarySymbol  symbol )

protected

RefreshSymbol() [3/3]

bool SCR_GroupEditableEntityUIComponent.RefreshSymbol ( SCR_UIInfo  info )

protected

Member Data Documentation

m_sIconWidgetName

string SCR_GroupEditableEntityUIComponent.m_sIconWidgetName

protected

m_SymbolUI

SCR_MilitarySymbolUIComponent SCR_GroupEditableEntityUIComponent.m_SymbolUI

protected

m_Textures

ref array<ref SCR_GroupEditableEntityTextureUIComponent> SCR_GroupEditableEntityUIComponent.m_Textures

protected

---

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

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