Scripted VON input and control, attached to SCR_PlayerController. More...

Inheritance diagram for SCR_VONController:

Public Member Functions
ScriptInvokerBase< OnEntriesChanged >	GetOnEntriesChangedInvoker ()

ScriptInvokerBase< OnEntriesChanged >	GetOnEntriesActiveChangedInvoker ()

ScriptInvokerBase< OnVONActiveToggled >	GetOnVONActiveToggledInvoker ()

void	SetDisplay (SCR_VonDisplay display)

SCR_VonDisplay	GetDisplay ()

SCR_VONMenu	GetVONMenu ()

bool	SetVONDisabled (bool state)
	Disables ability to transmit and related VON UI.

bool	IsVONDisabled ()
	Is VON disabled.

SCR_VoNComponent	GetVONComponent ()
	Get active VON component for transmit.

void	SetVONComponent (SCR_VoNComponent VONComp)
	Set component for transmit of VON.

int	GetVONEntries (inout array< ref SCR_VONEntry > entries)
	Get current entries.

int	GetVONEntryCount ()
	Get number of entries.

SCR_VONEntry	GetActiveEntry ()
	Get active entry for outgoing transmission.

bool	IsUsingLRR ()
	Using long range radio.

bool	IsLRRAvailable ()
	Long range raido entry is available.

void	SetEntryActive (SCR_VONEntry entry, bool setFromMenu=false)
	Set entry as active for outgoing transmission.

void	AddEntry (SCR_VONEntry entry)
	Add new VON entry Set as active entry if m_ActiveEntry is null.

void	RemoveEntry (SCR_VONEntry entry)
	Remove existing VON entry.

EVONTransmitType	SelectFirstUnmutedEntry ()
	Finds first unmuted entry and sets it as the active entry.

void	SetActiveChannel (int channelId)
	Executed on server, sets the active channel of client's VON Controller.

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

void	Update (float timeSlice)

override void	OnDelete (IEntity owner)

SCR_VONAutoTune	GetAutoTune ()

Static Public Member Functions
static void	UpdateUnconsciousVONPermitted ()

Public Attributes
bool	m_bIsEditorRadioAdded

Protected Member Functions
void	SetVONProximity (bool activate)

void	SetVONProximityToggle (bool activate)

void	SetVONBroadcast (bool activate, EVONTransmitType transmitType=EVONTransmitType.CHANNEL)

void	SetVONLongRange (bool longRange, bool restorePrevious=true)

void	ActionVONProximity (float value, EActionTrigger reason=EActionTrigger.UP)

void	ActionVONProximityToggle (float value, EActionTrigger reason=EActionTrigger.UP)

void	ActionVONBroadcast (float value, EActionTrigger reason=EActionTrigger.UP)

void	ActionVONTransceiverCycle (float value, EActionTrigger reason=EActionTrigger.UP)

void	TransceiverCycle ()

void	ActionVONLongRangeToggle (float value, EActionTrigger reason=EActionTrigger.UP)

void	ActivateVON (EVONTransmitType transmitType)
	VON activation.

bool	ActivateVON (notnull SCR_VONEntry entry, EVONTransmitType transmitType=EVONTransmitType.NONE)
	VON activation.

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

SCR_VONEntry	GetEntryByTransmitType (EVONTransmitType type)

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

void	RpcAsk_SetActiveChannel (int channelId)

void	ResetVON ()

void	OnControlledEntityChanged (IEntity from, IEntity to)
	SCR_PlayerController Event Used to reinit VON when new entity is controlled.

void	OnPlayerDeleted (int playerId, IEntity player)
	SCR_BaseGameMode event Used to unregister VON for deleted players.

void	OnPauseMenuOpened ()
	PauseMenuUI Event.

void	OnPauseMenuClosed ()
	PauseMenuUI Event.

void	OnLifeStateChanged (ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState)

void	InitEncryptionKey ()

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

void	Cleanup ()
	Cleanup component.

void	UpdateDebug ()
	Debug.

override void	OnPostInit (IEntity owner)

override void	EOnDeactivate (IEntity owner)

void	UpdateSystemState ()

void	ConnectToHandleUpdateVONControllersSystem ()

void	DisconnectFromHandleUpdateVONControllersSystem ()

