SCR_VONEntry Class Reference

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

Inheritance diagram for SCR_VONEntry:

Protected 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	SetMuted (bool state)
	Activate entry.
void	SetSelected (bool state)
	Set entry selection state.
void	AdjustEntry (int modifier)
void	AdjustEntryModif (int modifier)
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.

Protected Attributes
bool	m_bIsUsable = true
bool	m_bIsActive
bool	m_bIsMuted
bool	m_bIsSelected
string	m_sText

Detailed Description

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

Definition at line 3 of file SCR_VONEntry.c.

Member Function Documentation

AdjustEntry()

void SCR_VONEntry::AdjustEntry ( int modifier )

inlineprotected

Adjust entry configuration such as radio frequency

Parameters

modifier

is custom logic modifier

Definition at line 61 of file SCR_VONEntry.c.

AdjustEntryModif()

void SCR_VONEntry::AdjustEntryModif ( int modifier )

inlineprotected

Adjust entry configuration such as radio frequency, modified input

Parameters

modifier

is custom logic modifier

Definition at line 67 of file SCR_VONEntry.c.

GetDisplayText()

string SCR_VONEntry::GetDisplayText ( )

inlineprotected

Get entry display text such as current frequency.

Definition at line 77 of file SCR_VONEntry.c.

GetIconResource()

string SCR_VONEntry::GetIconResource ( )

inlineprotected

Get icon resource path string.

Definition at line 84 of file SCR_VONEntry.c.

GetVONMethod()

ECommMethod SCR_VONEntry::GetVONMethod ( )

inlineprotected

VON method type.

Definition at line 91 of file SCR_VONEntry.c.

InitEntry()

void SCR_VONEntry::InitEntry ( )

inlineprotected

Definition at line 13 of file SCR_VONEntry.c.

IsActive()

bool SCR_VONEntry::IsActive ( )

inlineprotected

Is active entry.

Definition at line 39 of file SCR_VONEntry.c.

IsUsable()

bool SCR_VONEntry::IsUsable ( )

inlineprotected

Is usable entry.

Definition at line 25 of file SCR_VONEntry.c.

SetActive()

void SCR_VONEntry::SetActive ( bool state )

inlineprotected

Activate entry.

Definition at line 32 of file SCR_VONEntry.c.

SetMuted()

void SCR_VONEntry::SetMuted ( bool state )

inlineprotected

Activate entry.

Definition at line 46 of file SCR_VONEntry.c.

SetSelected()

void SCR_VONEntry::SetSelected ( bool state )

inlineprotected

Set entry selection state.

Definition at line 53 of file SCR_VONEntry.c.

SetUsable()

void SCR_VONEntry::SetUsable ( bool state )

inlineprotected

Usable entry.

Definition at line 18 of file SCR_VONEntry.c.

ToggleEntry()

void SCR_VONEntry::ToggleEntry ( )

inlineprotected

Toggle entry such as radio on/off.

Definition at line 72 of file SCR_VONEntry.c.

Update()

override void SCR_VONEntry::Update ( )

inlineprotected

Called only when update is requested.

Definition at line 98 of file SCR_VONEntry.c.

Member Data Documentation

m_bIsActive

bool SCR_VONEntry::m_bIsActive

protected

Definition at line 6 of file SCR_VONEntry.c.

m_bIsMuted

bool SCR_VONEntry::m_bIsMuted

protected

Definition at line 7 of file SCR_VONEntry.c.

m_bIsSelected

bool SCR_VONEntry::m_bIsSelected

protected

Definition at line 8 of file SCR_VONEntry.c.

m_bIsUsable

bool SCR_VONEntry::m_bIsUsable = true

protected

Definition at line 5 of file SCR_VONEntry.c.

m_sText

string SCR_VONEntry::m_sText

protected

Definition at line 9 of file SCR_VONEntry.c.

---

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

• scripts/Game/VON/SCR_VONEntry.c