SCR_PlayerEditableEntityUIComponent Interface Reference

Inheritance diagram for SCR_PlayerEditableEntityUIComponent:

Public Member Functions
override void	OnShownOffScreen (bool offScreen)
	Method called the icon moves from on-screen to off-screen and vice versa.
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
void	SetName (TextWidget nameWidget, int playerID)

Protected Attributes
ref Color	m_ColorPossessed
string	m_sPlayerNameWidgetName
string	m_sPlatformIconWidgetName
Protected Attributes inherited from SCR_BaseEditableEntityUIComponent
SCR_EditableEntityComponent	m_Entity

Member Function Documentation

OnInit()

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

OnShownOffScreen()

override void SCR_PlayerEditableEntityUIComponent.OnShownOffScreen

(

bool

offScreen

)

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

Parameters

[in]

offScreen

True when off-screen

Implements SCR_BaseEditableEntityUIComponent.

SetName()

void SCR_PlayerEditableEntityUIComponent.SetName ( TextWidget  nameWidget, int  playerID  )

protected

Member Data Documentation

m_ColorPossessed

ref Color SCR_PlayerEditableEntityUIComponent.m_ColorPossessed

protected

m_sPlatformIconWidgetName

string SCR_PlayerEditableEntityUIComponent.m_sPlatformIconWidgetName

protected

m_sPlayerNameWidgetName

string SCR_PlayerEditableEntityUIComponent.m_sPlayerNameWidgetName

protected

---

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

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