Protected Attributes
ref SCR_VONMenu	m_VONMenu

ref SCR_VONAutoTune	m_VONAutoTune

bool	m_bIsDisabled

bool	m_bIsPauseDisabled

bool	m_bIsUnconscious

ECharacterLifeState	m_eLifeState

bool	m_bIsActive

bool	m_bIsToggledDirect

bool	m_bIsLongRangeToggled

float	m_fToggleOffDelay

string	m_sActiveHoldAction

string	m_sLocalEncryptionKey

EVONTransmitType	m_eVONType

InputManager	m_InputManager

SCR_VoNComponent	m_VONComp

SCR_VonDisplay	m_VONDisplay

SCR_VONEntry	m_ActiveEntry

SCR_VONEntry	m_LongRangeEntry

SCR_VONEntry	m_SavedEntry

ref SCR_VONEntry	m_DirectSpeechEntry

ref array< ref SCR_VONEntry >	m_aEntries = {}

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

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

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

Static Protected Attributes
const string	VON_MENU_OPENING_CONTEXT = "VONMenuOpeningContext"

const string	VON_CONTEXT = "VONContext"

const string	ACTION_DIRECT = "VONDirect"

const string	ACTION_DIRECT_TOGGLE = "VONDirectToggle"

const string	ACTION_CHANNEL = "VONChannel"

const string	ACTION_TRANSCEIVER_CYCLE = "VONTransceiverCycle"

const string	ACTION_LONG_RANGE_TOGGLE = "VONLongRangeToggle"

const float	TOGGLE_OFF_DELAY = 0.5

static bool	s_bUnconsciousVONPermitted = true

static bool	s_bIsInit

Detailed Description

Scripted VON input and control, attached to SCR_PlayerController.

Member Function Documentation

◆ ActionVONBroadcast()

void SCR_VONController.ActionVONBroadcast	(	float	value,
		EActionTrigger	reason = EActionTrigger::UP )

protected

◆ ActionVONLongRangeToggle()

void SCR_VONController.ActionVONLongRangeToggle	(	float	value,
		EActionTrigger	reason = EActionTrigger::UP )

protected

◆ ActionVONProximity()

void SCR_VONController.ActionVONProximity	(	float	value,
		EActionTrigger	reason = EActionTrigger::UP )

protected

◆ ActionVONProximityToggle()

void SCR_VONController.ActionVONProximityToggle	(	float	value,
		EActionTrigger	reason = EActionTrigger::UP )

protected

◆ ActionVONTransceiverCycle()

void SCR_VONController.ActionVONTransceiverCycle	(	float	value,
		EActionTrigger	reason = EActionTrigger::UP )

protected

◆ ActivateVON() [1/2]

void SCR_VONController.ActivateVON ( EVONTransmitType transmitType )

protected

VON activation.

Parameters

[in] transmitType type of entry to be activated

◆ ActivateVON() [2/2]

bool SCR_VONController.ActivateVON	(	notnull SCR_VONEntry	entry,
		EVONTransmitType	transmitType = EVONTransmitType::NONE )

protected

VON activation.

Parameters

[in]	entry	which is being activated
[in]	transmitType	type of entry to be activated

Returns: true if activation was successful, false otherwise

◆ AddEntry()

void SCR_VONController.AddEntry ( SCR_VONEntry entry )

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

Parameters

entry is subject entry

◆ AssignVONComponent()

bool SCR_VONController.AssignVONComponent ( )

Assign VON comp by fetching it from controlled entity.

◆ Cleanup()

void SCR_VONController.Cleanup ( )

protected

Cleanup component.

◆ ConnectToHandleUpdateVONControllersSystem()

void SCR_VONController.ConnectToHandleUpdateVONControllersSystem ( )

protected

◆ DeactivateVON()

void SCR_VONController.DeactivateVON ( EVONTransmitType transmitType = EVONTransmitType::NONE )

protected

Current VON deactivation.

◆ DisconnectFromHandleUpdateVONControllersSystem()

void SCR_VONController.DisconnectFromHandleUpdateVONControllersSystem ( )

protected

◆ EOnDeactivate()

override void SCR_VONController.EOnDeactivate ( IEntity owner )

protected

◆ GetActiveEntry()

