SCR_VehicleEditableEntityUIComponent Interface Reference

Inheritance diagram for SCR_VehicleEditableEntityUIComponent:

Public Member Functions
void	DetermineNameVisibility ()
override void	OnInit (SCR_EditableEntityComponent entity, SCR_UIInfo info, SCR_EditableEntityBaseSlotUIComponent slot)
	Method called when the widget is initialised.
override void	OnRefresh (SCR_EditableEntityBaseSlotUIComponent slot)
	Method called when the widget is updsted from the entity.
override bool	OnUpdate (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 Attributes
string	m_sNameTextWidgetName
string	m_sVehicleNameText
RichTextWidget	m_wNameTextWidget
SCR_EditableVehicleComponent	m_VehicleComponent
SCR_EditableCharacterComponent	m_VehicleOwningPlayer
BaseWorld	m_World
SCR_RenderedEditableEntityFilter	m_RenderFilter
Protected Attributes inherited from SCR_BaseEditableEntityUIComponent
SCR_EditableEntityComponent	m_Entity

Member Function Documentation

DetermineNameVisibility()

void SCR_VehicleEditableEntityUIComponent.DetermineNameVisibility

(

)

OnInit()

override void SCR_VehicleEditableEntityUIComponent.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_VehicleEditableEntityUIComponent.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.

OnUpdate()

override bool SCR_VehicleEditableEntityUIComponent.OnUpdate

(

Widget

w

)

Member Data Documentation

m_RenderFilter

SCR_RenderedEditableEntityFilter SCR_VehicleEditableEntityUIComponent.m_RenderFilter

protected

m_sNameTextWidgetName

string SCR_VehicleEditableEntityUIComponent.m_sNameTextWidgetName

protected

m_sVehicleNameText

string SCR_VehicleEditableEntityUIComponent.m_sVehicleNameText

protected

m_VehicleComponent

SCR_EditableVehicleComponent SCR_VehicleEditableEntityUIComponent.m_VehicleComponent

protected

m_VehicleOwningPlayer

SCR_EditableCharacterComponent SCR_VehicleEditableEntityUIComponent.m_VehicleOwningPlayer

protected

m_wNameTextWidget

RichTextWidget SCR_VehicleEditableEntityUIComponent.m_wNameTextWidget

protected

m_World

BaseWorld SCR_VehicleEditableEntityUIComponent.m_World

protected

---

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

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