Data Structures
class	SCR_VONControllerClass

Typedefs
typedef func	OnVONActiveToggled

typedef func	OnEntriesChanged

Enumerations
enum	EVONTransmitType
	Type of a players current VON transmission. More...

Functions
enum EVONTransmitType	OnVONActiveToggled (bool isToggledDirect, bool isToggledChannel)
	SCR_VONController event -> Toggle microphone indication. More...

void	OnEntriesChanged (SCR_VONEntry entry, bool state)

ScriptInvokerBase< OnEntriesChanged >	GetOnEntriesChangedInvoker ()

ScriptInvokerBase< OnEntriesChanged >	GetOnEntriesActiveChangedInvoker ()

ScriptInvokerBase< OnVONActiveToggled >	GetOnVONActiveToggledInvoker ()

void	SetDisplay (SCR_VonDisplay display)

SCR_VonDisplay	GetDisplay ()

SCR_VONMenu	GetVONMenu ()

bool	SetVONDisabled (bool state)

bool	IsVONDisabled ()
	Is VON disabled. More...

SCR_VoNComponent	GetVONComponent ()
	Get active VON component for transmit. More...

void	SetVONComponent (SCR_VoNComponent VONComp)

int	GetVONEntries (inout array< ref SCR_VONEntry > entries)

int	GetVONEntryCount ()
	Get number of entries. More...

SCR_VONEntry	GetActiveEntry ()

bool	IsUsingLRR ()
	Using long range radio. More...

bool	IsLRRAvailable ()
	Long range raido entry is available. More...

void	SetEntryActive (SCR_VONEntry entry, bool setFromMenu=false)

void	AddEntry (SCR_VONEntry entry)

void	RemoveEntry (SCR_VONEntry entry)

protected void	SetGamepadLRRMode (bool state, bool isSwitch=false)
	Sets long rang radio mode for gamepad input scheme. More...

protected void	OnVONDirect (float value, EActionTrigger reason)
	VON direct speech listener callback. More...

protected void	OnVONChannel (float value, EActionTrigger reason)
	VON channel speech listener callback. More...

protected void	OnVONLongRange (float value, EActionTrigger reason)
	VON channel speech listener callback for long range radios. More...

protected void	OnVONGamepad (float value, EActionTrigger reason)
	VON channel speech listener callback. More...

protected void	OnVONLongRangeGamepadToggle (float value, EActionTrigger reason)

protected void	OnVONToggle (float value, EActionTrigger reason)
	VON toggle val 0 = off / 1 = direct / 2 = channel. More...

protected void	OnVONToggleGamepad (float value, EActionTrigger reason)
	VON toggle controller. More...

protected void	OnVONSwitch (float value, EActionTrigger reason)
	VON switch between direct/channel mode. More...

protected void	VONDirect (bool activate)

protected void	VONChannel (bool activate)

protected void	VONLongRange (bool activate)

protected void	ActivateVON (EVONTransmitType transmitType)

protected void	DeactivateVON (EVONTransmitType transmitType=EVONTransmitType.NONE)
	Current VON deactivation. More...

protected SCR_VONEntry	GetEntryByTransmitType (EVONTransmitType type)

protected void	SetActiveTransmit (notnull SCR_VONEntry entry)
	Set transmission method depending on entry type when starting VON transmit. More...

protected void	TimeoutVON ()
	VON hold timeout, stops active von transmission in case of specific condition which would prevent for it to end normally. More...

protected void	OnControlledEntityChanged (IEntity from, IEntity to)
	Runs every time the controlled entity has been changed. More...

protected void	OnDestroyed (Instigator killer, IEntity killerEntity)

protected void	OnPlayerDeleted (int playerId, IEntity player)

protected void	OnInputDeviceIsGamepad (bool isGamepad)
	Game Event. More...

protected void	OnPauseMenuOpened ()
	PauseMenuUI Event. More...

protected void	OnPauseMenuClosed ()
	PauseMenuUI Event. More...

bool	AssignVONComponent ()
	Assign VON comp by fetching it from controlled entity. More...