SCR_VONEntry SCR_VONController.GetActiveEntry ( )

Get active entry for outgoing transmission.

Returns: active entry

◆ GetAutoTune()

SCR_VONAutoTune SCR_VONController.GetAutoTune ( )

◆ GetDisplay()

SCR_VonDisplay SCR_VONController.GetDisplay ( )

◆ GetEntryByTransmitType()

SCR_VONEntry SCR_VONController.GetEntryByTransmitType ( EVONTransmitType type )

protected

◆ GetOnEntriesActiveChangedInvoker()

ScriptInvokerBase< OnEntriesChanged > SCR_VONController.GetOnEntriesActiveChangedInvoker ( )

◆ GetOnEntriesChangedInvoker()

ScriptInvokerBase< OnEntriesChanged > SCR_VONController.GetOnEntriesChangedInvoker ( )

◆ GetOnVONActiveToggledInvoker()

ScriptInvokerBase< OnVONActiveToggled > SCR_VONController.GetOnVONActiveToggledInvoker ( )

◆ GetVONComponent()

SCR_VoNComponent SCR_VONController.GetVONComponent ( )

Get active VON component for transmit.

◆ GetVONEntries()

int SCR_VONController.GetVONEntries ( inout array< ref SCR_VONEntry > entries )

Get current entries.

Returns: count of entries

◆ GetVONEntryCount()

int SCR_VONController.GetVONEntryCount ( )

Get number of entries.

◆ GetVONMenu()

SCR_VONMenu SCR_VONController.GetVONMenu ( )

◆ Init()

void SCR_VONController.Init ( IEntity owner )

protected

Initialize component, done once per controller.

◆ InitEncryptionKey()

void SCR_VONController.InitEncryptionKey ( )

protected

◆ IsLRRAvailable()

bool SCR_VONController.IsLRRAvailable ( )

Long range raido entry is available.

◆ IsUsingLRR()

bool SCR_VONController.IsUsingLRR ( )

Using long range radio.

◆ IsVONDisabled()

bool SCR_VONController.IsVONDisabled ( )

Is VON disabled.

◆ OnControlledEntityChanged()

void SCR_VONController.OnControlledEntityChanged	(	IEntity	from,
		IEntity	to )

protected

SCR_PlayerController Event Used to reinit VON when new entity is controlled.

◆ OnDelete()

override void SCR_VONController.OnDelete ( IEntity owner )

◆ OnLifeStateChanged()

void SCR_VONController.OnLifeStateChanged	(	ECharacterLifeState	previousLifeState,
		ECharacterLifeState	newLifeState )

protected

◆ OnPauseMenuClosed()

void SCR_VONController.OnPauseMenuClosed ( )

protected

PauseMenuUI Event.

◆ OnPauseMenuOpened()

void SCR_VONController.OnPauseMenuOpened ( )

protected

PauseMenuUI Event.

◆ OnPlayerDeleted()

void SCR_VONController.OnPlayerDeleted	(	int	playerId,
		IEntity	player )

protected

SCR_BaseGameMode event Used to unregister VON for deleted players.

◆ OnPostInit()

override void SCR_VONController.OnPostInit ( IEntity owner )

protected

◆ RemoveEntry()

void SCR_VONController.RemoveEntry ( SCR_VONEntry entry )

Remove existing VON entry.

Sets m_ActiveEntry to null, when removing active entry

Parameters

entry is subject entry

◆ ResetVON()

void SCR_VONController.ResetVON ( )

protected

◆ RpcAsk_SetActiveChannel()

void SCR_VONController.RpcAsk_SetActiveChannel ( int channelId )

protected

◆ SelectFirstUnmutedEntry()

EVONTransmitType SCR_VONController.SelectFirstUnmutedEntry ( )

Finds first unmuted entry and sets it as the active entry.

Returns: EVONTransmitType for selected entry. if no entry selected, return EVONTransmitType.NONE;

◆ SetActiveChannel()

void SCR_VONController.SetActiveChannel ( int channelId )

Executed on server, sets the active channel of client's VON Controller.

Parameters

[in] channelId

◆ SetActiveTransmit()

void SCR_VONController.SetActiveTransmit ( notnull SCR_VONEntry entry )

protected

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

◆ SetDisplay()

