SCR_BaseGroupEntry Interface Reference

An abstract wrapper to provide common interface for items that can be stored in a BaseGroup. More...

Inheritance diagram for SCR_BaseGroupEntry:

Public Member Functions
void	OnDonePerform (IEntity user, BaseSelectionMenu sourceMenu)
	Callback for when this entry should cleanup after itself, aka "deselect".
Public Member Functions inherited from ScriptedSelectionMenuEntry
override void	OnPerform (IEntity user, BaseSelectionMenu sourceMenu)
	Callback for when this entry is supposed to be performed.
override bool	CanBeShownScript (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be shown?
override bool	CanBePerformedScript (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be performed?
override bool	GetEntryNameScript (out string outName)
	If overridden and true is returned, outName is returned when BaseSelectionMenuEntry.GetEntryName is called.
override bool	GetEntryDescriptionScript (out string outDescription)
	If overridden and true is returned, outDescription is returned when BaseSelectionMenuEntry.GetEntryDescription is called.
override bool	GetEntryIconPathScript (out string outIconPath)
	If overridden and true is returned, outIconPath is returned when BaseSelectionMenuEntry.GetEntryIconPath is called.
override UIInfo	GetUIInfoScript ()
	Can be overridden to return desired UIInfo in GetUIInfo method.
void	UpdateVisuals ()
	Base visuals update function for specific entry update.
ResourceName	GetEntryLayout ()
	API for entry widget and component.
void	SetEntryLayout (ResourceName entryLayout)
Widget	GetEntryWidget ()
void	SetEntryWidget (Widget root)
string	GetName ()
void	SetName (string name)
bool	CanBeShownScript (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be shown?
bool	CanBePerformedScript (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be performed?
void	OnPerform (IEntity user, BaseSelectionMenu sourceMenu)
	Callback for when this entry is supposed to be performed.
bool	GetEntryNameScript (out string outName)
	If overridden and true is returned, outName is returned when BaseSelectionMenuEntry.GetEntryName is called.
bool	GetEntryDescriptionScript (out string outDescription)
	If overridden and true is returned, outDescription is returned when BaseSelectionMenuEntry.GetEntryDescription is called.
bool	GetEntryIconPathScript (out string outIconPath)
	If overridden and true is returned, outIconPath is returned when BaseSelectionMenuEntry.GetEntryIconPath is called.
UIInfo	GetUIInfoScript ()
	Can be overriden to return desired UIInfo in GetUIInfo method.
Public Member Functions inherited from BaseSelectionMenuEntry
proto external bool	CanBeShown (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be shown?
proto external bool	CanBePerformed (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be performed?
proto external void	Perform (IEntity user, BaseSelectionMenu sourceMenu)
	Request to perform this entry.
proto external string	GetEntryName ()
	Return the name of this entry.
proto external string	GetEntryDescription ()
	Return the description of this entry.
proto external string	GetEntryIconPath ()
	Return the icon path of this entry.
proto external UIInfo	GetUIInfo ()
	Get related UI info or null if none.

Protected Attributes
ref array< ScriptedSelectionMenuEntry >	m_aEntries
Protected Attributes inherited from ScriptedSelectionMenuEntry
ResourceName	m_EntryLayout = LAYOUT_ENTRY_DEFAULT
ref Widget	m_wEntry
string	m_sName

Additional Inherited Members
Static Public Attributes inherited from ScriptedSelectionMenuEntry
const string	LAYOUT_ENTRY_DEFAULT = "{121C45A1F59DC1AF}UI/layouts/Common/RadialMenu/RadialEntryElement.layout"

Detailed Description

An abstract wrapper to provide common interface for items that can be stored in a BaseGroup.

Member Function Documentation

OnDonePerform()

void SCR_BaseGroupEntry.OnDonePerform	(	IEntity	user,
		BaseSelectionMenu	sourceMenu
	)

Callback for when this entry should cleanup after itself, aka "deselect".

Implemented in SCR_GroupWeaponEntry.

Member Data Documentation

m_aEntries

ref array<ScriptedSelectionMenuEntry> SCR_BaseGroupEntry.m_aEntries

protected

---

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

• Game/ItemSelection/SCR_BaseGroupEntry.c