VONEntry class for radio entries. More...

Inheritance diagram for SCR_VONEntryRadio:

Public Member Functions
BaseTransceiver	GetTransceiver ()
	Associated transceiver.

int	GetTransceiverNumber ()
	Associated transceiver id - starts with 1.

int	GetEntryFrequency ()
	Local frequency getter since atm the transceiver getter is delayed (network?) and not sufficient for instant UI changes.

SCR_GadgetComponent	GetGadget ()
	Gadget component associated with this entry.

UIInfo	GetUIInfo ()

bool	IsLongRange ()
	Is long range backpack radio type.

void	SetRadioEntry (notnull BaseTransceiver transceiver, int number, SCR_GadgetComponent gadgetComp)

void	SetChannelText (string channel)

override void	InitEntry ()

override void	AdjustEntryModif (int modifier)
	Adjust entry configuration such as radio frequency, modified input.

override void	AdjustEntry (int modifier)
	Adjust entry configuration such as radio frequency.

override void	ToggleEntry ()
	Toggle entry such as radio on/off.

override string	GetIconResource ()
	Get icon resource path string.

override ECommMethod	GetVONMethod ()
	VON method type.

override void	Update ()
	Update entry visuals.

Public Member Functions inherited from SCR_VONEntry
void	InitEntry ()

void	SetUsable (bool state)
	Usable entry.

bool	IsUsable ()
	Is usable entry.

void	SetActive (bool state)
	Activate entry.

bool	IsActive ()
	Is active entry.

void	SetSelected (bool state)
	Set entry selection state.

void	AdjustEntry (int modifier)
	Adjust entry configuration such as radio frequency.

void	AdjustEntryModif (int modifier)
	Adjust entry configuration such as radio frequency, modified input.

void	ToggleEntry ()
	Toggle entry such as radio on/off.

string	GetDisplayText ()
	Get entry display text such as current frequency.

string	GetIconResource ()
	Get icon resource path string.

ECommMethod	GetVONMethod ()
	VON method type.

override void	Update ()
	Called only when update is requested.

Public Member Functions inherited from SCR_SelectionMenuEntry
ScriptInvoker	GetOnPerform ()

ScriptInvoker	GetOnPerformFail ()

ScriptInvoker	GetOnIconChange ()

void	Update ()
	Public method to make entry update itself.

void	Perform ()
	Public method to call entry perform Don't override! To define entry perform behavior override OnPerform() below.

void	Enable (bool enable)

void	SetId (string id)

string	GetId ()

void	SetName (string name)

void	SetDescription (string description)

void	SetIcon (ResourceName iconPath, string imageSetName="")
	Set icon and invoke change.

void	SetIconFromDeafaultImageSet (string imageSetName="")

ResourceName	GetCustomLayout ()

void	SetCustomLayout (ResourceName layout)

void	SetEntryComponent (SCR_SelectionMenuEntryComponent entryComponent)

SCR_SelectionMenuEntryComponent	GetEntryComponent ()

bool	IsEnabled ()

void	SetInputAction (string action)

string	GetInputAction ()

void	SCR_SelectionMenuEntry ()

Public Member Functions inherited from SCR_UIInfo
ResourceName	GetIconPath ()
	Get icon.

string	GetIconSetName ()
	Returns Icon Set name if imageset.

bool	HasIcon ()
	Check if the info has an icon defined.

bool	SetIconTo (ImageWidget imageWidget)
	Set icon to given image widget.

override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)

Public Member Functions inherited from SCR_UIDescription
LocalizedString	GetUnformattedDescription ()
	Get the unformatted description from SCR_HintUIInfo instance.

void	SetDescription (LocalizedString description)
	Change the description from SCR_HintUIInfo instance.

LocalizedString	GetDescription ()
	Get description.

bool	HasDescription ()
	Check if the info has a description defined.

bool	SetDescriptionTo (TextWidget textWidget)
	Set description to given text widget.

override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)

Public Member Functions inherited from SCR_UIName
LocalizedString	GetUnformattedName ()
	Get The unformatted Name from SCR_HintUIInfo instance.

void	SetName (LocalizedString name)
	Change the Name from SCR_HintUIInfo instance.

LocalizedString	GetName ()
	Get name.

bool	HasName ()
	Check if the info has a name defined.

bool	SetNameTo (TextWidget textWidget)
	Set name to given text widget.

void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
	Print out contents of this UI info.

Static Public Attributes
const string	LABEL_FREQUENCY_UNITS = "#AR-VON_FrequencyUnits_MHz"

Protected Attributes
int	m_iFrequency

int	m_iTransceiverNumber

string	m_sChannelText

BaseTransceiver	m_RadioTransceiver

SCR_GadgetComponent	m_GadgetComp

Protected Attributes inherited from SCR_VONEntry
bool	m_bIsUsable = true

bool	m_bIsActive

bool	m_bIsSelected

string	m_sText

Protected Attributes inherited from SCR_SelectionMenuEntry
string	m_sId

bool	m_bEnabled

string	m_sInputAction

ResourceName	m_sCustomLayout

ref SCR_SelectionMenuEntryComponent	m_EntryComponent

ref ScriptInvoker< SCR_SelectionMenuEntry >	m_OnPerform

ref ScriptInvoker< SCR_SelectionMenuEntry >	m_OnPerformFail

ref ScriptInvoker< SCR_SelectionMenuEntry, ResourceName, string >	m_OnIconChange

