SCR_BaseGroup Class Reference

Inheritance diagram for SCR_BaseGroup:

Protected Member Functions
override bool	CanBePerformedScript (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be performed?
override bool	GetEntryNameScript (out string outName)
override UIInfo	GetUIInfoScript ()
int	Count ()
	How many items this group contains.
void	SelectNext ()
	Select next item.
void	SelectPrevious ()
	Select next item.
void	Select (int index)
override void	OnPerform (IEntity user, BaseSelectionMenu sourceMenu)
	Callback for when this entry is supposed to be performed.
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.

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.

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

Definition at line 4 of file SCR_BaseGroup.c.

Constructor & Destructor Documentation

SCR_BaseGroup()

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

inlineprotected

Create a group with provided entries.

Definition at line 137 of file SCR_BaseGroup.c.

Member Function Documentation

CanBePerformedScript()

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

inlineprotected

Can this entry be performed?

Definition at line 19 of file SCR_BaseGroup.c.

Count()

int SCR_BaseGroup::Count ( )

inlineprotected

How many items this group contains.

Definition at line 57 of file SCR_BaseGroup.c.

GetEntryNameScript()

override bool SCR_BaseGroup::GetEntryNameScript ( out string outName )

inlineprotected

Definition at line 32 of file SCR_BaseGroup.c.

GetOwner()

IEntity SCR_BaseGroup::GetOwner ( )

inlineprotected

Return the owner of this group.

Definition at line 129 of file SCR_BaseGroup.c.

GetSelectedEntry()

SCR_BaseGroupEntry SCR_BaseGroup::GetSelectedEntry ( )

inlineprotected

Return the currently selected item.

Definition at line 133 of file SCR_BaseGroup.c.

GetUIInfoScript()

override UIInfo SCR_BaseGroup::GetUIInfoScript ( )

inlineprotected

Definition at line 45 of file SCR_BaseGroup.c.

OnPerform()

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

inlineprotected

Callback for when this entry is supposed to be performed.

Definition at line 119 of file SCR_BaseGroup.c.

Select()

void SCR_BaseGroup::Select ( int index )

inlineprotected

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

Returns

Returns true when selection was successful, false otherwise.

Definition at line 84 of file SCR_BaseGroup.c.

SelectNext()

void SCR_BaseGroup::SelectNext ( )

inlineprotected

Select next item.

Definition at line 61 of file SCR_BaseGroup.c.

SelectPrevious()

void SCR_BaseGroup::SelectPrevious ( )

inlineprotected

Select next item.

Definition at line 72 of file SCR_BaseGroup.c.

Member Data Documentation

m_aEntries

ref array<ref SCR_BaseGroupEntry> SCR_BaseGroup::m_aEntries

protected

List of all entries in this group.

Definition at line 9 of file SCR_BaseGroup.c.

m_iSelectedIndex

int SCR_BaseGroup::m_iSelectedIndex

protected

Currently selected entry or -1 if none.

Definition at line 11 of file SCR_BaseGroup.c.

m_pOwner

IEntity SCR_BaseGroup::m_pOwner

protected

Owner of this group.

Definition at line 7 of file SCR_BaseGroup.c.

m_pSelectedEntry

SCR_BaseGroupEntry SCR_BaseGroup::m_pSelectedEntry

protected

Currently selected entry or null if none.

Definition at line 13 of file SCR_BaseGroup.c.

m_pSourceMenu

BaseSelectionMenu SCR_BaseGroup::m_pSourceMenu

protected

The menu we belong to.

Definition at line 15 of file SCR_BaseGroup.c.

---

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

• scripts/Game/ItemSelection/SCR_BaseGroup.c