VONManager Class Reference

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

Collaboration diagram for VONManager:

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 ref VONManagerBase	m_VONManager = new VONManagerBase()

Detailed Description

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

Definition at line 241 of file VONManager.c.

Member Function Documentation

CleanupInstance()

static void VONManager::CleanupInstance ( )

inlinestaticprivate

Uninitializes VONManager, runs when user disconnects from server.

Definition at line 266 of file VONManager.c.

  {
    delete m_VONManager;
    m_VONManager = new VONManagerBase();
  }

References m_VONManager, and VONManagerBase().

Referenced by CGame::~CGame().

GetInstance()

static VONManagerBase VONManager::GetInstance ( )

inlinestaticprivate

Main way to access VONManager functionality from script.

Returns

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

Definition at line 249 of file VONManager.c.

  {
    return m_VONManager;
  }

References m_VONManager.

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

Init()

static void VONManager::Init ( )

inlinestaticprivate

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

Definition at line 257 of file VONManager.c.

  {
    delete m_VONManager;
    m_VONManager = new VONManagerImplementation();
  }

References m_VONManager, and VONManagerImplementation().

Referenced by CGame::CGame().

IsVoiceThresholdMinimum()

static bool VONManager::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

Definition at line 285 of file VONManager.c.

  {
    GameOptions gameOptions = new GameOptions();
    NumericOptionsAccess noa;
    Class.CastTo(noa, gameOptions.GetOptionByType(OptionAccessType.AT_OPTIONS_VON_THRESHOLD_SLIDER));
 
    return noa.ReadValue() <= GetGame().GetSoundScene().GetSilenceThreshold();
  }

References Class::CastTo(), and GetGame().

Referenced by OnEvent(), and UpdateVoiceIcon().

IsVONToggled()

static bool VONManager::IsVONToggled ( )

inlinestaticprivate

Specifies whether VON mode is toggled or not.

Returns

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

Definition at line 276 of file VONManager.c.

  {
    return m_VONManager.IsVonToggled();
  }

References m_VONManager.

Member Data Documentation

m_VONManager

ref VONManagerBase VONManager::m_VONManager = new VONManagerBase()

staticprivate

Definition at line 243 of file VONManager.c.

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

---

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

• scripts/3_Game/VONManager.c