SCR_VONEntry Interface Reference

Voice over network entry data class, used for management of communication methods. More...

Inheritance diagram for SCR_VONEntry:

Public Member Functions
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.

Protected Attributes
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

Voice over network entry data class, used for management of communication methods.

Member Function Documentation

AdjustEntry()

void SCR_VONEntry.AdjustEntry

(

int

modifier

)

Adjust entry configuration such as radio frequency.

Parameters

modifier

is custom logic modifier

Implemented in SCR_VONEntryRadio.

AdjustEntryModif()

void SCR_VONEntry.AdjustEntryModif

(

int

modifier

)

Adjust entry configuration such as radio frequency, modified input.

Parameters

modifier

is custom logic modifier

Implemented in SCR_VONEntryRadio.

GetDisplayText()

string SCR_VONEntry.GetDisplayText

(

)

Get entry display text such as current frequency.

GetIconResource()

string SCR_VONEntry.GetIconResource

(

)

Get icon resource path string.

Implemented in SCR_VONEntryRadio.

GetVONMethod()

ECommMethod SCR_VONEntry.GetVONMethod

(

)

VON method type.

Implemented in SCR_VONEntryRadio.

InitEntry()

void SCR_VONEntry.InitEntry

(

)

Implemented in SCR_VONEntryRadio.

IsActive()

bool SCR_VONEntry.IsActive

(

)

Is active entry.

IsUsable()

bool SCR_VONEntry.IsUsable

(

)

Is usable entry.

SetActive()

void SCR_VONEntry.SetActive

(

bool

state

)

Activate entry.

SetSelected()

void SCR_VONEntry.SetSelected

(

bool

state

)

Set entry selection state.

SetUsable()

void SCR_VONEntry.SetUsable

(

bool

state

)

Usable entry.

ToggleEntry()

void SCR_VONEntry.ToggleEntry

(

)

Toggle entry such as radio on/off.

Implemented in SCR_VONEntryRadio.

Update()

override void SCR_VONEntry.Update

(

)

Called only when update is requested.

Implements SCR_SelectionMenuEntry.

Implemented in SCR_VONEntryRadio.

Member Data Documentation

m_bIsActive

bool SCR_VONEntry.m_bIsActive

protected

m_bIsSelected

bool SCR_VONEntry.m_bIsSelected

protected

m_bIsUsable

bool SCR_VONEntry.m_bIsUsable = true

protected

m_sText

string SCR_VONEntry.m_sText

protected

---

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

• Game/VON/SCR_VONEntry.c