SCR_EditableEntityLinkUIComponent Interface Reference

Inheritance diagram for SCR_EditableEntityLinkUIComponent:

Public Member Functions
void	SetLinkedEntity (SCR_EditableEntityComponent entity)
	Set the entity this widget represents.
SCR_EditableEntityComponent	GetLinkedEntity ()
	Get the entity this widget represents.
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
override bool	IsUnique ()
	Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.
override void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
Public Member Functions inherited from MenuRootSubComponent
Widget	GetWidget ()
	Get widget to which the component belongs to.
MenuRootBase	GetMenu ()
	Get menu of which the widget is part of.
MenuRootComponent	GetRootComponent ()
	Get root component of this subcomponent,.
void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)

Protected Member Functions
void	OnMenuUpdate ()
bool	IsUnique ()
	Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.

Protected Attributes
SCR_EditableEntityComponent	m_LinkedEntity
SCR_HoverEditableEntityFilter	m_HoverManager

Member Function Documentation

GetLinkedEntity()

SCR_EditableEntityComponent SCR_EditableEntityLinkUIComponent.GetLinkedEntity

(

)

Get the entity this widget represents.

Returns

Editable entity

HandlerAttachedScripted()

override void SCR_EditableEntityLinkUIComponent.HandlerAttachedScripted

(

Widget

w

)

Event called when subcomponent is initialized.

Called only after all other subcomponents were registered as well and can be searched for. To be overwritten by inherited classes.

Parameters

Widget

Implements MenuRootSubComponent.

IsUnique()

override bool SCR_EditableEntityLinkUIComponent.IsUnique

(

)

Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.

To be overwritten by inherited classes.

Returns

True if unique

Implements MenuRootSubComponent.

OnMenuUpdate()

void SCR_EditableEntityLinkUIComponent.OnMenuUpdate ( )

protected

OnMouseEnter()

override bool SCR_EditableEntityLinkUIComponent.OnMouseEnter	(	Widget	w,
		int	x,
		int	y
	)

OnMouseLeave()

override bool SCR_EditableEntityLinkUIComponent.OnMouseLeave	(	Widget	w,
		Widget	enterW,
		int	x,
		int	y
	)

SetLinkedEntity()

void SCR_EditableEntityLinkUIComponent.SetLinkedEntity

(

SCR_EditableEntityComponent

entity

)

Set the entity this widget represents.

Parameters

[in]

entity

Editable entity

Member Data Documentation

m_HoverManager

SCR_HoverEditableEntityFilter SCR_EditableEntityLinkUIComponent.m_HoverManager

protected

m_LinkedEntity

SCR_EditableEntityComponent SCR_EditableEntityLinkUIComponent.m_LinkedEntity

protected

---

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

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