VONManager.c File Reference

Go to the source code of this file.

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

Functions
VONManagerBase Managed	VONManagerImplementation ()
void	VONManagerBase ()
void	HideVoiceNotification ()
	Hides the VON notification completely and immediately.
void	ShowVoiceNotification (int level, bool fading)
	Shows the voice notification.
void	HandleInput (Input inp)
	Handles some VON related input.
void	OnVOIPThresholdChanged ()
	Fires every time VOIP threshold value changes.
void	OnEvent (EventType eventTypeId, Param params)
	Handles VON-related events.
bool	IsVonToggled ()
void	~VONManagerImplementation ()
void	UpdateVoiceIcon ()

Variables
bool	m_VoNToggled
ref ScriptInvoker	m_OnVonStateEvent
ref ScriptInvoker	m_OnPartyChatChangedEvent

Function Documentation

HandleInput()

override void HandleInput ( Input inp )

protected

Handles some VON related input.

Parameters

inp	input to handle

Definition at line 103 of file VONManager.c.

  {
#ifdef PLATFORM_XBOX
    // ignore VON-related input if user is in an xbox party
    if (GetGame().IsInPartyChat())
      return;
#endif
    int oldLevel = GetGame().GetVoiceLevel();
    if (oldLevel == -1) //VoN system not initialized!
      return;
 
    int newLevel = -1;
 
    if (inp.LocalPress_ID(UAVoiceDistanceUp, false))
      newLevel = (oldLevel + 1) % (VoiceLevelShout + 1);
 
    if (inp.LocalPress_ID(UAVoiceDistanceDown, false))
    {
      newLevel = oldLevel - 1;
      if (newLevel < VoiceLevelWhisper) //nah...
        newLevel = VoiceLevelShout;
    }
 
    if (newLevel > -1)
    {
      GetGame().SetVoiceLevel(newLevel);
      UpdateVoiceIcon();
    }
  }

References GetGame(), and UpdateVoiceIcon().

HideVoiceNotification()

override void HideVoiceNotification ( )

protected

Hides the VON notification completely and immediately.

Definition at line 41 of file VONManager.c.

  {
    if (GetGame().IsMissionMainMenu())
      return;
 
    Mission mission = GetGame().GetMission();
    mission.GetMicrophoneIcon().Show(false);
    mission.HideVoiceLevelWidgets();
  }

IsVonToggled()

bool VONManagerImplementation::IsVonToggled ( )

protected

