SCR_VONController.c File Reference

Go to the source code of this file.

Classes
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.
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.
SCR_VoNComponent	GetVONComponent ()
	Get active VON component for transmit.
void	SetVONComponent (SCR_VoNComponent VONComp)
int	GetVONEntries (inout array< ref SCR_VONEntry > entries)
int	GetVONEntryCount ()
	Get number of entries.
SCR_VONEntry	GetActiveEntry ()
bool	IsUsingLRR ()
	Using long range radio.
bool	IsLRRAvailable ()
	Long range raido entry is available.
void	SetEntryActive (SCR_VONEntry entry, bool setFromMenu=false)
void	AddEntry (SCR_VONEntry entry)
void	RemoveEntry (SCR_VONEntry entry)
EVONTransmitType	SelectFirstUnmutedEntry ()
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)
bool	ActivateVON (notnull SCR_VONEntry entry, EVONTransmitType transmitType=EVONTransmitType.NONE)
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	SetActiveChannel (int channelId)
void	RpcAsk_SetActiveChannel (int channelId)
void	ResetVON ()
void	OnControlledEntityChanged (IEntity from, IEntity to)
	Runs every time the controlled entity has been changed.
void	OnPlayerDeleted (int playerId, IEntity player)
void	OnPauseMenuOpened ()
	PauseMenuUI Event.
void	OnPauseMenuClosed ()
	PauseMenuUI Event.
bool	AssignVONComponent ()
	Assign VON comp by fetching it from controlled entity.
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.
void	OnPostInit (IEntity owner)
	Editable Mine.
void	EOnDeactivate (IEntity owner)
void	UpdateSystemState ()
void	ConnectToHandleUpdateVONControllersSystem ()
void	DisconnectFromHandleUpdateVONControllersSystem ()
void	Update (float timeSlice)
override void	OnDelete (IEntity owner)
SCR_VONAutoTune	GetAutoTune ()

Variables
	NONE
	DIRECT
	CHANNEL
	LONG_RANGE
SCR_VONControllerClass	VON_MENU_OPENING_CONTEXT = "VONMenuOpeningContext"
	Scripted VON input and control, attached to SCR_PlayerController.
ref SCR_VONMenu	m_VONMenu
ref SCR_VONAutoTune	m_VONAutoTune
bool	m_bIsEditorRadioAdded
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
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>()

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

ActionVONBroadcast()

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

protected

Definition at line 450 of file SCR_VONController.c.

ActionVONLongRangeToggle()

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

protected

Definition at line 516 of file SCR_VONController.c.

ActionVONProximity()

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

protected

Definition at line 420 of file SCR_VONController.c.

ActionVONProximityToggle()

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

protected

Definition at line 438 of file SCR_VONController.c.

ActionVONTransceiverCycle()

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

protected

Definition at line 472 of file SCR_VONController.c.

ActivateVON() [1/2]

void ActivateVON ( EVONTransmitType transmitType )

protected

VON activation

Parameters

[in]

transmitType

type of entry to be activated

Definition at line 524 of file SCR_VONController.c.

ActivateVON() [2/2]

bool 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

Definition at line 538 of file SCR_VONController.c.

AddEntry()

void AddEntry ( SCR_VONEntry entry )

protected

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

Parameters

entry

is subject entry

Definition at line 230 of file SCR_VONController.c.

AssignVONComponent()

bool AssignVONComponent ( )

protected

Assign VON comp by fetching it from controlled entity.

Definition at line 735 of file SCR_VONController.c.

Cleanup()

void Cleanup ( )

protected

Cleanup component.

Definition at line 854 of file SCR_VONController.c.

ConnectToHandleUpdateVONControllersSystem()

void ConnectToHandleUpdateVONControllersSystem ( )

protected

Definition at line 937 of file SCR_VONController.c.

DeactivateVON()

void DeactivateVON ( EVONTransmitType transmitType = EVONTransmitType.NONE )

protected

Current VON deactivation.

Definition at line 575 of file SCR_VONController.c.

DisconnectFromHandleUpdateVONControllersSystem()

void DisconnectFromHandleUpdateVONControllersSystem ( )

protected

Definition at line 948 of file SCR_VONController.c.

GetActiveEntry()

SCR_VONEntry GetActiveEntry ( )

protected

Get active entry for outgoing transmission

Returns

active entry

Definition at line 171 of file SCR_VONController.c.

GetAutoTune()

SCR_VONAutoTune GetAutoTune ( )

protected

Definition at line 1000 of file SCR_VONController.c.

GetDisplay()

SCR_VonDisplay GetDisplay ( )

protected

Definition at line 99 of file SCR_VONController.c.

GetEntryByTransmitType()

SCR_VONEntry GetEntryByTransmitType ( EVONTransmitType type )

protected

Definition at line 594 of file SCR_VONController.c.

GetOnEntriesActiveChangedInvoker()

ScriptInvokerBase< OnEntriesChanged > GetOnEntriesActiveChangedInvoker ( )

protected

Definition at line 81 of file SCR_VONController.c.

GetOnEntriesChangedInvoker()

