All pages
Powered by GitBook
1 of 1

Loading...

SChat

Index

Functions Index

Function Name

Functions

OnChat

void OnChat (Closure callback) void OnChat (Action< > trackInfoCallback)

Bind a function to the OnChat event. This function will be called every time a new chat message is received on the local channel.

Parameter
Type
Description

JoinChat

void JoinChat (string name)

Join a chat channel.

Parameter
Type
Description

GetXMPPName

string GetXMPPName (string name)

Get XMPP name.

Parameter
Type
Description

LeaveChat

void LeaveChat (string name)

Leave a chat channel.

Parameter
Type
Description

GetVoiceZone

SVoiceZone GetVoiceZone (string channel)

Get a reference to a voice zone component for the given channel.

Parameter
Type
Description

JoinVoice

void JoinVoice (string channel, int priority=5, int spatial=0)

Join a voice chat channel.

Parameter
Type
Description

JoinGridVoice

void JoinGridVoice (string channel, int priority=5, int spatial=0)

JoinGridVoice is the same as JoinVoice except with a grid wide parameter. (white-label only)

Parameter
Type
Description

LeaveVoice

void LeaveVoice (string channel)

Leave a voice chat channel

Parameter
Type
Description

void OnChat (Closure callback) void OnChat (Action< SChatMessage > trackInfoCallback)

void JoinChat (string name)

string GetXMPPName (string name)

void LeaveChat (string name)

SVoiceZone GetVoiceZone (string channel)

void JoinVoice (string channel, int priority=5, int spatial=0)

void JoinGridVoice (string channel, int priority=5, int spatial=0)

void LeaveVoice (string channel)

callback

Closure or Action

Invoked when a chat message is received

name

string

Chat channel to join

name

string

Human-readable chat name

name

string

Chat channel to leave

channel

string

Voice channel name/handle

channel

string

Voice channel name/handle

priority

int

Optional. Priority, default 5

spatial

int

Optional. Spatialization flag (0/1), default 0

channel

string

Voice channel name/handle (grid-wide)

priority

int

Optional. Priority, default 5

spatial

int

Optional. Spatialization flag (0/1), default 0

channel

string

Voice channel to leave

SChatMessage
Space.Network.Chat.OnChat(OnChatFunction) 
--this script takes every new chat message and displays it in a UIText 
uiText = Space.Host.GetReference("text").UIText --Add this Text object as reference in Scripting Runtime

OnChatFunction = function(SChatMessage)
uiText.Text = SChatMessage.Sender ..": " .. SChatMessage.Message 
end

Space.Network.Chat.OnChat(OnChatFunction) 
Space.Network.Chat.JoinChat("Test room")
--this script will make the player join a chat when entering a trigger collider and leave it when leaving
--[Requires this object to have a "Trigger" collider]

thisObject = Space.Host.ExecutingObject
thisPlayer = Space.Scene.PlayerAvatar

OTS = function(gameObject)
  if gameObject.Avatar ~= nil and thisPlayer == gameObject.Avatar then 

    Space.Network.Chat.JoinChat("PrivateChatZone")
    
  end

end

OTE = function(gameObject)
  if gameObject.Avatar ~= nil and thisPlayer == gameObject.Avatar then

    Space.Network.Chat.LeaveChat("PrivateChatZone")
    
  end 
  
end


thisObject.OnTriggerStart(OTS)
thisObject.OnTriggerExit(OTE)
Space.Network.Chat.GetXMPPName("Test room")
Space.Network.Chat.LeaveChat("Test room")
--this script will make the player join a chat when entering a trigger collider and leave it when leaving
--[Requires this object to have a "Trigger" collider]

thisObject = Space.Host.ExecutingObject
thisPlayer = Space.Scene.PlayerAvatar

OTS = function(gameObject)
  if gameObject.Avatar ~= nil and thisPlayer == gameObject.Avatar then 

    Space.Network.Chat.JoinChat("PrivateChatZone")
    
  end

end

OTE = function(gameObject)
  if gameObject.Avatar ~= nil and thisPlayer == gameObject.Avatar then

    Space.Network.Chat.LeaveChat("PrivateChatZone")
    
  end 
  
end


thisObject.OnTriggerStart(OTS)
thisObject.OnTriggerExit(OTE)
voiceZone = Space.Network.Chat.GetVoiceZone("AChannel")
Space.Network.Chat.JoinVoice("PrivateVoiceZone")
--this script will make the player join a voice channel when entering a trigger collider and leave it when leaving
--[Requires this object to have a "Trigger" collider]

thisObject = Space.Host.ExecutingObject
thisPlayer = Space.Scene.PlayerAvatar

OTS = function(gameObject)
  if gameObject.Avatar ~= nil and thisPlayer == gameObject.Avatar then 

    Space.Network.Chat.JoinVoice("PrivateVoiceZone")
    
  end

end

OTE = function(gameObject)
  if gameObject.Avatar ~= nil and thisPlayer == gameObject.Avatar then

    Space.Network.Chat.LeaveVoice("PrivateVoiceZone")
    
  end 
  
end


thisObject.OnTriggerStart(OTS)
thisObject.OnTriggerExit(OTE)
Space.Network.Chat.JoinGridVoice("PrivateGridVoiceZone")
--this script will make the player join a Grid voice channel when entering a trigger collider and leave it when leaving
--[Requires this object to have a "Trigger" collider]

thisObject = Space.Host.ExecutingObject
thisPlayer = Space.Scene.PlayerAvatar

OTS = function(gameObject)
  if gameObject.Avatar ~= nil and thisPlayer == gameObject.Avatar then 

    Space.Network.Chat.JoinGridVoice("PrivateGridVoiceZone")
    
  end

end

OTE = function(gameObject)
  if gameObject.Avatar ~= nil and thisPlayer == gameObject.Avatar then

    Space.Network.Chat.LeaveVoice("PrivateGridVoiceZone")
    
  end 
  
end


thisObject.OnTriggerStart(OTS)
thisObject.OnTriggerExit(OTE)
Space.Network.Chat.LeaveVoice("PrivateVoiceZone")
--this script will make the player join a voice channel when entering a trigger collider and leave it when leaving
--[Requires this object to have a "Trigger" collider]

thisObject = Space.Host.ExecutingObject
thisPlayer = Space.Scene.PlayerAvatar

OTS = function(gameObject)
  if gameObject.Avatar ~= nil and thisPlayer == gameObject.Avatar then 

    Space.Network.Chat.JoinVoice("PrivateVoiceZone")
    
  end

end

OTE = function(gameObject)
  if gameObject.Avatar ~= nil and thisPlayer == gameObject.Avatar then

    Space.Network.Chat.LeaveVoice("PrivateVoiceZone")
    
  end 
  
end


thisObject.OnTriggerStart(OTS)
thisObject.OnTriggerExit(OTE)