An abstract class to be implemented by the user to provide the WeaponSwitchingGroupManager with a valid means of communication with the game world for the purpose of weapon switching. More...

Inheritance diagram for SCR_BaseGroup:

[legend]

Public Member Functions
int	Count ()
	How many items this group contains.

void	SelectNext ()
	Select next item.

void	SelectPrevious ()
	Select next item.

void	Select (int index)
	Select item from this group at given index as the current item.

IEntity	GetOwner ()
	Return the owner of this group.

SCR_BaseGroupEntry	GetSelectedEntry ()
	Return the currently selected item.

void	SCR_BaseGroup (IEntity owner, array< ref SCR_BaseGroupEntry > entries)
	Create a group with provided entries.

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 Member Functions
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 UIInfo	GetUIInfoScript ()
	Can be overridden to return desired UIInfo in GetUIInfo method.

override void	OnPerform (IEntity user, BaseSelectionMenu sourceMenu)
	Callback for when this entry is supposed to be performed.

Protected Attributes
IEntity	m_pOwner
	Owner of this group.

ref array< ref SCR_BaseGroupEntry >	m_aEntries
	List of all entries in this group.

int	m_iSelectedIndex
	Currently selected entry or -1 if none.

SCR_BaseGroupEntry	m_pSelectedEntry
	Currently selected entry or null if none.

BaseSelectionMenu	m_pSourceMenu
	The menu we belong to.

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 class to be implemented by the user to provide the WeaponSwitchingGroupManager with a valid means of communication with the game world for the purpose of weapon switching.

Constructor & Destructor Documentation

◆ SCR_BaseGroup()

void SCR_BaseGroup.SCR_BaseGroup	(	IEntity	owner,
		array< ref SCR_BaseGroupEntry >	entries
	)

Create a group with provided entries.

Member Function Documentation

◆ CanBePerformedScript()

override bool SCR_BaseGroup.CanBePerformedScript	(	IEntity	user,
		BaseSelectionMenu	sourceMenu
	)

protected

Can this entry be performed?

Implements ScriptedSelectionMenuEntry.

◆ Count()

int SCR_BaseGroup.Count ( )

How many items this group contains.

◆ GetEntryNameScript()

override bool SCR_BaseGroup.GetEntryNameScript ( out string outName )

protected

If overridden and true is returned, outName is returned when BaseSelectionMenuEntry.GetEntryName is called.

If not overridden or false is returned the default value from UIInfo is taken (or empty string if no UI info exists)

Implements ScriptedSelectionMenuEntry.

◆ GetOwner()

IEntity SCR_BaseGroup.GetOwner ( )

Return the owner of this group.

◆ GetSelectedEntry()

SCR_BaseGroupEntry SCR_BaseGroup.GetSelectedEntry ( )

Return the currently selected item.

◆ GetUIInfoScript()

override UIInfo SCR_BaseGroup.GetUIInfoScript ( )

protected

Can be overridden to return desired UIInfo in GetUIInfo method.

Implements ScriptedSelectionMenuEntry.

◆ OnPerform()

override void SCR_BaseGroup.OnPerform	(	IEntity	user,
		BaseSelectionMenu	sourceMenu
	)

protected

Callback for when this entry is supposed to be performed.

Implements ScriptedSelectionMenuEntry.

◆ Select()

void SCR_BaseGroup.Select ( int index )

Select item from this group at given index as the current item.

Returns: Returns true when selection was successful, false otherwise.

◆ SelectNext()

void SCR_BaseGroup.SelectNext ( )

Select next item.

◆ SelectPrevious()

void SCR_BaseGroup.SelectPrevious ( )

Select next item.

Member Data Documentation

◆ m_aEntries

ref array<ref SCR_BaseGroupEntry> SCR_BaseGroup.m_aEntries

protected

List of all entries in this group.

◆ m_iSelectedIndex

int SCR_BaseGroup.m_iSelectedIndex

protected

Currently selected entry or -1 if none.

◆ m_pOwner

IEntity SCR_BaseGroup.m_pOwner

protected

Owner of this group.

◆ m_pSelectedEntry

SCR_BaseGroupEntry SCR_BaseGroup.m_pSelectedEntry

protected

Currently selected entry or null if none.

◆ m_pSourceMenu

BaseSelectionMenu SCR_BaseGroup.m_pSourceMenu

protected

The menu we belong to.

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

Game/ItemSelection/SCR_BaseGroup.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SCR_BaseGroup()

Member Function Documentation

◆ CanBePerformedScript()

◆ Count()

◆ GetEntryNameScript()

◆ GetOwner()

◆ GetSelectedEntry()

◆ GetUIInfoScript()

◆ OnPerform()

◆ Select()

◆ SelectNext()

◆ SelectPrevious()

Member Data Documentation

◆ m_aEntries

◆ m_iSelectedIndex

◆ m_pOwner

◆ m_pSelectedEntry

◆ m_pSourceMenu