All pages
Powered by GitBook
1 of 1

Loading...

SVoiceZone

Index

Functions Index

Function Name

Properties Index

Property Name

Functions

SetOverrideVoice

void SetOverrideVoice (bool enabled)

Set voice to override the original voice.

Parameter
Type
Description

ClearOverrideVoice

void ClearOverrideVoice ()

Clear the overriding voice.

SetOverrideVideo

void SetOverrideVideo (bool enabled)

Function Description

Parameter
Type
Description

ClearOverrideVideo

void ClearOverrideVideo ()

Function Description

AddAuthVoiceUser

void AddAuthVoiceUser (uint userID)

Add a user to AuthVoiceUser by his ID.

Parameter
Type
Description

RemoveAuthVoiceUser

void RemoveAuthVoiceUser (uint userID)

Remove a user from AuthVoiceUser by his ID.

Parameter
Type
Description

AddAuthVideoUser

void AddAuthVideoUser (uint userID)

Function Description

Parameter
Type
Description

RemoveAuthVideoUser

void RemoveAuthVideoUser (uint userID)

Remove a user from AuthVoiceUser by his ID.

Parameter
Type
Description

Properties

Enabled

bool Enabled get set

Whether the Voice Zone component is Enabled

AllowVoice

bool AllowVoice get set

Whether allows voice.

AllowVideo

bool AllowVideo get set

Whether allows video.

ConnectVoiceService

bool ConnectVoiceService get set

Property Description

ConnectVideoService

bool ConnectVideoService get set

Property Description

Priority

int Priority get

The priority of the voice zone

AreaName

string AreaName get

The name of area.

Spatialized

bool Spatialized get

Whether the voice zone is spatialized.

SpatialDropoff

bool SpatialDropoff get

Whether the voice zone is spatialized drop off.

SpatialStereo

bool SpatialStereo get

Whether the voice zone is spatial stereo.

SpatialDistance

float SpatialDistance get

The spatial distance of the voice zone.

Global

bool Global get

Whether the voice zone is global.

AuthVideoUsers

uint[] AuthVideoUsers get

Return an array of auth video user.

AuthVoiceUsers

uint[] AuthVoiceUsers get

Property Description

GameObject

GameObject get

Property Description

float get

bool get

uint[] get

uint[] get

SGameObject get

void SetOverrideVoice (bool enabled)

void ClearOverrideVoice ()

void SetOverrideVideo (bool enabled)

void ClearOverrideVideo ()

void AddAuthVoiceUser (uint userID)

void RemoveAuthVoiceUser (uint userID)

void AddAuthVideoUser (uint userID)

void RemoveAuthVideoUser (uint userID)

bool Enabled get set

bool AllowVoice get set

bool AllowVideo get set

bool ConnectVoiceService get set

bool ConnectVideoService get set

int Priority get

string AreaName get

bool Spatialized get

bool SpatialDropoff get

SGameObject

bool get

Space.Host.ExecutingObject.VoiceZone.SetOverrideVoice(true)
Space.Host.ExecutingObject.VoiceZone.ClearOverrideVoice()
Space.Host.ExecutingObject.VoiceZone.SetOverrideVideo(true)
Space.Host.ExecutingObject.VoiceZone.SetOverrideVideo(true)
Space.Host.ExecutingObject.VoiceZone.AddAuthVoiceUser(000000000)
lSpace.Host.ExecutingObject.VoiceZone.RemoveAuthVoiceUser(000000000)
Space.Host.ExecutingObject.VoiceZone.AddAuthVideoUser(000000000)
Space.Host.ExecutingObject.VoiceZone.RemoveAuthVideoUser(000000000)
Space.Host.ExecutingObject.VoiceZone.Enabled = true
--clicking this object will Enable/Disable it's Voice Zone component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.VoiceZone

OnClick = function()
component.Enabled =  not component.Enabled
end

thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)
Space.Host.ExecutingObject.VoiceZone.AllowVoice = true
Space.Host.ExecutingObject.VoiceZone.AllowVideo = true
Space.Host.ExecutingObject.VoiceZone.ConnectVoiceService = true
Space.Host.ExecutingObject.VoiceZone.ConnectVideoService = true
priority = Space.Host.ExecutingObject.VoiceZone.Priority
priority = Space.Host.ExecutingObject.VoiceZone.AreaName
isSpatialized = Space.Host.ExecutingObject.VoiceZone.Spatialized
spatialDropoff = Space.Host.ExecutingObject.VoiceZone.SpatialDropoff
spatialStereo = Space.Host.ExecutingObject.VoiceZone.SpatialStereo
floatDistance = Space.Host.ExecutingObject.VoiceZone.SpatialDistance
isGlobal = Space.Host.ExecutingObject.VoiceZone.Global
tableAuthVideoUsers = Space.Host.ExecutingObject.VoiceZone.AuthVideoUsers
tableAuthVideoUsers = Space.Host.ExecutingObject.VoiceZone.AuthVoiceUsers
theGameObject = Space.Host.ExecutingObject.VoiceZone.GameObject
SpatialStereo
SpatialDistance
Global
AuthVideoUsers
AuthVoiceUsers
GameObject