SCR_SpawnPointSpinBox Interface Reference

Inheritance diagram for SCR_SpawnPointSpinBox:

Public Member Functions
override bool	OnFocus (Widget w, int x, int y)
override bool	OnFocusLost (Widget w, int x, int y)
int	AddItem (string item, RplId id)
override void	RemoveItem (int item, bool last=false)
override void	ClearAll ()
RplId	GetSpawnPointId (int itemId)
int	GetItemId (RplId id)
bool	IsEmpty ()
void	SetItemName (int id, string name)
array< SCR_SpawnPoint >	GetSpawnPointsInList ()
bool	IsFocused ()
Public Member Functions inherited from SCR_SpinBoxComponent
override void	HandlerAttached (Widget w)
override bool	OnFocus (Widget w, int x, int y)
override bool	OnFocusLost (Widget w, int x, int y)
override int	AddItem (string item, bool last=false, Managed data=null)
override void	RemoveItem (int item, bool last=false)
override void	ClearAll ()
override bool	SetCurrentItem (int i, bool playSound=false, bool animate=false)
void	AddActionListeners ()
void	RemoveActionListeners ()
void	SetKeepActionListeners (bool keep)
void	SetCycleMode (bool cycle)
ScriptInvoker	GetOnLeftArrowClick ()
ScriptInvoker	GetOnRightArrowClick ()
Public Member Functions inherited from SCR_SelectionWidgetComponent
int	AddItem (string item, bool last=false, Managed data=null)
void	ClearAll ()
void	RemoveItem (int item, bool last=false)
int	GetCurrentIndex ()
string	GetCurrentItem ()
Managed	GetCurrentItemData ()
string	GetItemName (int item)
Managed	GetItemData (int item)
int	GetNumItems ()
bool	SetCurrentItem (int i, bool playSound=false, bool animate=false)
Public Member Functions inherited from SCR_ChangeableComponentBase
override void	HandlerAttached (Widget w)
override bool	OnFocus (Widget w, int x, int y)
override bool	OnFocusLost (Widget w, int x, int y)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
TextWidget	GetLabel ()
void	SetLabel (string label)
void	UseLabel (bool use)
bool	IsUsingLabel ()
Widget	GetLabelWidget ()
	If label is not used, label widget might not exist at all!
Public Member Functions inherited from SCR_WLibComponentBase
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnFocus (Widget w, int x, int y)
void	SetHoverSound (string soundHover)
void	SetClickedSound (string soundClicked)
string	GetHoverSound ()
string	GetClickedSound ()
void	SetEnabled (bool enabled, bool animate=true)
void	SetVisible (bool visible, bool animate=true)
bool	IsEnabled ()
void	SetMouseOverToFocus (bool mouseOverToFocus)
void	SetDisabledOpacity (float newDisabledOpacity)
Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
Widget	GetRootWidget ()
bool	IsVisible ()

Protected Attributes
ref array< RplId >	m_aSpawnPointIds = {}
bool	m_bFocused
Protected Attributes inherited from SCR_SpinBoxComponent
SCR_PagingButtonComponent	m_ButtonLeft
SCR_PagingButtonComponent	m_ButtonRight
TextWidget	m_wText
Widget	m_wContent
Widget	m_wCountBar
ref array< Widget >	m_aHintElements = new array<Widget>()
bool	m_bUseLightArrows
bool	m_bCycleMode
bool	m_bShowHints
float	m_fHintElementWidth
float	m_fHintElementHeight
float	m_fHintSelectedWidthMultiplier
bool	m_fHintFillMode
float	m_fHintSpacing
ResourceName	m_sHintElementTexture
ResourceName	m_sHintElementImage
string	m_sHintBarElementName
ref ScriptInvoker	m_OnLeftArrowClick
ref ScriptInvoker	m_OnRightArrowClick
bool	m_bHasActionListeners
bool	m_bAllowSwitchingWithoutFocus
Protected Attributes inherited from SCR_SelectionWidgetComponent
ref array< ref Managed >	m_aElementData = new array<ref Managed>
Protected Attributes inherited from SCR_ChangeableComponentBase
bool	m_bUseLabel
string	m_sLabel
bool	m_bForceSize
float	m_fSizeWithLabel
float	m_fSizeWithoutLabel
ResourceName	m_sLabelLayout
string	m_sSizeLayout
Widget	m_wBorder
Widget	m_wBackground
Widget	m_wLabelRoot
Protected Attributes inherited from SCR_WLibComponentBase
string	m_sSoundHovered
string	m_sSoundClicked
float	m_fAnimationTime
bool	m_bMouseOverToFocus
float	m_fDisabledOpacity
float	m_fAnimationRate
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
Static Public Member Functions inherited from SCR_SpinBoxComponent
static SCR_SpinBoxComponent	GetSpinBoxComponent (string name, Widget parent, bool searchAllChildren=true)
	Static method to easily find component by providing name and parent.