ScriptInvokerBase< OnEntriesChanged > GetOnEntriesChangedInvoker ( )

protected

Definition at line 75 of file SCR_VONController.c.

GetOnVONActiveToggledInvoker()

ScriptInvokerBase< OnVONActiveToggled > GetOnVONActiveToggledInvoker ( )

protected

Definition at line 87 of file SCR_VONController.c.

GetVONEntries()

int GetVONEntries ( inout array< ref SCR_VONEntry > entries )

protected

Get current entries

Returns

count of entries

Definition at line 150 of file SCR_VONController.c.

GetVONEntryCount()

int GetVONEntryCount ( )

protected

Get number of entries.

Definition at line 163 of file SCR_VONController.c.

GetVONMenu()

SCR_VONMenu GetVONMenu ( )

protected

Definition at line 105 of file SCR_VONController.c.

Init()

void Init ( IEntity owner )

protected

Initialize component, done once per controller.

Definition at line 801 of file SCR_VONController.c.

InitEncryptionKey()

void InitEncryptionKey ( )

protected

Definition at line 788 of file SCR_VONController.c.

IsLRRAvailable()

bool IsLRRAvailable ( )

protected

Long range raido entry is available.

Definition at line 188 of file SCR_VONController.c.

IsUsingLRR()

bool IsUsingLRR ( )

protected

Using long range radio.

Definition at line 178 of file SCR_VONController.c.

IsVONDisabled()

bool IsVONDisabled ( )

protected

Is VON disabled.

Definition at line 126 of file SCR_VONController.c.

OnDelete()

override void OnDelete ( IEntity owner )

protected

Definition at line 987 of file SCR_VONController.c.

OnEntriesChanged()

void OnEntriesChanged	(	SCR_VONEntry	entry,
		bool	state )

OnLifeStateChanged()

void OnLifeStateChanged ( ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState )

protected

Definition at line 748 of file SCR_VONController.c.

OnPauseMenuClosed()

void OnPauseMenuClosed ( )

protected

PauseMenuUI Event.

Definition at line 725 of file SCR_VONController.c.

OnPauseMenuOpened()

void OnPauseMenuOpened ( )

protected

PauseMenuUI Event.

Definition at line 717 of file SCR_VONController.c.

OnPlayerDeleted()

void OnPlayerDeleted ( int playerId, IEntity player )

protected

SCR_BaseGameMode event Used to unregister VON for deleted players

Called after a player gets deleted.

Parameters

[in]	playerId	Player ID
[in]	player	Player entity

Definition at line 702 of file SCR_VONController.c.

OnVONActiveToggled()

enum EVONTransmitType OnVONActiveToggled	(	bool	isToggledDirect,
		bool	isToggledChannel )

SCR_VONController event -> Toggle microphone indication.

Definition at line 621 of file SCR_VonDisplay.c.

RemoveEntry()

void RemoveEntry ( SCR_VONEntry entry )

protected

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

Parameters

entry

is subject entry

Definition at line 248 of file SCR_VONController.c.

ResetVON()

void ResetVON ( )

protected

Definition at line 651 of file SCR_VONController.c.

RpcAsk_SetActiveChannel()

void RpcAsk_SetActiveChannel ( int channelId )

protected

Definition at line 641 of file SCR_VONController.c.

SelectFirstUnmutedEntry()

EVONTransmitType SelectFirstUnmutedEntry ( )

protected

Finds first unmuted entry and sets it as the active entry

Returns

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

Definition at line 276 of file SCR_VONController.c.

SetActiveChannel()

void SetActiveChannel ( int channelId )

protected

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

Parameters

[in]

channelId

Definition at line 634 of file SCR_VONController.c.

SetActiveTransmit()

void SetActiveTransmit ( notnull SCR_VONEntry entry )

protected

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

Definition at line 613 of file SCR_VONController.c.

SetDisplay()

void SetDisplay ( SCR_VonDisplay display )

protected

Definition at line 93 of file SCR_VONController.c.

SetEntryActive()

void SetEntryActive ( SCR_VONEntry entry, bool setFromMenu = false )

protected

Set entry as active for outgoing transmission

Parameters

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

Definition at line 197 of file SCR_VONController.c.

SetVONBroadcast()

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

protected

Definition at line 341 of file SCR_VONController.c.

SetVONComponent()

void SetVONComponent ( SCR_VoNComponent VONComp )

protected

Set component for transmit of VON

Parameters

VONComp

is the subject

Definition at line 141 of file SCR_VONController.c.

SetVONDisabled()

bool SetVONDisabled ( bool state )

protected

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 114 of file SCR_VONController.c.

SetVONLongRange()

void SetVONLongRange ( bool longRange, bool restorePrevious = true )

protected

Definition at line 368 of file SCR_VONController.c.

SetVONProximity()

void SetVONProximity ( bool activate )

protected

Definition at line 301 of file SCR_VONController.c.

SetVONProximityToggle()

void SetVONProximityToggle ( bool activate )

protected

Definition at line 319 of file SCR_VONController.c.

TransceiverCycle()

void TransceiverCycle ( )

