VON display of active outgoing and incoming transmissions. More...

Inheritance diagram for SCR_VonDisplay:

Public Member Functions
int	GetActiveTransmissionsCount ()
	Count of active incoming transmissions.

bool	IsCapturingTransmisionActive ()
	Whether outgoing transmission is currently active.

void	OnCapture (BaseTransceiver transmitter)
	VONComponent event.

void	OnReceive (int playerId, bool isSenderEditor, BaseTransceiver receiver, int frequency, float quality)
	VONComponent event.

void	ShowSelectedVONHint (SCR_VONEntry entry)
	Show hint displaying which VON method was selected.

void	ShowSelectedVONDisabledHint (bool isServerDisabled=false)
	Show hint displaying which VON method was selected.

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)

Public Member Functions inherited from SCR_InfoDisplayExtended
void	SetEnabled (bool isEnabled)

override void	Show (bool show, float speed=UIConstants.FADE_RATE_INSTANT, EAnimationCurve curve=EAnimationCurve.LINEAR)
	Show/hide InfoDisplay properly, not breaking other systems like AdaptiveOpacity or ConditionalVisibility.

Public Member Functions inherited from SCR_InfoDisplay
SCR_InfoDisplayHandler	GetHandler (TypeName handlerType)

SCR_InfoDisplayInvoker	GetOnStart ()

SCR_InfoDisplayInvoker	GetOnStop ()

IEntity	GetOwnerEntity ()

Widget	GetContentWidget ()

string	GetContentWidgetName ()

void	SetRootWidget (notnull Widget root)

void	SetContentWidget (notnull Widget content)

bool	IsShown ()

Widget	GetRootWidget ()

bool	GetDimensions (out float width, out float height, bool addSafezones=true)
	Get width and height of the InfoDisplay element, optionally with safezones adjustments.

bool	GetAnchorPosition (out float x, out float y, EWidgetAnchor anchor=EWidgetAnchor.TOPLEFT, bool addSafezones=true)
	Get width and height of the InfoDisplay element, optionally with safezones adjustments.

void	RegisterToHudManager ()

Public Member Functions inherited from GroupInfoDisplay
proto external int	GetInfoDisplays (out notnull array< BaseInfoDisplay > outInfoDisplays)

Public Member Functions inherited from BaseInfoDisplay
proto external GenericComponent	FindComponentInParentContainer (TypeName typeName)

Static Public Attributes
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"

static const ref Color	COLOR_WHITE = Color.FromSRGBA(255, 255, 255, 255)

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

Protected Member Functions
Widget	GetWidget ()

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

void	OpacityFade (TransmissionData data, float timeSlice, bool isAdditional=false)
	Fade in/out elements.

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 ()

Protected Member Functions inherited from SCR_InfoDisplayExtended
void	DisplayInit (IEntity owner)

void	DisplayConsciousnessChanged (bool conscious, bool init=false)

void	DisplayOnSuspended ()
	Called when GUI is temporarily suspended due to visibility flags; e.g. GM entered and GUI marked as not to show in GM.

void	DisplayOnResumed ()

void	InitializeInterfaceSettings ()

void	OnSettingsChanged ()

Protected Member Functions inherited from SCR_InfoDisplay
void	OnShownFinished (Widget w, float targetOpacity, WidgetAnimationOpacity anim=null)

void	AdaptiveOpacity_Update (float opacity, float sceneBrightness, bool init=false)

Protected Attributes
string	m_sImageSet

string	m_sImageSetGlow

string	m_sReceivingTransmissionLayout

bool	m_bShowEnemyNames

int	m_iTransmissionSlots = 4

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

Protected Attributes inherited from SCR_InfoDisplayExtended
bool	m_bIsEnabled

string	m_sInterfaceSettingName

SCR_PlayerController	m_PlayerController

SCR_CharacterControllerComponent	m_CharacterController

SCR_CharacterCameraHandlerComponent	m_CameraHandler

MenuManager	m_MenuManager

EventHandlerManagerComponent	m_EventHandlerManager

SCR_EditorManagerEntity	m_EditorManager

bool	m_bAttachedToPlayerController

bool	m_bInThirdPerson

bool	m_bInADS

bool	m_bIsUnconscious

bool	m_bInPauseMenu

bool	m_bInEditor

bool	m_bCanShow

bool	m_bIsEnabledInSettings = true

bool	m_bShowInAllCameras = true

Protected Attributes inherited from SCR_InfoDisplay
string	m_sParentSlot

string	m_sContentWidget

int	m_iContentWidthAdjustment

int	m_iContentHeightAdjustment

string	m_sAdaptiveOpacityWidgetName

