SCR_VonDisplay.c File Reference

Go to the source code of this file.

Classes
class	TransmissionData
	Data class for transmissions. More...

Functions
class TransmissionData	Attribute (UIConstants.ICONS_IMAGE_SET)] protected string m_sImageSet
	VON display of active outgoing and incoming transmissions.
void	HideTransmission ()
void	TransmissionData (Widget base, int iPlayerID)
int	GetActiveTransmissionsCount ()
	Count of active incoming transmissions.
bool	IsCapturingTransmisionActive ()
	Whether outgoing transmission is currently active.
event void	OnCapture (BaseTransceiver transmitter)
	VONComponent event.
Widget	GetWidget ()
event void	OnReceive (int playerId, bool isSenderEditor, BaseTransceiver receiver, int frequency, float quality)
	VONComponent event.
bool	UpdateTransmission (TransmissionData data, BaseTransceiver radioTransceiver, int frequency, bool IsReceiving)
void	OpacityFade (TransmissionData data, float timeSlice, bool isAdditional=false)
void	ShowSelectedVONHint (SCR_VONEntry entry)
	Show hint displaying which VON method was selected.
void	ShowSelectedVONDisabledHint (bool isServerDisabled=false)
void	FadeSelectedVONHint ()
void	SetHintIcon (bool isRadio)
	Set VON info hint icon type.
void	OnVONActiveToggled (bool directState, bool channelState)
	SCR_VONController event -> Toggle microphone indication.
void	OnDestroyed (Instigator killer, IEntity killerEntity)
	SCR_PlayerController Event.
void	InitDisplay ()
	Initialize.
void	OnSlotUIResize ()
void	UpdateWidgets ()
override void	DisplayUpdate (IEntity owner, float timeSlice)
override bool	DisplayStartDrawInit (IEntity owner)
override void	DisplayStartDraw (IEntity owner)
override void	DisplayControlledEntityChanged (IEntity from, IEntity to)
override void	DisplayStopDraw (IEntity owner)

Variables
ref SCR_VoNOverlay_ElementWidgets	m_Widgets
Widget	m_wBaseWidget
bool	m_bForceUpdate
bool	m_bVisible
bool	m_bIsActive
bool	m_bIsAnimating
bool	m_bIsAdditional
int	m_iPlayerID
float	m_fAlpha
float	m_fActiveTimeout
float	m_fFrequency
float	m_fQuality
IEntity	m_Entity
bool	m_bIsSenderEditor
Faction	m_Faction
BaseTransceiver	m_RadioTransceiver
string	m_sImageSetGlow
string	m_sReceivingTransmissionLayout
bool	m_bShowEnemyNames
const string	ICON_DIRECT_SPEECH = "VON_directspeech"
const string	ICON_RADIO_HINT = "VON_radio"
const string	ICON_RADIO = "VON_frequency"
const string	ICON_RADIO_MUTED = "sound-off"
const string	ICON_SERVER_DISABLE_HINT = "server-locked"
const string	LABEL_FREQUENCY_UNITS = "#AR-VON_FrequencyUnits_MHz"
const string	LABEL_UNKNOWN_SOURCE = "#AR-VON_UnknownSource"
const string	LABEL_CHANNEL_PLATOON = "#AR-VON_ChannelPlatoon-UC"
const string	WIDGET_INCOMING = "VonIncoming"
const string	WIDGET_TRANSMIT = "VonTransmitting"
const string	WIDGET_OVERFLOW = "VonAdditional"
const string	WIDGET_OVERFLOW_TEXT = "number"
const string	WIDGET_SELECTED_ROOT = "VonSelected"
const string	WIDGET_SELECTED_ICON = "Selected_Icon"
const string	WIDGET_SELECTED_ICONGLOW = "Selected_IconGlow"
const string	WIDGET_SELECTED_VON = "Selected_VONChannel"
const string	WIDGET_SELECTED_TEXT = "Selected_Text"
int	m_iTransmissionSlots = 4
const float	FADEOUT_TIMER_THRESHOLD = 1
const float	FADEIN_SPEED = 10
const float	FADEOUT_SPEED = 5
const int	SELECTED_HINT_FADE_SPEED = 3000
const int	HEIGHT_DIVIDER = 35
bool	m_bIsVONUIDisabled
bool	m_bIsVONDirectDisabled
bool	m_bIsDirectToggled
bool	m_bIsChannelToggled
ref TransmissionData	m_OutTransmission
ref array< Widget >	m_aWidgetsIncomingVON = {}
ref array< ref TransmissionData >	m_aTransmissions = {}
ref map< int, TransmissionData >	m_aTransmissionMap = new map<int, TransmissionData>
ref array< ref TransmissionData >	m_aAdditionalSpeakers = {}
PlayerManager	m_PlayerManager
SCR_VONController	m_VONController
SCR_InfoDisplaySlotHandler	m_SlotHandler
SCR_HUDSlotUIComponent	m_HUDSlotComponent
Widget	m_wVerticalLayout
Widget	m_wSelectedHint
ImageWidget	m_wSelectedHintIcon
ImageWidget	m_wSelectedHintIconGlow
TextWidget	m_wSelectedVON
TextWidget	m_wSelectedText
Widget	m_wTalkingAmountWidget
Widget	m_wAdditionalSpeakersWidget
RichTextWidget	m_wAdditionalSpeakersText
const string	LABEL_ROLE_FORMAT = "(%1)"

