SCR_VONMenu Interface Reference

Public Member Functions
SCR_RadialMenu	GetRadialMenu ()
void	SetMenuDisabled (bool state)
void	AddRadialEntry (notnull SCR_VONEntry entry, SCR_SelectionMenuCategoryEntry category=null)
	Add simple entry.
void	AddRadialCategory (notnull SCR_SelectionMenuCategoryEntry entry)
	Add simple category.
void	Update (float timeSlice)
	frame update
void	Init (SCR_VONController controllerVON)

Static Public Member Functions
static string	GetKnownChannel (int frequency)
	Get channel name tied to a frequency.

Static Public Attributes
const float	ADJUST_COOLDOWN = 0.175

Protected Member Functions
int	GetGroupedRadioIndex (notnull SCR_VONEntryRadio entry)
	Get sibling transceiver indeces when there are more in a single device.
array< SCR_VONEntryRadio >	GetGroupedEntries (notnull SCR_VONEntryRadio entry)
	Get sibling transceiver entries when there are more in a single device.
void	OnInputOpenMenu (SCR_RadialMenuController controller, bool hasControl)
	SCR_RadialMenuController event.
void	OnControllerTakeControl (SCR_RadialMenuController controller)
	SCR_RadialMenuController event.
void	OnControllerChanged (SCR_RadialMenuController controller)
	SCR_RadialMenuController event.
void	OnOpenMenu (SCR_SelectionMenu menu)
	SCR_RadialMenu event.
void	OnCloseMenu (SCR_SelectionMenu menu)
	SCR_RadialMenu event.
void	OnEntryPerformed (SCR_SelectionMenu menu, SCR_SelectionMenuEntry entry)
	SCR_RadialMenu event.
void	OnEntrySelected (SCR_SelectionMenu menu, SCR_SelectionMenuEntry entry, int id)
	SCR_RadialMenu event.
void	OnActiveEntriesChanged (SCR_VONEntry entry, bool isActive)
	SCR_VONController event.
void	OnAdjustEntry (int input, bool isModif)
void	ActionTuneFrequency (float value, EActionTrigger reason)
	Menu item configuration callback.
void	ActionCycleChannel (float value, EActionTrigger reason)
	Menu item configuration callback.
void	OnMenuToggle (float value, EActionTrigger reason)
	Entry toggle callback.
void	UpdateEntries ()

Protected Attributes
ref SCR_RadialMenuController	m_RadialController
ref SCR_RadialMenu	m_RadialMenu
bool	m_bIsDisabled
bool	m_bIsModifierActive
float	m_fAdjustCooldown
float	m_FrequencyListTimer
SCR_VONEntry	m_SelectedEntry
SCR_VONEntryRadio	m_LastSelectedEntry
SCR_VONRadialDisplay	m_Display
SCR_VONController	m_VONController

Member Function Documentation

ActionCycleChannel()

void SCR_VONMenu.ActionCycleChannel ( float  value, EActionTrigger  reason  )

protected

Menu item configuration callback.

ActionTuneFrequency()

void SCR_VONMenu.ActionTuneFrequency ( float  value, EActionTrigger  reason  )

protected

Menu item configuration callback.

AddRadialCategory()

void SCR_VONMenu.AddRadialCategory

(

notnull SCR_SelectionMenuCategoryEntry

entry

)

Add simple category.

AddRadialEntry()

void SCR_VONMenu.AddRadialEntry	(	notnull SCR_VONEntry	entry,
		SCR_SelectionMenuCategoryEntry	category = null
	)

Add simple entry.

GetGroupedEntries()

array< SCR_VONEntryRadio > SCR_VONMenu.GetGroupedEntries ( notnull SCR_VONEntryRadio  entry )

protected

Get sibling transceiver entries when there are more in a single device.

GetGroupedRadioIndex()

int SCR_VONMenu.GetGroupedRadioIndex ( notnull SCR_VONEntryRadio  entry )

protected

Get sibling transceiver indeces when there are more in a single device.

GetKnownChannel()

static string SCR_VONMenu.GetKnownChannel ( int  frequency )

static

Get channel name tied to a frequency.

Parameters

frequency

is the subject frequency

Returns

channel name or empty string if not found

GetRadialMenu()

SCR_RadialMenu SCR_VONMenu.GetRadialMenu

(

)

Init()

void SCR_VONMenu.Init

(

SCR_VONController

controllerVON

)

OnActiveEntriesChanged()

void SCR_VONMenu.OnActiveEntriesChanged ( SCR_VONEntry  entry, bool  isActive  )

protected

SCR_VONController event.

OnAdjustEntry()

void SCR_VONMenu.OnAdjustEntry ( int  input, bool  isModif  )

protected

OnCloseMenu()

void SCR_VONMenu.OnCloseMenu ( SCR_SelectionMenu  menu )

protected

SCR_RadialMenu event.

OnControllerChanged()

void SCR_VONMenu.OnControllerChanged ( SCR_RadialMenuController  controller )

protected

SCR_RadialMenuController event.

OnControllerTakeControl()

void SCR_VONMenu.OnControllerTakeControl ( SCR_RadialMenuController  controller )

protected

SCR_RadialMenuController event.

OnEntryPerformed()

void SCR_VONMenu.OnEntryPerformed ( SCR_SelectionMenu  menu, SCR_SelectionMenuEntry  entry  )

protected

SCR_RadialMenu event.

OnEntrySelected()

void SCR_VONMenu.OnEntrySelected ( SCR_SelectionMenu  menu, SCR_SelectionMenuEntry  entry, int  id  )

protected

SCR_RadialMenu event.

OnInputOpenMenu()

void SCR_VONMenu.OnInputOpenMenu ( SCR_RadialMenuController  controller, bool  hasControl  )

protected

SCR_RadialMenuController event.

OnMenuToggle()

void SCR_VONMenu.OnMenuToggle ( float  value, EActionTrigger  reason  )

protected

Entry toggle callback.

OnOpenMenu()

void SCR_VONMenu.OnOpenMenu ( SCR_SelectionMenu  menu )

protected

SCR_RadialMenu event.

SetMenuDisabled()

void SCR_VONMenu.SetMenuDisabled

(

bool

state

)

Update()

void SCR_VONMenu.Update

(

float

timeSlice

)

frame update

UpdateEntries()

void SCR_VONMenu.UpdateEntries ( )

protected

Member Data Documentation

ADJUST_COOLDOWN

const float SCR_VONMenu.ADJUST_COOLDOWN = 0.175

static

m_bIsDisabled

bool SCR_VONMenu.m_bIsDisabled

protected

m_bIsModifierActive

bool SCR_VONMenu.m_bIsModifierActive

protected

m_Display

SCR_VONRadialDisplay SCR_VONMenu.m_Display

protected

m_fAdjustCooldown

float SCR_VONMenu.m_fAdjustCooldown

protected

m_FrequencyListTimer

float SCR_VONMenu.m_FrequencyListTimer

protected

m_LastSelectedEntry

SCR_VONEntryRadio SCR_VONMenu.m_LastSelectedEntry

protected

m_RadialController

ref SCR_RadialMenuController SCR_VONMenu.m_RadialController

protected

m_RadialMenu

ref SCR_RadialMenu SCR_VONMenu.m_RadialMenu

protected

m_SelectedEntry

SCR_VONEntry SCR_VONMenu.m_SelectedEntry

protected

m_VONController

SCR_VONController SCR_VONMenu.m_VONController

protected

---

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

• Game/VON/SCR_VONMenu.c