ref array< ref SCR_InfoDisplayHandler >	m_aHandlers

bool	m_bShown

Widget	m_wRoot

Widget	m_wContent

Widget	m_wSlot

SCR_HUDManagerComponent	m_HUDManager

int	m_iChildDisplays = 0

ref array< BaseInfoDisplay >	m_aChildDisplays = new array<BaseInfoDisplay>

SCR_InfoDisplay	m_pParentDisplay

bool	m_bRegistered = false

IEntity	m_OwnerEntity

ref array< ref SCR_InfoDisplayHandler >	m_aUpdatableHandlers = {}

ref SCR_InfoDisplayInvoker	m_OnStart = new SCR_InfoDisplayInvoker()

ref SCR_InfoDisplayInvoker	m_OnStop = new SCR_InfoDisplayInvoker()

Static Protected Attributes
const string	LABEL_ROLE_FORMAT = "(%1)"

Additional Inherited Members
Public Attributes inherited from SCR_InfoDisplay
ResourceName	m_LayoutPath

EHudLayers	m_eLayer

int	m_iOverrideZOrder

Detailed Description

VON display of active outgoing and incoming transmissions.

Member Function Documentation

◆ DisplayControlledEntityChanged()

override void SCR_VonDisplay.DisplayControlledEntityChanged	(	IEntity	from,
		IEntity	to )

Implements SCR_InfoDisplayExtended.

◆ DisplayStartDraw()

override void SCR_VonDisplay.DisplayStartDraw ( IEntity owner )

Implements SCR_InfoDisplayExtended.

◆ DisplayStartDrawInit()

override bool SCR_VonDisplay.DisplayStartDrawInit ( IEntity owner )

Implements SCR_InfoDisplayExtended.

◆ DisplayStopDraw()

override void SCR_VonDisplay.DisplayStopDraw ( IEntity owner )

Implements SCR_InfoDisplayExtended.

◆ DisplayUpdate()

override void SCR_VonDisplay.DisplayUpdate	(	IEntity	owner,
		float	timeSlice )

Implements SCR_InfoDisplayExtended.

◆ FadeSelectedVONHint()

void SCR_VonDisplay.FadeSelectedVONHint ( )

protected

◆ GetActiveTransmissionsCount()

int SCR_VonDisplay.GetActiveTransmissionsCount ( )

Count of active incoming transmissions.

◆ GetWidget()

Widget SCR_VonDisplay.GetWidget ( )

protected

◆ InitDisplay()

void SCR_VonDisplay.InitDisplay ( )

protected

Initialize.

◆ IsCapturingTransmisionActive()

bool SCR_VonDisplay.IsCapturingTransmisionActive ( )

Whether outgoing transmission is currently active.

◆ OnCapture()

void SCR_VonDisplay.OnCapture ( BaseTransceiver transmitter )

VONComponent event.

◆ OnDestroyed()

void SCR_VonDisplay.OnDestroyed	(	Instigator	killer,
		IEntity	killerEntity )

protected

SCR_PlayerController Event.

◆ OnReceive()

void SCR_VonDisplay.OnReceive	(	int	playerId,
		bool	isSenderEditor,
		BaseTransceiver	receiver,
		int	frequency,
		float	quality )

VONComponent event.

◆ OnSlotUIResize()

void SCR_VonDisplay.OnSlotUIResize ( )

protected

◆ OnVONActiveToggled()

void SCR_VonDisplay.OnVONActiveToggled	(	bool	directState,
		bool	channelState )

protected

SCR_VONController event -> Toggle microphone indication.

◆ OpacityFade()

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

protected

Fade in/out elements.

Parameters

TransmissionData	is the subject
timeSlice	is the OnFrame slice

◆ SetHintIcon()

void SCR_VonDisplay.SetHintIcon ( bool isRadio )

protected

Set VON info hint icon type.

◆ ShowSelectedVONDisabledHint()

void SCR_VonDisplay.ShowSelectedVONDisabledHint ( bool isServerDisabled = false )

Show hint displaying which VON method was selected.

Parameters

isServerDisabled determines type of disable

◆ ShowSelectedVONHint()

void SCR_VonDisplay.ShowSelectedVONHint ( SCR_VONEntry entry )

Show hint displaying which VON method was selected.

◆ UpdateTransmission()

bool SCR_VonDisplay.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

◆ UpdateWidgets()

void SCR_VonDisplay.UpdateWidgets ( )

protected

Member Data Documentation

◆ COLOR_WHITE

const ref Color SCR_VonDisplay.COLOR_WHITE = Color.FromSRGBA(255, 255, 255, 255)

static

