SCR_VoNComponent Interface Reference

Inheritance diagram for SCR_VoNComponent:

Public Member Functions
SCR_VonDisplay	GetDisplay ()
	Get Display Info script.
bool	IsTransmiting ()
	Simple getter for when transmission was recently active, we assume that player's avatar should not produce various sounds while he's talking.
bool	IsTransmitingRadio ()
	Radio transmission was recently active.
override bool	IsEntityActiveEditor (IEntity entity)
	returns true if the entity is a SCR_EditorManagerEntity that is opened.
bool	IsLocalActiveEditor ()
Public Member Functions inherited from VoNComponent
proto external bool	SetCapture (bool isCapturing)
	Request to starts/stop audio capturing.
proto external void	SetCommMethod (ECommMethod type)
	Sets communication method used.
proto external ECommMethod	GetCommMethod ()
proto external void	SetTransmitRadio (BaseTransceiver transceiver)
	Sets the transceiver used for VoN transmission.
proto external BaseTransceiver	GetTransmitRadio ()
proto external void	SoundEventPriority (string eventname, array< float > values, int priority, bool ignoreQueue=false)
	Transfer AI sound message through VoN.
proto external void	ConnectEditorToVoNSystem (int playerId)
	Connects this VoNComponent to the VoNSystem and tells this VoNComponent that is is used by an editor.
proto external void	DisconnectEditorFromVoNSystem ()
	Disconnects this VoNComponent from the VoNSystem.
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Static Public Member Functions
static ScriptInvokerInt	GetOnVoNUsed ()

Public Attributes
ref ScriptInvoker	m_OnReceivedVON = new ScriptInvoker()
ref ScriptInvoker	m_OnCaptureVON = new ScriptInvoker()

Protected Member Functions
override void	OnCapture (BaseTransceiver transmitter)
	Event polled each frame while component is recording audio.
override void	OnReceive (int playerId, bool isSenderEditor, BaseTransceiver receiver, int frequency, float quality)
	Event invoked when component receives audio data for playback.
override void	OnVoNUsed (int senderId)
	Event invoked on the server, each time VoN is used.
override IEntity	GetEditorEntity (int playerId)
	returns the SCR_EditorManagerEntity for a given player id if it exists.
override vector	GetEditorWorldLocation (int playerId)
	returns the position of the camera used by the editor for a given player id, if it exists.

Static Protected Attributes
static ref ScriptInvokerInt	m_OnVoNUsed

Member Function Documentation

GetDisplay()

SCR_VonDisplay SCR_VoNComponent.GetDisplay

(

)

Get Display Info script.

Returns

SCR_VonDisplay reference

GetEditorEntity()

override IEntity SCR_VoNComponent.GetEditorEntity ( int playerId )

protected

returns the SCR_EditorManagerEntity for a given player id if it exists.

Implements VoNComponent.

GetEditorWorldLocation()

override vector SCR_VoNComponent.GetEditorWorldLocation ( int playerId )

protected

returns the position of the camera used by the editor for a given player id, if it exists.

Implements VoNComponent.

GetOnVoNUsed()

static ScriptInvokerInt SCR_VoNComponent.GetOnVoNUsed ( )

static

IsEntityActiveEditor()

override bool SCR_VoNComponent.IsEntityActiveEditor

(

IEntity

entity

)

returns true if the entity is a SCR_EditorManagerEntity that is opened.

Implements VoNComponent.

IsLocalActiveEditor()

bool SCR_VoNComponent.IsLocalActiveEditor

(

)

IsTransmiting()

bool SCR_VoNComponent.IsTransmiting

(

)

Simple getter for when transmission was recently active, we assume that player's avatar should not produce various sounds while he's talking.

Returns

true if recently active

IsTransmitingRadio()

bool SCR_VoNComponent.IsTransmitingRadio

(

)

Radio transmission was recently active.

Returns

true if recently active

OnCapture()

override void SCR_VoNComponent.OnCapture ( BaseTransceiver transmitter )

protected

Event polled each frame while component is recording audio.

Parameters

transmitter

Transceiver used. Null if only direct speech.

Implements VoNComponent.

OnReceive()

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

protected

Event invoked when component receives audio data for playback.

Parameters

playerId	Senders PlayerId
isSenderEditor	true if sender is active editor.
receiver	Receiving transceiver
frequency	Frequency in kHz, on which the transmission came from. Can be different from the frequency which transceiver have set. This is very questionable and could be changed in future.
quality	Value in range <0,1> describing quality of the transmission

Implements VoNComponent.

OnVoNUsed()

override void SCR_VoNComponent.OnVoNUsed ( int senderId )

protected

Event invoked on the server, each time VoN is used.

Implements VoNComponent.

Member Data Documentation

m_OnCaptureVON

ref ScriptInvoker SCR_VoNComponent.m_OnCaptureVON = new ScriptInvoker()

m_OnReceivedVON

ref ScriptInvoker SCR_VoNComponent.m_OnReceivedVON = new ScriptInvoker()

m_OnVoNUsed

ref ScriptInvokerInt SCR_VoNComponent.m_OnVoNUsed

staticprotected

---

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

• GameCode/Network/SCR_VoNComponent.c