Function Documentation

Attribute()

class TransmissionData Attribute

(

UIConstants.

ICONS_IMAGE_SET

)

VON display of active outgoing and incoming transmissions.

DisplayControlledEntityChanged()

override void DisplayControlledEntityChanged ( IEntity from, IEntity to )

protected

Definition at line 859 of file SCR_VonDisplay.c.

DisplayStartDraw()

override void DisplayStartDraw ( IEntity owner )

protected

Definition at line 850 of file SCR_VonDisplay.c.

DisplayStartDrawInit()

override bool DisplayStartDrawInit ( IEntity owner )

protected

Definition at line 842 of file SCR_VonDisplay.c.

DisplayStopDraw()

override void DisplayStopDraw ( IEntity owner )

protected

Definition at line 872 of file SCR_VonDisplay.c.

DisplayUpdate()

override void DisplayUpdate ( IEntity owner, float timeSlice )

protected

Definition at line 736 of file SCR_VonDisplay.c.

FadeSelectedVONHint()

void FadeSelectedVONHint ( )

protected

Definition at line 596 of file SCR_VonDisplay.c.

GetActiveTransmissionsCount()

int GetActiveTransmissionsCount ( )

protected

Count of active incoming transmissions.

Definition at line 124 of file SCR_VonDisplay.c.

GetWidget()

Widget GetWidget ( )

protected

Definition at line 162 of file SCR_VonDisplay.c.

HideTransmission()

void Attribute::HideTransmission

(

)

Definition at line 21 of file SCR_VonDisplay.c.

InitDisplay()

void InitDisplay ( )

protected

Initialize.

Definition at line 649 of file SCR_VonDisplay.c.

IsCapturingTransmisionActive()

bool IsCapturingTransmisionActive ( )

protected

Whether outgoing transmission is currently active.

Definition at line 131 of file SCR_VonDisplay.c.

OnDestroyed()

void OnDestroyed ( Instigator killer, IEntity killerEntity )

protected

SCR_PlayerController Event.

Definition at line 635 of file SCR_VonDisplay.c.

OnSlotUIResize()

void OnSlotUIResize ( )

protected

Definition at line 684 of file SCR_VonDisplay.c.

OnVONActiveToggled()

void OnVONActiveToggled ( bool directState, bool channelState )

protected

SCR_VONController event -> Toggle microphone indication.

Definition at line 621 of file SCR_VonDisplay.c.

OpacityFade()

void OpacityFade ( TransmissionData data, float timeSlice, bool isAdditional = false )

protected

Fade in/out elements

Parameters

TransmissionData	is the subject
timeSlice	is the OnFrame slice

Definition at line 498 of file SCR_VonDisplay.c.

SetHintIcon()

void SetHintIcon ( bool isRadio )

protected

Set VON info hint icon type.

Definition at line 603 of file SCR_VonDisplay.c.

ShowSelectedVONDisabledHint()

void ShowSelectedVONDisabledHint ( bool isServerDisabled = false )

protected

Show hint displaying which VON method was selected

Parameters

isServerDisabled

determines type of disable

Definition at line 572 of file SCR_VonDisplay.c.

ShowSelectedVONHint()

void ShowSelectedVONHint ( SCR_VONEntry entry )

protected

Show hint displaying which VON method was selected.

Definition at line 542 of file SCR_VonDisplay.c.

TransmissionData()

void Attribute::TransmissionData	(	Widget	base,
		int	iPlayerID )

Definition at line 33 of file SCR_VonDisplay.c.

UpdateTransmission()

bool UpdateTransmission ( TransmissionData data, BaseTransceiver radioTransceiver, int frequency, bool IsReceiving )

protected

Update transmission data

Parameters

TransmissionData	is the subject
radioTransceiver	is the used transceiver for the transmission
IsReceiving	is true when receiving transmission, false when transmitting
isAdditionalSpeaker	is true when all incomming transmission widgets are full

Returns

false if the transimission is filtered out to not be visible

Definition at line 246 of file SCR_VonDisplay.c.

UpdateWidgets()

void UpdateWidgets ( )

protected

Definition at line 700 of file SCR_VonDisplay.c.

Variable Documentation