Definition at line 42 of file VONManager.c.

  {
    if (GetGame().IsMissionMainMenu())
      return;
 

References GetGame(), Mission::GetMicrophoneIcon(), Mission::HideVoiceLevelWidgets(), and mission.

OnEvent()

void VONManagerImplementation::OnEvent ( EventType eventTypeId, Param params )

protected

Handles VON-related events.

Parameters

eventTypeId	event that fired
params	event-specific parameters

Definition at line 167 of file VONManager.c.

  {
    Mission mission = GetGame().GetMission();
    switch (eventTypeId)
    {
    case VONUserStartedTransmittingAudioEventTypeID:
    {
      // only handle this if we are in Voice Activation mode, so ignore if in PTT mode
      if (m_VoNToggled)
      {
        if (!VONManager.IsVoiceThresholdMinimum())
          ShowVoiceNotification(GetGame().GetVoiceLevel(), false);
      }
      break;
    }
 
    case VONUserStoppedTransmittingAudioEventTypeID:
    {
      // only handle this if we are in Voice Activation mode, so ignore if in PTT mode
      if (m_VoNToggled)
      {
        if (!VONManager.IsVoiceThresholdMinimum())
          HideVoiceNotification();
      }
      break;
    }
 
    case VONStateEventTypeID:
    {
      if (!mission)
        break;
 
      VONStateEventParams vonStateParams = VONStateEventParams.Cast(params);
      mission.SetVoNActive(vonStateParams.param1);
      m_VoNToggled = vonStateParams.param2;
 
      UpdateVoiceIcon();
 
      m_OnVonStateEvent.Invoke();
      break;
    }
 
    case PartyChatStatusChangedEventTypeID:
    {
      m_OnPartyChatChangedEvent.Invoke();
      break;
    }
 
    case VONStartSpeakingEventTypeID:
    {
      VONStartSpeakingEventParams vonStartParams;
      if (Class.CastTo(vonStartParams, params))
        GetDayZGame().AddVoiceNotification(vonStartParams);
      break;
    }
 
    case VONStopSpeakingEventTypeID:
    {
      VONStopSpeakingEventParams vonStopParams;
      if (Class.CastTo(vonStopParams, params))
        GetDayZGame().RemoveVoiceNotification(vonStopParams);
      break;
    }
 
    case MPSessionPlayerReadyEventTypeID:
    {
      UpdateVoiceIcon();
      break;
    }
    }
  }

References Class::CastTo(), GetDayZGame(), GetGame(), VONManagerBase::HideVoiceNotification(), VONManager::IsVoiceThresholdMinimum(), m_OnPartyChatChangedEvent, m_OnVonStateEvent, m_VoNToggled, mission, MPSessionPlayerReadyEventTypeID, PartyChatStatusChangedEventTypeID, Mission::SetVoNActive(), VONManagerBase::ShowVoiceNotification(), UpdateVoiceIcon(), VONStartSpeakingEventTypeID, VONStateEventTypeID, VONStopSpeakingEventTypeID, VONUserStartedTransmittingAudioEventTypeID, and VONUserStoppedTransmittingAudioEventTypeID.

OnVOIPThresholdChanged()

override void OnVOIPThresholdChanged ( )

protected

Fires every time VOIP threshold value changes.

Definition at line 157 of file VONManager.c.

  {
    UpdateVoiceIcon();
  }

References UpdateVoiceIcon().

ShowVoiceNotification()

override void ShowVoiceNotification ( int level, bool fading )

protected

Shows the voice notification.

Parameters

level	the loudness of the player voice. 0 = whisper, 1 = normal, 2 = shout
fading	specifies whether icon should slowly fade to invisibility after being displayed

Definition at line 56 of file VONManager.c.

  {
    if (GetGame().IsMissionMainMenu())
      return;
 
    Mission mission = GetGame().GetMission();
    ImageWidget micIcon = mission.GetMicrophoneIcon();
    WidgetFadeTimer micTimer = mission.GetMicWidgetFadeTimer();
    map<int, ImageWidget> voiceLeveWidgets = mission.GetVoiceLevelWidgets();
    map<int, ref WidgetFadeTimer> voiceLevelTimers = mission.GetVoiceLevelTimers();
 
    // microphone icon
    micTimer.Stop();
    micIcon.SetAlpha(1.0);
    micIcon.Show(true);
 
    if (fading)
      micTimer.FadeOut(micIcon, 3.0);
 
    // range icons
    for (int n = 0; n < voiceLeveWidgets.Count(); n++)
    {
      int voiceKey = voiceLeveWidgets.GetKey(n);
      ImageWidget voiceWidget = voiceLeveWidgets.Get(n);
 
      // stop fade timer since it will be refreshed
      WidgetFadeTimer timer = voiceLevelTimers.Get(n);
      timer.Stop();
 
      // show widgets according to the level
      if (voiceKey <= level)
      {
        voiceWidget.SetAlpha(1.0); // reset from possible previous fade out
        voiceWidget.Show(true);
 
        if (fading)
          timer.FadeOut(voiceWidget, 3.0);
      }
      else
        voiceWidget.Show(false);
    }
  }

References GetGame(), Mission::GetMicrophoneIcon(), Mission::GetMicWidgetFadeTimer(), Mission::GetVoiceLevelTimers(), Mission::GetVoiceLevelWidgets(), and mission.

UpdateVoiceIcon()

void UpdateVoiceIcon ( )

private

Definition at line 133 of file VONManager.c.

  {
    Mission mission = GetGame().GetMission();
    int rangeLevel = GetGame().GetVoiceLevel();
 
    if (mission.IsVoNActive())
    {
      if (m_VoNToggled)
      {
        if (VONManager.IsVoiceThresholdMinimum())
          ShowVoiceNotification(rangeLevel, false);
        else
          ShowVoiceNotification(rangeLevel, true);
      }
      else
        ShowVoiceNotification(rangeLevel, false);
    }
    else
      HideVoiceNotification();
  }

References GetGame(), VONManagerBase::HideVoiceNotification(), VONManager::IsVoiceThresholdMinimum(), Mission::IsVoNActive(), m_VoNToggled, mission, and VONManagerBase::ShowVoiceNotification().

Referenced by HandleInput(), OnEvent(), and OnVOIPThresholdChanged().

VONManagerBase()

void VONManagerImplementation::VONManagerBase ( )

protected

Definition at line 31 of file VONManager.c.

  {
    m_OnVonStateEvent.Clear();

Referenced by VONManager::CleanupInstance().

VONManagerImplementation()

VONManagerBase Managed VONManagerImplementation

(

)

Definition at line 1 of file VONManager.c.

  {
    m_OnVonStateEvent = new ScriptInvoker();
    m_OnPartyChatChangedEvent = new ScriptInvoker();
  }

Referenced by VONManager::Init().

~VONManagerImplementation()

void ~VONManagerImplementation

(

)

Definition at line 32 of file VONManager.c.

  {
    m_OnVonStateEvent.Clear();
    m_OnPartyChatChangedEvent.Clear();
  }

References m_OnPartyChatChangedEvent, and m_OnVonStateEvent.

Variable Documentation

m_OnPartyChatChangedEvent

ref ScriptInvoker m_OnPartyChatChangedEvent

protected

Definition at line 29 of file VONManager.c.

Referenced by OnEvent(), and ~VONManagerImplementation().

m_OnVonStateEvent

ref ScriptInvoker m_OnVonStateEvent

protected

Definition at line 28 of file VONManager.c.

Referenced by OnEvent(), and ~VONManagerImplementation().

m_VoNToggled

bool m_VoNToggled

protected

Definition at line 27 of file VONManager.c.

Referenced by OnEvent(), and UpdateVoiceIcon().