wiki.sine.space | sinespace

Difference between revisions of "Scripting/SWebService"

From wiki.sine.space
Jump to: navigation, search
Line 10: Line 10:
 
It should be noted that the callback function to handle the WebResponse MUST BE DEFINED PRIOR TO CALLING or a script crash will occur. Thanks to Serp Serpton for this highly relevant detail.
 
It should be noted that the callback function to handle the WebResponse MUST BE DEFINED PRIOR TO CALLING or a script crash will occur. Thanks to Serp Serpton for this highly relevant detail.
  
{{ScriptFunction|void|Get|(string url, Action<SWebResponse> onComplete);|Performs a HTTP[S] GET against URL and returns the contents as a SWebResponse|5 = local value1 = "SomeValue1"<br>
+
{{ScriptFunction|void|Get|(string url, Action<SWebResponse> onComplete);|Performs a HTTP[S] GET against URL and returns the contents as a SWebResponse
local value2 = "SomeValue2"<br>
+
''--For example, you want to get a game data from your domain''
local sentData = "http://www.someplace.net/someScript.php?variable1=" .. value1 .. "&variable2=" .. value2<br>
+
local userID = "AvatarID" ''--You can using Space.Scene.PlayerAvatar to get the current player's info''<br>
 +
local gameID = "GameID" ''--Just an example, like you have more than one game hosted''<br>
 +
local sentData = "http://www.yourdomain.net/getGameData.php?id=" .. userID .. "&game=" .. gameID<br>
 
<br>
 
<br>
 
local response = function(data)<br>
 
local response = function(data)<br>
Line 20: Line 22:
 
end<br>
 
end<br>
 
<br>
 
<br>
'''webService.Get'''(sentData, response)<br>
+
'''Spade.WebService.Get'''(sentData, response)<br>
''-- NOTE: variable1 and variable2 would match Get variables in someScript.php.''}}
+
}}
  
{{ScriptFunction|void|Post|(string url, string data, Action<SWebResponse> onComplete);|Performs a HTTP[S] POST against URL using data as a post string and returns the contents as a SWebResponse|5 = local value1 = "SomeValue1"<br>
+
{{ScriptFunction|void|Post|(string url, string data, Action<SWebResponse> onComplete);|Performs a HTTP[S] POST against URL using data as a post string and returns the contents as a SWebResponse
 +
local value1 = "SomeValue1"<br>
 
local value2 = "SomeValue2"<br>
 
local value2 = "SomeValue2"<br>
 
local url = "http://www.someplace.net/someScript.php"<br>
 
local url = "http://www.someplace.net/someScript.php"<br>

Revision as of 02:11, 24 December 2018

The SWebService class allows you to contact servers you control via HTTP[S] and GET or POST data strings.

Whitelisting

To prevent Space users from unintentionally becoming part of a DDoS botnet, the Space client will first check for a file on a domain before allowing communications with the domain. If this file cannot be found, it will no longer communicate with that domain until the user logs.

To setup your server for communication with space, in the root of your domain, on the port you are using, place a file named 'sinewave.space.scripting.txt' containing 'SPACE_OK'. E.g. http://somewhere.com/sinewave.space.scripting.txt - if this file is not present, you will be unable to use scripting to communicate with the domain. Note: you should use HTTPS for all API calls if you want these to work reliably in WebGL. You may also need to implement a CORS policy in your webserver headers.

Members

It should be noted that the callback function to handle the WebResponse MUST BE DEFINED PRIOR TO CALLING or a script crash will occur. Thanks to Serp Serpton for this highly relevant detail.

Get

void Get (string url, Action<SWebResponse> onComplete);

No documentation

No example provided yet


Post

void Post (string url, string data, Action<SWebResponse> onComplete);

No documentation

No example provided yet


GetImage

SResource GetImage (string url);

Returns a valid SResource for a image on a remote domain that can be used via e.g. Scripting/SMaterial. While the image loads, it will be a white pixel that will be substituted with the real image once loaded.

function hithere()
 image = "mrlee.jpg"
 server = "https://middleware.systems/"
 obj = Space.Host.GetReference("dispobj")
 resrc = Space.WebServices.GetImage(server .. "mrlee.jpg")
 obj.Renderer.Material.SetTexture("_MainTex", resrc)
end