wiki.sine.space | sinespace

Difference between revisions of "Scripting/SChat"

From wiki.sine.space
Jump to: navigation, search
Line 141: Line 141:
  
  
{{ScriptFunction|void|JoinVoice|(string channel, int prioroty<nowiki>=</nowiki>5, int spatial<nowiki>=</nowiki> 0);|Join a grid voice chat channel.|5=
+
{{ScriptFunction|void|JoinGridVoice|(string channel, int prioroty<nowiki>=</nowiki>5, int spatial<nowiki>=</nowiki> 0);|Join a grid voice chat channel. (white-label only)|5=
 
Space.Network.Chat.JoinGridVoice("PrivateGridVoiceZone")|6=}}
 
Space.Network.Chat.JoinGridVoice("PrivateGridVoiceZone")|6=}}
  

Revision as of 16:35, 24 November 2021

Members

JoinChat

void JoinChat (string name);

Join a chat channel.

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)

LeaveChat

void LeaveChat (string name);

Leave a chat channel.

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)

OnChat

void OnChat (Action< SChatMessage > callback);
Bind a function to the OnChat event. This function will be called every time a new chat message is received on the local channel.
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) 


GetXMPPName

string GetXMPPName (string name);

Get XMPP name.

Space.Network.Chat.GetXMPPName("Test room")



JoinVoice

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

Join a voice chat channel.

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)


LeaveVoice

void LeaveVoice (string channel);

Leave a voice chat channel

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)


JoinGridVoice

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

Join a grid voice chat channel. (white-label only)

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