SVoiceZone

Index

Functions Index

Function Name
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)

Properties Index

Property Name
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
bool SpatialStereo get
float SpatialDistance get
bool Global get
uint[] AuthVideoUsers get
uint[] AuthVoiceUsers get
SGameObject GameObject get

Functions

SetOverrideVoice

void SetOverrideVoice (bool enabled)

Set voice to override the original voice.

Parameter	Type	Description

Lua

Space.Host.ExecutingObject.VoiceZone.SetOverrideVoice(true)

ClearOverrideVoice

void ClearOverrideVoice ()

Clear the overriding voice.

Lua

Space.Host.ExecutingObject.VoiceZone.ClearOverrideVoice()

SetOverrideVideo

void SetOverrideVideo (bool enabled)

Function Description

Parameter	Type	Description

Lua

Space.Host.ExecutingObject.VoiceZone.SetOverrideVideo(true)

ClearOverrideVideo

void ClearOverrideVideo ()

Function Description

Lua

Space.Host.ExecutingObject.VoiceZone.SetOverrideVideo(true)

AddAuthVoiceUser

void AddAuthVoiceUser (uint userID)

Add a user to AuthVoiceUser by his ID.

Parameter	Type	Description

Lua

Space.Host.ExecutingObject.VoiceZone.AddAuthVoiceUser(000000000)

RemoveAuthVoiceUser

void RemoveAuthVoiceUser (uint userID)

Remove a user from AuthVoiceUser by his ID.

Parameter	Type	Description

Lua

lSpace.Host.ExecutingObject.VoiceZone.RemoveAuthVoiceUser(000000000)

AddAuthVideoUser

void AddAuthVideoUser (uint userID)

Function Description

Parameter	Type	Description

Lua

Space.Host.ExecutingObject.VoiceZone.AddAuthVideoUser(000000000)

RemoveAuthVideoUser

void RemoveAuthVideoUser (uint userID)

Remove a user from AuthVoiceUser by his ID.

Parameter	Type	Description

Lua

Space.Host.ExecutingObject.VoiceZone.RemoveAuthVideoUser(000000000)

Properties

Enabled

bool Enabled get set

Whether the Voice Zone component is Enabled

Lua

Space.Host.ExecutingObject.VoiceZone.Enabled = true

Lua

--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)

AllowVoice

bool AllowVoice get set

Whether allows voice.

Lua

Space.Host.ExecutingObject.VoiceZone.AllowVoice = true

AllowVideo

bool AllowVideo get set

Whether allows video.

Lua

Space.Host.ExecutingObject.VoiceZone.AllowVideo = true

ConnectVoiceService

bool ConnectVoiceService get set

Property Description

Lua

Space.Host.ExecutingObject.VoiceZone.ConnectVoiceService = true

ConnectVideoService

bool ConnectVideoService get set

Property Description

Lua

Space.Host.ExecutingObject.VoiceZone.ConnectVideoService = true

Priority

int Priority get

The priority of the voice zone

Lua

priority = Space.Host.ExecutingObject.VoiceZone.Priority

AreaName

string AreaName get

The name of area.

Lua

priority = Space.Host.ExecutingObject.VoiceZone.AreaName

Spatialized

bool Spatialized get

Whether the voice zone is spatialized.

Lua

isSpatialized = Space.Host.ExecutingObject.VoiceZone.Spatialized

SpatialDropoff

bool SpatialDropoff get

Whether the voice zone is spatialized drop off.

Lua

spatialDropoff = Space.Host.ExecutingObject.VoiceZone.SpatialDropoff

SpatialStereo

bool SpatialStereo get

Whether the voice zone is spatial stereo.

Lua

spatialStereo = Space.Host.ExecutingObject.VoiceZone.SpatialStereo

SpatialDistance

float SpatialDistance get

The spatial distance of the voice zone.

Lua

floatDistance = Space.Host.ExecutingObject.VoiceZone.SpatialDistance

Global

bool Global get

Whether the voice zone is global.

Lua

isGlobal = Space.Host.ExecutingObject.VoiceZone.Global

AuthVideoUsers

uint[] AuthVideoUsers get

Return an array of auth video user.

Lua

tableAuthVideoUsers = Space.Host.ExecutingObject.VoiceZone.AuthVideoUsers

AuthVoiceUsers

uint[] AuthVoiceUsers get

Property Description

Lua

tableAuthVideoUsers = Space.Host.ExecutingObject.VoiceZone.AuthVoiceUsers

GameObject

SGameObject GameObject get

Property Description

Lua

theGameObject = Space.Host.ExecutingObject.VoiceZone.GameObject