protected

Definition at line 478 of file SCR_VONController.c.

Update()

void Update ( float timeSlice )

protected

Parameters

[in]

timeSlice

Definition at line 959 of file SCR_VONController.c.

UpdateDebug()

void UpdateDebug ( )

protected

Debug.

Definition at line 891 of file SCR_VONController.c.

UpdateSystemState()

void UpdateSystemState ( )

protected

Definition at line 928 of file SCR_VONController.c.

Variable Documentation

ACTION_CHANNEL

const string ACTION_CHANNEL = "VONChannel"

protected

Definition at line 40 of file SCR_VONController.c.

ACTION_DIRECT

const string ACTION_DIRECT = "VONDirect"

protected

Definition at line 38 of file SCR_VONController.c.

ACTION_DIRECT_TOGGLE

const string ACTION_DIRECT_TOGGLE = "VONDirectToggle"

protected

Definition at line 39 of file SCR_VONController.c.

ACTION_LONG_RANGE_TOGGLE

const string ACTION_LONG_RANGE_TOGGLE = "VONLongRangeToggle"

protected

Definition at line 42 of file SCR_VONController.c.

ACTION_TRANSCEIVER_CYCLE

const string ACTION_TRANSCEIVER_CYCLE = "VONTransceiverCycle"

protected

Definition at line 41 of file SCR_VONController.c.

CHANNEL

CHANNEL

Definition at line 2 of file SCR_VONController.c.

DIRECT

@ DIRECT

Definition at line 1 of file SCR_VONController.c.

LONG_RANGE

LONG_RANGE

Definition at line 3 of file SCR_VONController.c.

m_ActiveEntry

SCR_VONEntry m_ActiveEntry

protected

Definition at line 63 of file SCR_VONController.c.

m_aEntries

ref array<ref SCR_VONEntry> m_aEntries = {}

protected

Definition at line 67 of file SCR_VONController.c.

m_bIsActive

bool m_bIsActive

protected

Definition at line 52 of file SCR_VONController.c.

m_bIsDisabled

bool m_bIsDisabled

protected

Definition at line 48 of file SCR_VONController.c.

m_bIsEditorRadioAdded

bool m_bIsEditorRadioAdded

protected

Definition at line 35 of file SCR_VONController.c.

m_bIsLongRangeToggled

bool m_bIsLongRangeToggled

protected

Definition at line 54 of file SCR_VONController.c.

m_bIsPauseDisabled

bool m_bIsPauseDisabled

protected

Definition at line 49 of file SCR_VONController.c.

m_bIsToggledDirect

bool m_bIsToggledDirect

protected

Definition at line 53 of file SCR_VONController.c.

m_bIsUnconscious

bool m_bIsUnconscious

protected

Definition at line 50 of file SCR_VONController.c.

m_DirectSpeechEntry

ref SCR_VONEntry m_DirectSpeechEntry

protected

Definition at line 66 of file SCR_VONController.c.

m_eLifeState

ECharacterLifeState m_eLifeState

protected

Definition at line 51 of file SCR_VONController.c.

m_eVONType

EVONTransmitType m_eVONType

protected

Definition at line 58 of file SCR_VONController.c.

m_fToggleOffDelay

float m_fToggleOffDelay

protected

Definition at line 55 of file SCR_VONController.c.

m_InputManager

InputManager m_InputManager

protected

Definition at line 59 of file SCR_VONController.c.

m_LongRangeEntry

SCR_VONEntry m_LongRangeEntry

protected

Definition at line 64 of file SCR_VONController.c.

m_OnEntriesActiveChanged

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

protected

Definition at line 71 of file SCR_VONController.c.

m_OnEntriesChanged

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

protected

Definition at line 70 of file SCR_VONController.c.

m_OnVONActiveToggled

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

protected

Definition at line 72 of file SCR_VONController.c.

m_sActiveHoldAction

string m_sActiveHoldAction

protected

Definition at line 56 of file SCR_VONController.c.

m_SavedEntry

SCR_VONEntry m_SavedEntry

protected

Definition at line 65 of file SCR_VONController.c.

m_sLocalEncryptionKey

string m_sLocalEncryptionKey

protected

Definition at line 57 of file SCR_VONController.c.

m_VONAutoTune

ref SCR_VONAutoTune m_VONAutoTune

protected

Definition at line 33 of file SCR_VONController.c.

m_VONComp

SCR_VoNComponent m_VONComp

protected

Definition at line 61 of file SCR_VONController.c.

m_VONDisplay

SCR_VonDisplay m_VONDisplay

protected

Definition at line 62 of file SCR_VONController.c.

m_VONMenu

ref SCR_VONMenu m_VONMenu

protected

Definition at line 30 of file SCR_VONController.c.

NONE

@ NONE

Definition at line 0 of file SCR_VONController.c.

TOGGLE_OFF_DELAY

const float TOGGLE_OFF_DELAY = 0.5

protected

Definition at line 44 of file SCR_VONController.c.

VON_CONTEXT

const string VON_CONTEXT = "VONContext"

protected

Definition at line 37 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.