VONManager Class Reference

Manager class which handles Voice-over-network functionality while player is connected to a server. More...

Static Private Member Functions
static VONManagerBase	GetInstance ()
	Main way to access VONManager functionality from script.
static void	Init ()
	Initializes VONManager, runs when user first connects to a server.
static void	CleanupInstance ()
	Uninitializes VONManager, runs when user disconnects from server.
static bool	IsVONToggled ()
	Specifies whether VON mode is toggled or not.
static bool	IsVoiceThresholdMinimum ()
	Specifies whether user's voice activation threshold value is equal to the minimum voice activation threshold value.

Static Private Attributes
static private ref VONManagerBase	m_VONManager = new VONManagerBase()

Detailed Description

Manager class which handles Voice-over-network functionality while player is connected to a server.

Member Function Documentation

CleanupInstance()

static void CleanupInstance ( )

inlinestaticprivate

Uninitializes VONManager, runs when user disconnects from server.

References m_VONManager.

Referenced by CGame::~CGame().

GetInstance()

static VONManagerBase GetInstance ( )

inlinestaticprivate

Main way to access VONManager functionality from script.

Returns

Instance of VONManagerImplementation if logged on to server, or VONManagerBase otherwise

References m_VONManager.

Referenced by CGame::OnEvent(), MissionBase::OnUpdate(), and ScriptedWidgetEventHandler::OptionsMenuSounds().

Init()

static void Init ( )

inlinestaticprivate

Initializes VONManager, runs when user first connects to a server.

References m_VONManager, and VONManagerImplementation().

Referenced by CGame::CGame().

IsVoiceThresholdMinimum()

static bool IsVoiceThresholdMinimum ( )

inlinestaticprivate

Specifies whether user's voice activation threshold value is equal to the minimum voice activation threshold value.

Returns

True if threshold minimum, false otherwise

References Class::CastTo(), GetGame(), GameOptions::GetOptionByType(), AbstractSoundScene::GetSilenceThreshold(), and CGame::GetSoundScene().

Referenced by OnEvent(), and UpdateVoiceIcon().

IsVONToggled()

static bool IsVONToggled ( )

inlinestaticprivate

Specifies whether VON mode is toggled or not.

Returns

True if in Voice Activation mode, False if in Push-to-Talk mode

References VONManagerBase::IsVonToggled(), and m_VONManager.

Field Documentation

m_VONManager

private ref VONManagerBase m_VONManager = new VONManagerBase()

staticprivate

Referenced by CleanupInstance(), GetInstance(), Init(), and IsVONToggled().

---

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

• P:/scripts/3_Game/VONManager.c