Static Public Member Functions inherited from SCR_SelectionWidgetComponent
static SCR_SelectionWidgetComponent	GetSelectionComponent (string name, Widget parent, bool searchAllChildren=true)
Static Public Member Functions inherited from SCR_WLibComponentBase
static bool	SetTexture (ImageWidget widget, ResourceName texture, string image="")
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.
Public Attributes inherited from SCR_SelectionWidgetComponent
ref array< string >	m_aElementNames
int	m_iSelectedItem
Public Attributes inherited from SCR_ChangeableComponentBase
ref ScriptInvoker	m_OnChanged = new ScriptInvoker()
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker
Static Public Attributes inherited from SCR_WLibComponentBase
static const float	START_ANIMATION_RATE = 10001
static const float	START_ANIMATION_PERIOD = 250
Protected Member Functions inherited from SCR_SpinBoxComponent
bool	SetCurrentItem_Internal (int i, bool playSound, bool animate, bool invokeOnChanged)
void	CreateHintBar ()
void	UpdateHintBar (int currentIndex, int oldIndex)
void	SetInitialState (bool invokeOnChanged=true)
void	EnableArrows (int selected, bool animate)
	Based on cycle mode set which arrow should be enabled at given selection.
void	OnLeftArrowClick ()
void	OnRightArrowClick ()
void	OnMenuLeft ()
void	OnMenuRight ()
Protected Member Functions inherited from SCR_ChangeableComponentBase
void	SetupLabel ()
void	ClearLabel ()
Protected Member Functions inherited from SCR_WLibComponentBase
void	OnEnabled (bool animate)
void	OnDisabled (bool animate)
bool	IsChildWidget (Widget parent, Widget child)
void	SetAnimationRate ()
void	PlaySound (string sound)
Static Protected Attributes inherited from SCR_SpinBoxComponent
static const ref Color	COLOR_HINT_SELECTED = UIColors.CONTRAST_COLOR
static const ref Color	COLOR_HINT_DESELECTED = UIColors.WHITE_HOVERED

Member Function Documentation

AddItem()

int SCR_SpawnPointSpinBox.AddItem	(	string	item,
		RplId	id
	)

ClearAll()

override void SCR_SpawnPointSpinBox.ClearAll

(

)

Implements SCR_SpinBoxComponent.

GetItemId()

int SCR_SpawnPointSpinBox.GetItemId

(

RplId

id

)

GetSpawnPointId()

RplId SCR_SpawnPointSpinBox.GetSpawnPointId

(

int

itemId

)

GetSpawnPointsInList()

array< SCR_SpawnPoint > SCR_SpawnPointSpinBox.GetSpawnPointsInList

(

)

IsEmpty()

bool SCR_SpawnPointSpinBox.IsEmpty

(

)

IsFocused()

bool SCR_SpawnPointSpinBox.IsFocused

(

)

OnFocus()

override bool SCR_SpawnPointSpinBox.OnFocus	(	Widget	w,
		int	x,
		int	y
	)

Implements SCR_SpinBoxComponent.

OnFocusLost()

override bool SCR_SpawnPointSpinBox.OnFocusLost	(	Widget	w,
		int	x,
		int	y
	)

Implements SCR_SpinBoxComponent.

RemoveItem()

override void SCR_SpawnPointSpinBox.RemoveItem	(	int	item,
		bool	last = false
	)

Implements SCR_SpinBoxComponent.

SetItemName()

void SCR_SpawnPointSpinBox.SetItemName	(	int	id,
		string	name
	)

Member Data Documentation

m_aSpawnPointIds

ref array<RplId> SCR_SpawnPointSpinBox.m_aSpawnPointIds = {}

protected

m_bFocused

bool SCR_SpawnPointSpinBox.m_bFocused

protected

---

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

• Game/UI/Menu/DeployMenu/SCR_SpawnPointSpinBox.c