void	OnLifeStateChanged (ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState)
	Will be called when the life state of the character changes. More...

protected void	InitEncryptionKey ()

protected void	Init (IEntity owner)
	Initialize component, done once per controller. More...

protected void	Cleanup ()
	Cleanup component. More...

protected void	UpdateDebug ()
	Debug. More...

override protected void	OnPostInit (IEntity owner)
	Editable Mine. More...

override protected void	EOnDeactivate (IEntity owner)

protected void	UpdateSystemState ()

protected void	ConnectToHandleUpdateVONControllersSystem ()

protected void	DisconnectFromHandleUpdateVONControllersSystem ()

void	Update (float timeSlice)

override void	OnDelete (IEntity owner)

Variables
	NONE

	DIRECT

	CHANNEL

	LONG_RANGE

SCR_VONControllerClass	VON_MENU_OPENING_CONTEXT = "VONMenuOpeningContext"
	Scripted VON input and control, attached to SCR_PlayerController. More...

protected ref SCR_VONMenu	m_VONMenu

const protected string	VON_DIRECT_HOLD = "VONDirect"

const protected string	VON_CHANNEL_HOLD = "VONChannel"

const protected string	VON_LONG_RANGE_HOLD = "VONLongRange"

const protected float	TOGGLE_OFF_DELAY = 0.5

protected bool	m_bIsDisabled

protected bool	m_bIsPauseDisabled

protected bool	m_bIsUnconscious

protected bool	m_bIsActive

protected bool	m_bIsToggledDirect

protected bool	m_bIsToggledChannel

protected bool	m_bIsUsingGamepad

protected bool	m_bIsActiveModeDirect

protected bool	m_bIsActiveModeLong

protected float	m_fToggleOffDelay

protected string	m_sActiveHoldAction

protected string	m_sLocalEncryptionKey

protected EVONTransmitType	m_eVONType

protected InputManager	m_InputManager

protected SCR_VoNComponent	m_VONComp

protected SCR_VonDisplay	m_VONDisplay

protected SCR_VONEntry	m_ActiveEntry

protected SCR_VONEntry	m_LongRangeEntry

protected SCR_VONEntry	m_SavedEntry

protected ref SCR_VONEntry	m_DirectSpeechEntry

protected ref array< ref SCR_VONEntry >	m_aEntries = {}

protected ref ScriptInvokerBase< OnEntriesChanged >	m_OnEntriesChanged = new ScriptInvokerBase<OnEntriesChanged>()

protected ref ScriptInvokerBase< OnEntriesChanged >	m_OnEntriesActiveChanged = new ScriptInvokerBase<OnEntriesChanged>()

protected ref ScriptInvokerBase< OnVONActiveToggled >	m_OnVONActiveToggled = new ScriptInvokerBase<OnVONActiveToggled>()

Typedef Documentation

◆ OnEntriesChanged

typedef func OnEntriesChanged

Definition at line 17 of file SCR_VONController.c.

◆ OnVONActiveToggled

typedef func OnVONActiveToggled

Definition at line 14 of file SCR_VONController.c.

Enumeration Type Documentation

◆ EVONTransmitType

enum EVONTransmitType

Type of a players current VON transmission.

Definition at line 3 of file SCR_VONController.c.

Function Documentation

◆ ActivateVON()

protected void ActivateVON ( EVONTransmitType transmitType )

VON activation

Parameters

entry is the subject VON entry

Definition at line 508 of file SCR_VONController.c.

◆ AddEntry()

void AddEntry ( SCR_VONEntry entry )

Add new VON entry Set as active entry if m_ActiveEntry is null

Parameters

entry is subject entry

Definition at line 222 of file SCR_VONController.c.

◆ AssignVONComponent()

bool AssignVONComponent ( )

Assign VON comp by fetching it from controlled entity.

Definition at line 714 of file SCR_VONController.c.

◆ Cleanup()

protected void Cleanup ( )

Cleanup component.

Definition at line 807 of file SCR_VONController.c.