FADEIN_SPEED

const float FADEIN_SPEED = 10

protected

Definition at line 89 of file SCR_VonDisplay.c.

FADEOUT_SPEED

const float FADEOUT_SPEED = 5

protected

Definition at line 90 of file SCR_VonDisplay.c.

FADEOUT_TIMER_THRESHOLD

const float FADEOUT_TIMER_THRESHOLD = 1

protected

Definition at line 88 of file SCR_VonDisplay.c.

HEIGHT_DIVIDER

const int HEIGHT_DIVIDER = 35

protected

Definition at line 92 of file SCR_VonDisplay.c.

ICON_DIRECT_SPEECH

const string ICON_DIRECT_SPEECH = "VON_directspeech"

protected

Definition at line 66 of file SCR_VonDisplay.c.

ICON_RADIO

const string ICON_RADIO = "VON_frequency"

protected

Definition at line 68 of file SCR_VonDisplay.c.

ICON_RADIO_HINT

const string ICON_RADIO_HINT = "VON_radio"

protected

Definition at line 67 of file SCR_VonDisplay.c.

ICON_RADIO_MUTED

const string ICON_RADIO_MUTED = "sound-off"

protected

Definition at line 69 of file SCR_VonDisplay.c.

ICON_SERVER_DISABLE_HINT

const string ICON_SERVER_DISABLE_HINT = "server-locked"

protected

Definition at line 70 of file SCR_VonDisplay.c.

LABEL_CHANNEL_PLATOON

const string LABEL_CHANNEL_PLATOON = "#AR-VON_ChannelPlatoon-UC"

protected

Definition at line 74 of file SCR_VonDisplay.c.

LABEL_FREQUENCY_UNITS

const string LABEL_FREQUENCY_UNITS = "#AR-VON_FrequencyUnits_MHz"

protected

Definition at line 72 of file SCR_VonDisplay.c.

LABEL_ROLE_FORMAT

const string LABEL_ROLE_FORMAT = "(%1)"

protected

Definition at line 120 of file SCR_VonDisplay.c.

LABEL_UNKNOWN_SOURCE

const string LABEL_UNKNOWN_SOURCE = "#AR-VON_UnknownSource"

protected

Definition at line 73 of file SCR_VonDisplay.c.

m_aAdditionalSpeakers

ref array<ref TransmissionData> m_aAdditionalSpeakers = {}

protected

Definition at line 103 of file SCR_VonDisplay.c.

m_aTransmissionMap

ref map<int, TransmissionData> m_aTransmissionMap = new map<int, TransmissionData>

protected

Definition at line 102 of file SCR_VonDisplay.c.

m_aTransmissions

ref array<ref TransmissionData> m_aTransmissions = {}

protected

Definition at line 101 of file SCR_VonDisplay.c.

m_aWidgetsIncomingVON

ref array<Widget> m_aWidgetsIncomingVON = {}

protected

Definition at line 100 of file SCR_VonDisplay.c.

m_bForceUpdate

bool m_bForceUpdate

Definition at line 4 of file SCR_VonDisplay.c.

m_bIsActive

bool m_bIsActive

Definition at line 6 of file SCR_VonDisplay.c.

m_bIsAdditional

bool m_bIsAdditional

Definition at line 8 of file SCR_VonDisplay.c.

m_bIsAnimating

bool m_bIsAnimating

Definition at line 7 of file SCR_VonDisplay.c.

m_bIsChannelToggled

bool m_bIsChannelToggled

protected

Definition at line 97 of file SCR_VonDisplay.c.

m_bIsDirectToggled

bool m_bIsDirectToggled

protected

Definition at line 96 of file SCR_VonDisplay.c.

m_bIsSenderEditor

bool m_bIsSenderEditor

Definition at line 15 of file SCR_VonDisplay.c.

m_bIsVONDirectDisabled

bool m_bIsVONDirectDisabled

protected

Definition at line 95 of file SCR_VonDisplay.c.

m_bIsVONUIDisabled

bool m_bIsVONUIDisabled

protected

Definition at line 94 of file SCR_VonDisplay.c.

m_bShowEnemyNames

bool m_bShowEnemyNames

protected

Definition at line 64 of file SCR_VonDisplay.c.

m_bVisible

bool m_bVisible

Definition at line 5 of file SCR_VonDisplay.c.

m_Entity

IEntity m_Entity

Definition at line 14 of file SCR_VonDisplay.c.

m_Faction

Faction m_Faction

Definition at line 16 of file SCR_VonDisplay.c.

m_fActiveTimeout

float m_fActiveTimeout

Definition at line 11 of file SCR_VonDisplay.c.

m_fAlpha

float m_fAlpha

Definition at line 10 of file SCR_VonDisplay.c.

m_fFrequency

float m_fFrequency

Definition at line 12 of file SCR_VonDisplay.c.