void SCR_VONController.SetDisplay ( SCR_VonDisplay display )

◆ SetEntryActive()

void SCR_VONController.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

◆ SetVONBroadcast()

void SCR_VONController.SetVONBroadcast	(	bool	activate,
		EVONTransmitType	transmitType = EVONTransmitType::CHANNEL )

protected

◆ SetVONComponent()

void SCR_VONController.SetVONComponent ( SCR_VoNComponent VONComp )

Set component for transmit of VON.

Parameters

VONComp is the subject

◆ SetVONDisabled()

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

◆ SetVONLongRange()

void SCR_VONController.SetVONLongRange	(	bool	longRange,
		bool	restorePrevious = true )

protected

◆ SetVONProximity()

void SCR_VONController.SetVONProximity ( bool activate )

protected

◆ SetVONProximityToggle()

void SCR_VONController.SetVONProximityToggle ( bool activate )

protected

◆ TransceiverCycle()

void SCR_VONController.TransceiverCycle ( )

protected

◆ Update()

void SCR_VONController.Update ( float timeSlice )

◆ UpdateDebug()

void SCR_VONController.UpdateDebug ( )

protected

Debug.

◆ UpdateSystemState()

void SCR_VONController.UpdateSystemState ( )

protected

◆ UpdateUnconsciousVONPermitted()

static void SCR_VONController.UpdateUnconsciousVONPermitted ( )

static

Member Data Documentation

◆ ACTION_CHANNEL

const string SCR_VONController.ACTION_CHANNEL = "VONChannel"

staticprotected

◆ ACTION_DIRECT

const string SCR_VONController.ACTION_DIRECT = "VONDirect"

staticprotected

◆ ACTION_DIRECT_TOGGLE

const string SCR_VONController.ACTION_DIRECT_TOGGLE = "VONDirectToggle"

staticprotected

◆ ACTION_LONG_RANGE_TOGGLE

const string SCR_VONController.ACTION_LONG_RANGE_TOGGLE = "VONLongRangeToggle"

staticprotected

◆ ACTION_TRANSCEIVER_CYCLE

const string SCR_VONController.ACTION_TRANSCEIVER_CYCLE = "VONTransceiverCycle"

staticprotected

◆ m_ActiveEntry

SCR_VONEntry SCR_VONController.m_ActiveEntry

protected

◆ m_aEntries

ref array<ref SCR_VONEntry> SCR_VONController.m_aEntries = {}

protected

◆ m_bIsActive

bool SCR_VONController.m_bIsActive

protected

◆ m_bIsDisabled

bool SCR_VONController.m_bIsDisabled

protected

◆ m_bIsEditorRadioAdded

bool SCR_VONController.m_bIsEditorRadioAdded

◆ m_bIsLongRangeToggled

bool SCR_VONController.m_bIsLongRangeToggled

protected

◆ m_bIsPauseDisabled

bool SCR_VONController.m_bIsPauseDisabled

protected

◆ m_bIsToggledDirect

bool SCR_VONController.m_bIsToggledDirect

protected

◆ m_bIsUnconscious

bool SCR_VONController.m_bIsUnconscious

protected

◆ m_DirectSpeechEntry

ref SCR_VONEntry SCR_VONController.m_DirectSpeechEntry

protected

◆ m_eLifeState

ECharacterLifeState SCR_VONController.m_eLifeState

protected

◆ m_eVONType

EVONTransmitType SCR_VONController.m_eVONType

protected

◆ m_fToggleOffDelay

float SCR_VONController.m_fToggleOffDelay

protected

◆ m_InputManager

InputManager SCR_VONController.m_InputManager

protected

◆ m_LongRangeEntry

SCR_VONEntry SCR_VONController.m_LongRangeEntry

protected

◆ m_OnEntriesActiveChanged

ref ScriptInvokerBase<OnEntriesChanged> SCR_VONController.m_OnEntriesActiveChanged = new ScriptInvokerBase<OnEntriesChanged>()

protected

◆ m_OnEntriesChanged

ref ScriptInvokerBase<OnEntriesChanged> SCR_VONController.m_OnEntriesChanged = new ScriptInvokerBase<OnEntriesChanged>()

protected

◆ m_OnVONActiveToggled