◆ ConnectToHandleUpdateVONControllersSystem()

protected void ConnectToHandleUpdateVONControllersSystem ( )

Definition at line 896 of file SCR_VONController.c.

◆ DeactivateVON()

protected void DeactivateVON ( EVONTransmitType transmitType = EVONTransmitType.NONE )

Current VON deactivation.

Definition at line 536 of file SCR_VONController.c.

◆ DisconnectFromHandleUpdateVONControllersSystem()

protected void DisconnectFromHandleUpdateVONControllersSystem ( )

Definition at line 907 of file SCR_VONController.c.

◆ GetActiveEntry()

SCR_VONEntry GetActiveEntry ( )

Get active entry for outgoing transmission

Returns: active entry

Definition at line 163 of file SCR_VONController.c.

◆ GetDisplay()

SCR_VonDisplay GetDisplay ( )

Definition at line 91 of file SCR_VONController.c.

◆ GetEntryByTransmitType()

protected SCR_VONEntry GetEntryByTransmitType ( EVONTransmitType type )

Definition at line 556 of file SCR_VONController.c.

◆ GetOnEntriesActiveChangedInvoker()

ScriptInvokerBase<OnEntriesChanged> GetOnEntriesActiveChangedInvoker ( )

Definition at line 73 of file SCR_VONController.c.

◆ GetOnEntriesChangedInvoker()

ScriptInvokerBase<OnEntriesChanged> GetOnEntriesChangedInvoker ( )

Definition at line 67 of file SCR_VONController.c.

◆ GetOnVONActiveToggledInvoker()

ScriptInvokerBase<OnVONActiveToggled> GetOnVONActiveToggledInvoker ( )

Definition at line 79 of file SCR_VONController.c.

◆ GetVONEntries()

int GetVONEntries ( inout array< ref SCR_VONEntry > entries )

Get current entries

Returns: count of entries

Definition at line 142 of file SCR_VONController.c.

◆ GetVONEntryCount()

int GetVONEntryCount ( )

Get number of entries.

Definition at line 155 of file SCR_VONController.c.

◆ GetVONMenu()

SCR_VONMenu GetVONMenu ( )

Definition at line 97 of file SCR_VONController.c.

◆ Init()

protected void Init ( IEntity owner )

Initialize component, done once per controller.

Definition at line 756 of file SCR_VONController.c.

◆ InitEncryptionKey()

protected void InitEncryptionKey ( )

Definition at line 743 of file SCR_VONController.c.

◆ IsLRRAvailable()

bool IsLRRAvailable ( )

Long range raido entry is available.

Definition at line 180 of file SCR_VONController.c.

◆ IsUsingLRR()

bool IsUsingLRR ( )

Using long range radio.

Definition at line 170 of file SCR_VONController.c.

◆ IsVONDisabled()

bool IsVONDisabled ( )

Is VON disabled.

Definition at line 118 of file SCR_VONController.c.

◆ OnDestroyed()

protected void OnDestroyed	(	Instigator	killer,
		IEntity	killerEntity
	)

SCR_PlayerController Event Used to deactivate VON for dead players

Definition at line 658 of file SCR_VONController.c.

◆ OnEntriesChanged()

void OnEntriesChanged	(	SCR_VONEntry	entry,
		bool	state
	)

◆ OnInputDeviceIsGamepad()

protected void OnInputDeviceIsGamepad ( bool isGamepad )

Game Event.

Definition at line 683 of file SCR_VONController.c.

◆ OnPauseMenuClosed()

protected void OnPauseMenuClosed ( )

PauseMenuUI Event.

Definition at line 704 of file SCR_VONController.c.

◆ OnPauseMenuOpened()

protected void OnPauseMenuOpened ( )

PauseMenuUI Event.

Definition at line 696 of file SCR_VONController.c.

◆ OnPlayerDeleted()

protected void OnPlayerDeleted	(	int	playerId,
		IEntity	player
	)

SCR_BaseGameMode event Used to unregister VON for deleted players

Definition at line 667 of file SCR_VONController.c.