◆ FADEIN_SPEED

const float SCR_VonDisplay.FADEIN_SPEED = 10

static

◆ FADEOUT_SPEED

const float SCR_VonDisplay.FADEOUT_SPEED = 5

static

◆ FADEOUT_TIMER_THRESHOLD

const float SCR_VonDisplay.FADEOUT_TIMER_THRESHOLD = 1

static

◆ HEIGHT_DIVIDER

const int SCR_VonDisplay.HEIGHT_DIVIDER = 35

static

◆ ICON_DIRECT_SPEECH

const string SCR_VonDisplay.ICON_DIRECT_SPEECH = "VON_directspeech"

static

◆ ICON_RADIO

const string SCR_VonDisplay.ICON_RADIO = "VON_frequency"

static

◆ ICON_RADIO_HINT

const string SCR_VonDisplay.ICON_RADIO_HINT = "VON_radio"

static

◆ ICON_RADIO_MUTED

const string SCR_VonDisplay.ICON_RADIO_MUTED = "sound-off"

static

◆ ICON_SERVER_DISABLE_HINT

const string SCR_VonDisplay.ICON_SERVER_DISABLE_HINT = "server-locked"

static

◆ LABEL_CHANNEL_PLATOON

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

static

◆ LABEL_FREQUENCY_UNITS

const string SCR_VonDisplay.LABEL_FREQUENCY_UNITS = "#AR-VON_FrequencyUnits_MHz"

static

◆ LABEL_ROLE_FORMAT

const string SCR_VonDisplay.LABEL_ROLE_FORMAT = "(%1)"

staticprotected

◆ LABEL_UNKNOWN_SOURCE

const string SCR_VonDisplay.LABEL_UNKNOWN_SOURCE = "#AR-VON_UnknownSource"

static

◆ m_aAdditionalSpeakers

ref array<ref TransmissionData> SCR_VonDisplay.m_aAdditionalSpeakers = {}

protected

◆ m_aTransmissionMap

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

protected

◆ m_aTransmissions

ref array<ref TransmissionData> SCR_VonDisplay.m_aTransmissions = {}

protected

◆ m_aWidgetsIncomingVON

ref array<Widget> SCR_VonDisplay.m_aWidgetsIncomingVON = {}

protected

◆ m_bIsChannelToggled

bool SCR_VonDisplay.m_bIsChannelToggled

protected

◆ m_bIsDirectToggled

bool SCR_VonDisplay.m_bIsDirectToggled

protected

◆ m_bIsVONDirectDisabled

bool SCR_VonDisplay.m_bIsVONDirectDisabled

protected

◆ m_bIsVONUIDisabled

bool SCR_VonDisplay.m_bIsVONUIDisabled

protected

◆ m_bShowEnemyNames

bool SCR_VonDisplay.m_bShowEnemyNames

protected

◆ m_HUDSlotComponent

SCR_HUDSlotUIComponent SCR_VonDisplay.m_HUDSlotComponent

protected

◆ m_iTransmissionSlots

int SCR_VonDisplay.m_iTransmissionSlots = 4

protected

◆ m_OutTransmission

ref TransmissionData SCR_VonDisplay.m_OutTransmission

protected

◆ m_PlayerManager

PlayerManager SCR_VonDisplay.m_PlayerManager

protected

◆ m_sImageSet

string SCR_VonDisplay.m_sImageSet

protected

◆ m_sImageSetGlow

string SCR_VonDisplay.m_sImageSetGlow

protected

◆ m_SlotHandler

SCR_InfoDisplaySlotHandler SCR_VonDisplay.m_SlotHandler

protected

◆ m_sReceivingTransmissionLayout

string SCR_VonDisplay.m_sReceivingTransmissionLayout

protected

◆ m_VONController

SCR_VONController SCR_VonDisplay.m_VONController

protected

◆ m_wAdditionalSpeakersText

RichTextWidget SCR_VonDisplay.m_wAdditionalSpeakersText

protected

◆ m_wAdditionalSpeakersWidget

Widget SCR_VonDisplay.m_wAdditionalSpeakersWidget

protected

◆ m_wSelectedHint

Widget SCR_VonDisplay.m_wSelectedHint

protected

◆ m_wSelectedHintIcon

ImageWidget SCR_VonDisplay.m_wSelectedHintIcon

protected

◆ m_wSelectedHintIconGlow

ImageWidget SCR_VonDisplay.m_wSelectedHintIconGlow

protected

◆ m_wSelectedText

TextWidget SCR_VonDisplay.m_wSelectedText

protected

◆ m_wSelectedVON

TextWidget SCR_VonDisplay.m_wSelectedVON