Protected Attributes inherited from SCR_UIInfo
ResourceName	Icon

string	IconSetName

Protected Attributes inherited from SCR_UIDescription
LocalizedString	Description

Protected Attributes inherited from SCR_UIName
LocalizedString	Name

Additional Inherited Members
Static Public Member Functions inherited from SCR_UIInfo
static SCR_UIInfo	GetInfo (BaseContainer source, string varName)
	Get UIInfo from a source object.

static SCR_UIInfo	CreateInfo (UIInfo source)
	Create SCR_UIInfo from engine UIInfo.

static SCR_UIInfo	CreateInfo (LocalizedString name, LocalizedString description=LocalizedString.Empty, ResourceName icon=ResourceName.Empty, string iconSetName=string.Empty)
	Create SCR_UIInfo from basic params.

static SCR_UIInfo	CreatePlaceholderInfo (TypeName type)
	Get placeholder info.

Protected Member Functions inherited from SCR_SelectionMenuEntry
void	InvokeOnPerform ()

void	InvokeOnPerformFail ()

void	InvokeOnIconChange (ResourceName icon, string imageSetImage)

void	OnPerform ()
	Empty methods for deifinition of perform behavior.

void	OnEntryClick (SCR_SelectionMenuEntryComponent entryComponent)

Protected Member Functions inherited from SCR_UIInfo
override void	CopyFrom (SCR_UIName source)

override void	CopyFrom (SCR_UIName source)

void	CopyFrom (SCR_UIName source)

Detailed Description

VONEntry class for radio entries.

Member Function Documentation

◆ AdjustEntry()

override void SCR_VONEntryRadio.AdjustEntry ( int modifier )

Adjust entry configuration such as radio frequency.

Parameters

modifier is custom logic modifier

Implements SCR_VONEntry.

◆ AdjustEntryModif()

override void SCR_VONEntryRadio.AdjustEntryModif ( int modifier )

Adjust entry configuration such as radio frequency, modified input.

Parameters

modifier is custom logic modifier

Implements SCR_VONEntry.

◆ GetEntryFrequency()

int SCR_VONEntryRadio.GetEntryFrequency ( )

Local frequency getter since atm the transceiver getter is delayed (network?) and not sufficient for instant UI changes.

◆ GetGadget()

SCR_GadgetComponent SCR_VONEntryRadio.GetGadget ( )

Gadget component associated with this entry.

◆ GetIconResource()

override string SCR_VONEntryRadio.GetIconResource ( )

Get icon resource path string.

Implements SCR_VONEntry.

◆ GetTransceiver()

BaseTransceiver SCR_VONEntryRadio.GetTransceiver ( )

Associated transceiver.

◆ GetTransceiverNumber()

int SCR_VONEntryRadio.GetTransceiverNumber ( )

Associated transceiver id - starts with 1.

◆ GetUIInfo()

UIInfo SCR_VONEntryRadio.GetUIInfo ( )

◆ GetVONMethod()

override ECommMethod SCR_VONEntryRadio.GetVONMethod ( )

VON method type.

Implements SCR_VONEntry.

◆ InitEntry()

override void SCR_VONEntryRadio.InitEntry ( )

Implements SCR_VONEntry.

◆ IsLongRange()

bool SCR_VONEntryRadio.IsLongRange ( )

Is long range backpack radio type.

◆ SetChannelText()

void SCR_VONEntryRadio.SetChannelText ( string channel )

◆ SetRadioEntry()

void SCR_VONEntryRadio.SetRadioEntry	(	notnull BaseTransceiver	transceiver,
		int	number,
		SCR_GadgetComponent	gadgetComp
	)

◆ ToggleEntry()

override void SCR_VONEntryRadio.ToggleEntry ( )

Toggle entry such as radio on/off.

Implements SCR_VONEntry.

◆ Update()

override void SCR_VONEntryRadio.Update ( )

Update entry visuals.

Implements SCR_VONEntry.

Member Data Documentation

◆ LABEL_FREQUENCY_UNITS

const string SCR_VONEntryRadio.LABEL_FREQUENCY_UNITS = "#AR-VON_FrequencyUnits_MHz"

static

◆ m_GadgetComp

SCR_GadgetComponent SCR_VONEntryRadio.m_GadgetComp

protected

◆ m_iFrequency

int SCR_VONEntryRadio.m_iFrequency

protected

◆ m_iTransceiverNumber

int SCR_VONEntryRadio.m_iTransceiverNumber

protected

◆ m_RadioTransceiver

BaseTransceiver SCR_VONEntryRadio.m_RadioTransceiver

protected

◆ m_sChannelText

string SCR_VONEntryRadio.m_sChannelText

protected

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

Game/VON/SCR_VONEntryRadio.c

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AdjustEntry()

◆ AdjustEntryModif()

◆ GetEntryFrequency()

◆ GetGadget()

◆ GetIconResource()

◆ GetTransceiver()

◆ GetTransceiverNumber()

◆ GetUIInfo()

◆ GetVONMethod()

◆ InitEntry()

◆ IsLongRange()

◆ SetChannelText()

◆ SetRadioEntry()

◆ ToggleEntry()

◆ Update()

Member Data Documentation

◆ LABEL_FREQUENCY_UNITS

◆ m_GadgetComp

◆ m_iFrequency

◆ m_iTransceiverNumber

◆ m_RadioTransceiver

◆ m_sChannelText