◆ OnVONActiveToggled()

enum EVONTransmitType OnVONActiveToggled	(	bool	isToggledDirect,
		bool	isToggledChannel
	)

SCR_VONController event -> Toggle microphone indication.

Definition at line 503 of file SCR_VonDisplay.c.

◆ OnVONChannel()

protected void OnVONChannel	(	float	value,
		EActionTrigger	reason
	)

VON channel speech listener callback.

Definition at line 290 of file SCR_VONController.c.

◆ OnVONDirect()

protected void OnVONDirect	(	float	value,
		EActionTrigger	reason
	)

VON direct speech listener callback.

Definition at line 280 of file SCR_VONController.c.

◆ OnVONGamepad()

protected void OnVONGamepad	(	float	value,
		EActionTrigger	reason
	)

VON channel speech listener callback.

Definition at line 310 of file SCR_VONController.c.

◆ OnVONLongRange()

protected void OnVONLongRange	(	float	value,
		EActionTrigger	reason
	)

VON channel speech listener callback for long range radios.

Definition at line 300 of file SCR_VONController.c.

◆ OnVONLongRangeGamepadToggle()

protected void OnVONLongRangeGamepadToggle	(	float	value,
		EActionTrigger	reason
	)

Definition at line 345 of file SCR_VONController.c.

◆ OnVONSwitch()

protected void OnVONSwitch	(	float	value,
		EActionTrigger	reason
	)

VON switch between direct/channel mode.

Definition at line 410 of file SCR_VONController.c.

◆ OnVONToggle()

protected void OnVONToggle	(	float	value,
		EActionTrigger	reason
	)

VON toggle val 0 = off / 1 = direct / 2 = channel.

Definition at line 355 of file SCR_VONController.c.

◆ OnVONToggleGamepad()

protected void OnVONToggleGamepad	(	float	value,
		EActionTrigger	reason
	)

VON toggle controller.

Definition at line 400 of file SCR_VONController.c.

◆ RemoveEntry()

void RemoveEntry ( SCR_VONEntry entry )

Remove existing VON entry. Sets m_ActiveEntry to null, when removing active entry

Parameters

entry is subject entry

Definition at line 240 of file SCR_VONController.c.

◆ SetActiveTransmit()

protected void SetActiveTransmit ( notnull SCR_VONEntry entry )

Set transmission method depending on entry type when starting VON transmit.

Definition at line 575 of file SCR_VONController.c.

◆ SetDisplay()

void SetDisplay ( SCR_VonDisplay display )

Definition at line 85 of file SCR_VONController.c.

◆ SetEntryActive()

void SetEntryActive	(	SCR_VONEntry	entry,
		bool	setFromMenu = `false`
	)

Set entry as active for outgoing transmission

Parameters

entry	is subject entry
setFromMenu	determines whether this was performed by menu selection

Definition at line 189 of file SCR_VONController.c.

◆ SetGamepadLRRMode()

protected void SetGamepadLRRMode	(	bool	state,
		bool	isSwitch = `false`
	)

Sets long rang radio mode for gamepad input scheme.

Definition at line 270 of file SCR_VONController.c.

◆ SetVONComponent()

void SetVONComponent ( SCR_VoNComponent VONComp )

Set component for transmit of VON

Parameters

VONComp is the subject

Definition at line 133 of file SCR_VONController.c.

◆ SetVONDisabled()

bool SetVONDisabled ( bool state )

Disables ability to transmit and related VON UI

Parameters

state is the target state

Returns: true if this call changed the state to target, false if the state was target state already

Definition at line 106 of file SCR_VONController.c.

◆ TimeoutVON()

protected void TimeoutVON ( )

VON hold timeout, stops active von transmission in case of specific condition which would prevent for it to end normally.

Definition at line 595 of file SCR_VONController.c.

◆ Update()

void Update ( float timeSlice )

Parameters

[in] timeSlice

Definition at line 918 of file SCR_VONController.c.

◆ UpdateDebug()

protected void UpdateDebug ( )

Debug.