protected

◆ m_wTalkingAmountWidget

Widget SCR_VonDisplay.m_wTalkingAmountWidget

protected

◆ m_wVerticalLayout

Widget SCR_VonDisplay.m_wVerticalLayout

protected

◆ SELECTED_HINT_FADE_SPEED

const int SCR_VonDisplay.SELECTED_HINT_FADE_SPEED = 3000

static

◆ WIDGET_INCOMING

const string SCR_VonDisplay.WIDGET_INCOMING = "VonIncoming"

static

◆ WIDGET_OVERFLOW

const string SCR_VonDisplay.WIDGET_OVERFLOW = "VonAdditional"

static

◆ WIDGET_OVERFLOW_TEXT

const string SCR_VonDisplay.WIDGET_OVERFLOW_TEXT = "number"

static

◆ WIDGET_SELECTED_ICON

const string SCR_VonDisplay.WIDGET_SELECTED_ICON = "Selected_Icon"

static

◆ WIDGET_SELECTED_ICONGLOW

const string SCR_VonDisplay.WIDGET_SELECTED_ICONGLOW = "Selected_IconGlow"

static

◆ WIDGET_SELECTED_ROOT

const string SCR_VonDisplay.WIDGET_SELECTED_ROOT = "VonSelected"

static

◆ WIDGET_SELECTED_TEXT

const string SCR_VonDisplay.WIDGET_SELECTED_TEXT = "Selected_Text"

static

◆ WIDGET_SELECTED_VON

const string SCR_VonDisplay.WIDGET_SELECTED_VON = "Selected_VONChannel"

static

◆ WIDGET_TRANSMIT

const string SCR_VonDisplay.WIDGET_TRANSMIT = "VonTransmitting"

static

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

Game/UI/HUD/SCR_VonDisplay.c

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DisplayControlledEntityChanged()

◆ DisplayStartDraw()

◆ DisplayStartDrawInit()

◆ DisplayStopDraw()

◆ DisplayUpdate()

◆ FadeSelectedVONHint()

◆ GetActiveTransmissionsCount()

◆ GetWidget()

◆ InitDisplay()

◆ IsCapturingTransmisionActive()

◆ OnCapture()

◆ OnDestroyed()

◆ OnReceive()

◆ OnSlotUIResize()

◆ OnVONActiveToggled()

◆ OpacityFade()

◆ SetHintIcon()

◆ ShowSelectedVONDisabledHint()

◆ ShowSelectedVONHint()

◆ UpdateTransmission()

◆ UpdateWidgets()

Member Data Documentation

◆ COLOR_WHITE

◆ FADEIN_SPEED

◆ FADEOUT_SPEED

◆ FADEOUT_TIMER_THRESHOLD

◆ HEIGHT_DIVIDER

◆ ICON_DIRECT_SPEECH

◆ ICON_RADIO

◆ ICON_RADIO_HINT

◆ ICON_RADIO_MUTED

◆ ICON_SERVER_DISABLE_HINT

◆ LABEL_CHANNEL_PLATOON

◆ LABEL_FREQUENCY_UNITS

◆ LABEL_ROLE_FORMAT

◆ LABEL_UNKNOWN_SOURCE

◆ m_aAdditionalSpeakers

◆ m_aTransmissionMap

◆ m_aTransmissions

◆ m_aWidgetsIncomingVON

◆ m_bIsChannelToggled

◆ m_bIsDirectToggled

◆ m_bIsVONDirectDisabled

◆ m_bIsVONUIDisabled

◆ m_bShowEnemyNames

◆ m_HUDSlotComponent

◆ m_iTransmissionSlots

◆ m_OutTransmission

◆ m_PlayerManager

◆ m_sImageSet

◆ m_sImageSetGlow

◆ m_SlotHandler

◆ m_sReceivingTransmissionLayout

◆ m_VONController

◆ m_wAdditionalSpeakersText

◆ m_wAdditionalSpeakersWidget

◆ m_wSelectedHint

◆ m_wSelectedHintIcon

◆ m_wSelectedHintIconGlow

◆ m_wSelectedText

◆ m_wSelectedVON

◆ m_wTalkingAmountWidget

◆ m_wVerticalLayout

◆ SELECTED_HINT_FADE_SPEED

◆ WIDGET_INCOMING

◆ WIDGET_OVERFLOW

◆ WIDGET_OVERFLOW_TEXT

◆ WIDGET_SELECTED_ICON

◆ WIDGET_SELECTED_ICONGLOW

◆ WIDGET_SELECTED_ROOT

◆ WIDGET_SELECTED_TEXT

◆ WIDGET_SELECTED_VON