ref ScriptInvokerBase<OnVONActiveToggled> SCR_VONController.m_OnVONActiveToggled = new ScriptInvokerBase<OnVONActiveToggled>()

protected

◆ m_sActiveHoldAction

string SCR_VONController.m_sActiveHoldAction

protected

◆ m_SavedEntry

SCR_VONEntry SCR_VONController.m_SavedEntry

protected

◆ m_sLocalEncryptionKey

string SCR_VONController.m_sLocalEncryptionKey

protected

◆ m_VONAutoTune

ref SCR_VONAutoTune SCR_VONController.m_VONAutoTune

protected

◆ m_VONComp

SCR_VoNComponent SCR_VONController.m_VONComp

protected

◆ m_VONDisplay

SCR_VonDisplay SCR_VONController.m_VONDisplay

protected

◆ m_VONMenu

ref SCR_VONMenu SCR_VONController.m_VONMenu

protected

◆ s_bIsInit

bool SCR_VONController.s_bIsInit

staticprotected

◆ s_bUnconsciousVONPermitted

bool SCR_VONController.s_bUnconsciousVONPermitted = true

staticprotected

◆ TOGGLE_OFF_DELAY

const float SCR_VONController.TOGGLE_OFF_DELAY = 0.5

staticprotected

◆ VON_CONTEXT

const string SCR_VONController.VON_CONTEXT = "VONContext"

staticprotected

◆ VON_MENU_OPENING_CONTEXT

const string SCR_VONController.VON_MENU_OPENING_CONTEXT = "VONMenuOpeningContext"

staticprotected

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

Game/VON/SCR_VONController.c

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ ActionVONBroadcast()

◆ ActionVONLongRangeToggle()

◆ ActionVONProximity()

◆ ActionVONProximityToggle()

◆ ActionVONTransceiverCycle()

◆ ActivateVON() [1/2]

◆ ActivateVON() [2/2]

◆ AddEntry()

◆ AssignVONComponent()

◆ Cleanup()

◆ ConnectToHandleUpdateVONControllersSystem()

◆ DeactivateVON()

◆ DisconnectFromHandleUpdateVONControllersSystem()

◆ EOnDeactivate()

◆ GetActiveEntry()

◆ GetAutoTune()

◆ GetDisplay()

◆ GetEntryByTransmitType()

◆ GetOnEntriesActiveChangedInvoker()

◆ GetOnEntriesChangedInvoker()

◆ GetOnVONActiveToggledInvoker()

◆ GetVONComponent()

◆ GetVONEntries()

◆ GetVONEntryCount()

◆ GetVONMenu()

◆ Init()

◆ InitEncryptionKey()

◆ IsLRRAvailable()

◆ IsUsingLRR()

◆ IsVONDisabled()

◆ OnControlledEntityChanged()

◆ OnDelete()

◆ OnLifeStateChanged()

◆ OnPauseMenuClosed()

◆ OnPauseMenuOpened()

◆ OnPlayerDeleted()

◆ OnPostInit()

◆ RemoveEntry()

◆ ResetVON()

◆ RpcAsk_SetActiveChannel()

◆ SelectFirstUnmutedEntry()

◆ SetActiveChannel()

◆ SetActiveTransmit()

◆ SetDisplay()

◆ SetEntryActive()

◆ SetVONBroadcast()

◆ SetVONComponent()

◆ SetVONDisabled()

◆ SetVONLongRange()

◆ SetVONProximity()

◆ SetVONProximityToggle()

◆ TransceiverCycle()

◆ Update()

◆ UpdateDebug()

◆ UpdateSystemState()

◆ UpdateUnconsciousVONPermitted()

Member Data Documentation

◆ ACTION_CHANNEL

◆ ACTION_DIRECT

◆ ACTION_DIRECT_TOGGLE

◆ ACTION_LONG_RANGE_TOGGLE

◆ ACTION_TRANSCEIVER_CYCLE

◆ m_ActiveEntry

◆ m_aEntries

◆ m_bIsActive

◆ m_bIsDisabled

◆ m_bIsEditorRadioAdded

◆ m_bIsLongRangeToggled

◆ m_bIsPauseDisabled

◆ m_bIsToggledDirect

◆ m_bIsUnconscious

◆ m_DirectSpeechEntry