Definition at line 850 of file SCR_VONController.c.

◆ UpdateSystemState()

protected void UpdateSystemState ( )

Definition at line 887 of file SCR_VONController.c.

◆ VONChannel()

protected void VONChannel ( bool activate )

Definition at line 446 of file SCR_VONController.c.

◆ VONDirect()

protected void VONDirect ( bool activate )

Definition at line 426 of file SCR_VONController.c.

◆ VONLongRange()

protected void VONLongRange ( bool activate )

Definition at line 470 of file SCR_VONController.c.

Variable Documentation

◆ CHANNEL

CHANNEL

Definition at line 4 of file SCR_VONController.c.

◆ DIRECT

@ DIRECT

Definition at line 3 of file SCR_VONController.c.

◆ LONG_RANGE

LONG_RANGE

Definition at line 6 of file SCR_VONController.c.

◆ m_ActiveEntry

protected SCR_VONEntry m_ActiveEntry

Definition at line 55 of file SCR_VONController.c.

◆ m_aEntries

protected ref array<ref SCR_VONEntry> m_aEntries = {}

Definition at line 59 of file SCR_VONController.c.

◆ m_bIsActive

protected bool m_bIsActive

Definition at line 41 of file SCR_VONController.c.

◆ m_bIsActiveModeDirect

protected bool m_bIsActiveModeDirect

Definition at line 45 of file SCR_VONController.c.

◆ m_bIsActiveModeLong

protected bool m_bIsActiveModeLong

Definition at line 46 of file SCR_VONController.c.

◆ m_bIsDisabled

protected bool m_bIsDisabled

Definition at line 38 of file SCR_VONController.c.

◆ m_bIsPauseDisabled

protected bool m_bIsPauseDisabled

Definition at line 39 of file SCR_VONController.c.

◆ m_bIsToggledChannel

protected bool m_bIsToggledChannel

Definition at line 43 of file SCR_VONController.c.

◆ m_bIsToggledDirect

protected bool m_bIsToggledDirect

Definition at line 42 of file SCR_VONController.c.

◆ m_bIsUnconscious

protected bool m_bIsUnconscious

Definition at line 40 of file SCR_VONController.c.

◆ m_bIsUsingGamepad

protected bool m_bIsUsingGamepad

Definition at line 44 of file SCR_VONController.c.

◆ m_DirectSpeechEntry

protected ref SCR_VONEntry m_DirectSpeechEntry

Definition at line 58 of file SCR_VONController.c.

◆ m_eVONType

protected EVONTransmitType m_eVONType

Definition at line 50 of file SCR_VONController.c.

◆ m_fToggleOffDelay

protected float m_fToggleOffDelay

Definition at line 47 of file SCR_VONController.c.

◆ m_InputManager

protected InputManager m_InputManager

Definition at line 51 of file SCR_VONController.c.

◆ m_LongRangeEntry

protected SCR_VONEntry m_LongRangeEntry

Definition at line 56 of file SCR_VONController.c.

◆ m_OnEntriesActiveChanged

protected ref ScriptInvokerBase<OnEntriesChanged> m_OnEntriesActiveChanged = new ScriptInvokerBase<OnEntriesChanged>()

Definition at line 63 of file SCR_VONController.c.

◆ m_OnEntriesChanged

protected ref ScriptInvokerBase<OnEntriesChanged> m_OnEntriesChanged = new ScriptInvokerBase<OnEntriesChanged>()

Definition at line 62 of file SCR_VONController.c.

◆ m_OnVONActiveToggled

protected ref ScriptInvokerBase<OnVONActiveToggled> m_OnVONActiveToggled = new ScriptInvokerBase<OnVONActiveToggled>()

Definition at line 64 of file SCR_VONController.c.

◆ m_sActiveHoldAction

protected string m_sActiveHoldAction

Definition at line 48 of file SCR_VONController.c.

◆ m_SavedEntry

protected SCR_VONEntry m_SavedEntry

Definition at line 57 of file SCR_VONController.c.

◆ m_sLocalEncryptionKey