m_fQuality

float m_fQuality

Definition at line 13 of file SCR_VonDisplay.c.

m_HUDSlotComponent

SCR_HUDSlotUIComponent m_HUDSlotComponent

protected

Definition at line 108 of file SCR_VonDisplay.c.

m_iPlayerID

int m_iPlayerID

Definition at line 9 of file SCR_VonDisplay.c.

m_iTransmissionSlots

int m_iTransmissionSlots = 4

protected

Definition at line 87 of file SCR_VonDisplay.c.

m_OutTransmission

ref TransmissionData m_OutTransmission

protected

Definition at line 99 of file SCR_VonDisplay.c.

m_PlayerManager

PlayerManager m_PlayerManager

protected

Definition at line 105 of file SCR_VonDisplay.c.

m_RadioTransceiver

BaseTransceiver m_RadioTransceiver

Definition at line 17 of file SCR_VonDisplay.c.

m_sImageSetGlow

string m_sImageSetGlow

protected

Definition at line 58 of file SCR_VonDisplay.c.

m_SlotHandler

SCR_InfoDisplaySlotHandler m_SlotHandler

protected

Definition at line 107 of file SCR_VonDisplay.c.

m_sReceivingTransmissionLayout

string m_sReceivingTransmissionLayout

protected

Definition at line 61 of file SCR_VonDisplay.c.

m_VONController

SCR_VONController m_VONController

protected

Definition at line 106 of file SCR_VonDisplay.c.

m_wAdditionalSpeakersText

RichTextWidget m_wAdditionalSpeakersText

protected

Definition at line 118 of file SCR_VonDisplay.c.

m_wAdditionalSpeakersWidget

Widget m_wAdditionalSpeakersWidget

protected

Definition at line 117 of file SCR_VonDisplay.c.

m_wBaseWidget

Widget m_wBaseWidget

Definition at line 2 of file SCR_VonDisplay.c.

m_Widgets

ref SCR_VoNOverlay_ElementWidgets m_Widgets

Definition at line 1 of file SCR_VonDisplay.c.

m_wSelectedHint

Widget m_wSelectedHint

protected

Definition at line 111 of file SCR_VonDisplay.c.

m_wSelectedHintIcon

ImageWidget m_wSelectedHintIcon

protected

Definition at line 112 of file SCR_VonDisplay.c.

m_wSelectedHintIconGlow

ImageWidget m_wSelectedHintIconGlow

protected

Definition at line 113 of file SCR_VonDisplay.c.

m_wSelectedText

TextWidget m_wSelectedText

protected

Definition at line 115 of file SCR_VonDisplay.c.

m_wSelectedVON

TextWidget m_wSelectedVON

protected

Definition at line 114 of file SCR_VonDisplay.c.

m_wTalkingAmountWidget

Widget m_wTalkingAmountWidget

protected

Definition at line 116 of file SCR_VonDisplay.c.

m_wVerticalLayout

Widget m_wVerticalLayout

protected

Definition at line 110 of file SCR_VonDisplay.c.

SELECTED_HINT_FADE_SPEED

const int SELECTED_HINT_FADE_SPEED = 3000

protected

Definition at line 91 of file SCR_VonDisplay.c.

WIDGET_INCOMING

const string WIDGET_INCOMING = "VonIncoming"

protected

Definition at line 75 of file SCR_VonDisplay.c.

WIDGET_OVERFLOW

const string WIDGET_OVERFLOW = "VonAdditional"

protected

Definition at line 77 of file SCR_VonDisplay.c.

WIDGET_OVERFLOW_TEXT

const string WIDGET_OVERFLOW_TEXT = "number"

protected

Definition at line 78 of file SCR_VonDisplay.c.

WIDGET_SELECTED_ICON

const string WIDGET_SELECTED_ICON = "Selected_Icon"

protected

Definition at line 80 of file SCR_VonDisplay.c.

WIDGET_SELECTED_ICONGLOW

const string WIDGET_SELECTED_ICONGLOW = "Selected_IconGlow"

protected

Definition at line 81 of file SCR_VonDisplay.c.

WIDGET_SELECTED_ROOT

const string WIDGET_SELECTED_ROOT = "VonSelected"

protected

Definition at line 79 of file SCR_VonDisplay.c.

WIDGET_SELECTED_TEXT

const string WIDGET_SELECTED_TEXT = "Selected_Text"

protected

Definition at line 83 of file SCR_VonDisplay.c.

WIDGET_SELECTED_VON

const string WIDGET_SELECTED_VON = "Selected_VONChannel"

protected

Definition at line 82 of file SCR_VonDisplay.c.

WIDGET_TRANSMIT

const string WIDGET_TRANSMIT = "VonTransmitting"

protected

Definition at line 76 of file SCR_VonDisplay.c.