SCR_GroupWeaponEntry Class Reference

Inheritance diagram for SCR_GroupWeaponEntry:

Protected Member Functions
override void	OnPerform (IEntity user, BaseSelectionMenu sourceMenu)
override void	OnDonePerform (IEntity user, BaseSelectionMenu sourceMenu)
	Anything that should be done when item is deselected should be handled here.
override bool	CanBePerformedScript (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be performed?
override UIInfo	GetUIInfoScript ()
	If target slot is valid, return its UI info.
void	SCR_GroupWeaponEntry (IEntity pOwner, WeaponSlotComponent pWeaponSlot)
	Create new group representing a single weapon.

Protected Attributes
IEntity	m_pOwner
	Owner of this group.
WeaponSlotComponent	m_pWeaponSlotComponent
	The weapon this entry represents.

Detailed Description

Implementation of base group for switching that can be created via passing in a list of WeaponSlotComponents When selection is set weapon is selected via the character controller component

Definition at line 4 of file SCR_GroupWeaponEntry.c.

Constructor & Destructor Documentation

SCR_GroupWeaponEntry()

void SCR_GroupWeaponEntry::SCR_GroupWeaponEntry ( IEntity pOwner, WeaponSlotComponent pWeaponSlot )

inlineprotected

Create new group representing a single weapon.

Definition at line 58 of file SCR_GroupWeaponEntry.c.

Member Function Documentation

CanBePerformedScript()

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

inlineprotected

Can this entry be performed?

Definition at line 38 of file SCR_GroupWeaponEntry.c.

GetUIInfoScript()

override UIInfo SCR_GroupWeaponEntry::GetUIInfoScript ( )

inlineprotected

If target slot is valid, return its UI info.

Definition at line 48 of file SCR_GroupWeaponEntry.c.

OnDonePerform()

override void SCR_GroupWeaponEntry::OnDonePerform ( IEntity user, BaseSelectionMenu sourceMenu )

inlineprotected

Anything that should be done when item is deselected should be handled here.

Definition at line 32 of file SCR_GroupWeaponEntry.c.

OnPerform()

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

inlineprotected

Selects this item entry as the current one

Returns

Returns true if selection was sucessful, false otherwise.

Select the weapon via character controller

Definition at line 14 of file SCR_GroupWeaponEntry.c.

Member Data Documentation

m_pOwner

IEntity SCR_GroupWeaponEntry::m_pOwner

protected

Owner of this group.

Definition at line 7 of file SCR_GroupWeaponEntry.c.

m_pWeaponSlotComponent

WeaponSlotComponent SCR_GroupWeaponEntry::m_pWeaponSlotComponent

protected

The weapon this entry represents.

Definition at line 9 of file SCR_GroupWeaponEntry.c.

---

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

• scripts/Game/ItemSelection/SCR_GroupWeaponEntry.c