protected string m_sLocalEncryptionKey

Definition at line 49 of file SCR_VONController.c.

◆ m_VONComp

protected SCR_VoNComponent m_VONComp

Definition at line 53 of file SCR_VONController.c.

◆ m_VONDisplay

protected SCR_VonDisplay m_VONDisplay

Definition at line 54 of file SCR_VONController.c.

◆ m_VONMenu

protected ref SCR_VONMenu m_VONMenu

Definition at line 30 of file SCR_VONController.c.

◆ NONE

@ NONE

Definition at line 2 of file SCR_VONController.c.

◆ TOGGLE_OFF_DELAY

const protected float TOGGLE_OFF_DELAY = 0.5

Definition at line 35 of file SCR_VONController.c.

◆ VON_CHANNEL_HOLD

const protected string VON_CHANNEL_HOLD = "VONChannel"

Definition at line 33 of file SCR_VONController.c.

◆ VON_DIRECT_HOLD

const protected string VON_DIRECT_HOLD = "VONDirect"

Definition at line 32 of file SCR_VONController.c.

◆ VON_LONG_RANGE_HOLD

const protected string VON_LONG_RANGE_HOLD = "VONLongRange"

Definition at line 34 of file SCR_VONController.c.

◆ VON_MENU_OPENING_CONTEXT

SCR_VONControllerClass VON_MENU_OPENING_CONTEXT = "VONMenuOpeningContext"

Scripted VON input and control, attached to SCR_PlayerController.

Data Structures

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ OnEntriesChanged

◆ OnVONActiveToggled

Enumeration Type Documentation

◆ EVONTransmitType

Function Documentation

◆ ActivateVON()

◆ AddEntry()

◆ AssignVONComponent()

◆ Cleanup()

◆ ConnectToHandleUpdateVONControllersSystem()

◆ DeactivateVON()

◆ DisconnectFromHandleUpdateVONControllersSystem()

◆ GetActiveEntry()

◆ GetDisplay()

◆ GetEntryByTransmitType()

◆ GetOnEntriesActiveChangedInvoker()

◆ GetOnEntriesChangedInvoker()

◆ GetOnVONActiveToggledInvoker()

◆ GetVONEntries()

◆ GetVONEntryCount()

◆ GetVONMenu()

◆ Init()

◆ InitEncryptionKey()

◆ IsLRRAvailable()

◆ IsUsingLRR()

◆ IsVONDisabled()

◆ OnDestroyed()

◆ OnEntriesChanged()

◆ OnInputDeviceIsGamepad()

◆ OnPauseMenuClosed()

◆ OnPauseMenuOpened()

◆ OnPlayerDeleted()

◆ OnVONActiveToggled()

◆ OnVONChannel()

◆ OnVONDirect()

◆ OnVONGamepad()

◆ OnVONLongRange()

◆ OnVONLongRangeGamepadToggle()

◆ OnVONSwitch()

◆ OnVONToggle()

◆ OnVONToggleGamepad()

◆ RemoveEntry()

◆ SetActiveTransmit()

◆ SetDisplay()

◆ SetEntryActive()

◆ SetGamepadLRRMode()

◆ SetVONComponent()

◆ SetVONDisabled()

◆ TimeoutVON()

◆ Update()

◆ UpdateDebug()

◆ UpdateSystemState()

◆ VONChannel()

◆ VONDirect()

◆ VONLongRange()

Variable Documentation

◆ CHANNEL

◆ DIRECT

◆ LONG_RANGE

◆ m_ActiveEntry

◆ m_aEntries

◆ m_bIsActive

◆ m_bIsActiveModeDirect

◆ m_bIsActiveModeLong

◆ m_bIsDisabled

◆ m_bIsPauseDisabled

◆ m_bIsToggledChannel

◆ m_bIsToggledDirect

◆ m_bIsUnconscious

◆ m_bIsUsingGamepad

◆ m_DirectSpeechEntry

◆ m_eVONType

◆ m_fToggleOffDelay

◆ m_InputManager