wiki.sine.space | sinespace

Difference between revisions of "Scripting/SBrowserSurface"

From wiki.sine.space
Jump to: navigation, search
m
(Added simple examples to SBrowserSurface .Networked .SetURL .Forward .Back .Reload)
Line 1: Line 1:
 
==Members==
 
==Members==
{{ScriptFunction|void|Back|();|Equivilent to hitting the 'back' button within the browser.
+
{{ScriptFunction|void|Back|();|Equivalent to hitting the 'back' button within the browser.|5=<pre>Space.Host.ExecutingObject.Browser.Back()</pre>}}
|5=
+
<pre></pre>}}
+
  
{{ScriptFunction|void|CallFunction|(string name, string argument);|Calls a JS function in the browser with a single argument. The function name must begin with the characters "sinespace__".|5=
+
{{ScriptFunction|void|CallFunction|(string name, string argument);|Calls a JS function in the browser with a single argument. The function name must begin with the characters "sinespace__".|5=<pre></pre>}}
<pre></pre>}}
+
  
{{ScriptFunction|void|Forward|();|Equivilent to hitting the 'forward' button within the browser.|5=
+
{{ScriptFunction|void|Forward|();|Equivalent to hitting the 'forward' button within the browser.|5=<pre>Space.Host.ExecutingObject.Browser.Forward()</pre>}}
<pre></pre>}}
+
  
{{ScriptFunction|void|RegisterFunction|(string name, closure function);|Registers a JS function in the browser. The function name must start with the characters "sinespace__".|5=
+
{{ScriptFunction|void|RegisterFunction|(string name, closure function);|Registers a JS function in the browser. The function name must start with the characters "sinespace__".|5=<pre></pre>}}
<pre></pre>}}
+
  
{{ScriptFunction|void|Reload|();|Refreshes and reloads the current webpage.|5=
+
{{ScriptFunction|void|Reload|();|Refreshes and reloads the current webpage.|5=<pre>Space.Host.ExecutingObject.Browser.Reload()</pre>}}
<pre></pre>}}
+
  
{{ScriptFunction|void|SetURL|(string url);|Sets the URL for the browser frame, and navigates to it. (A standard URL recognized by Chromium; e.g. https://www.youtube.com) |5=
+
{{ScriptFunction|void|SetURL|(string url);|Sets the URL for the browser frame, and navigates to it. (A standard URL recognized by Chromium; e.g. https://www.youtube.com) |5=<pre>Space.Host.ExecutingObject.Browser.SetURL('https://www.youtube.com')</pre>}}
<pre></pre>}}
+
  
  
 
==Properties==
 
==Properties==
{{ScriptFunction|bool|Networked|{ get;set; }|Should changes to this browser be streamed to other clients within the area?.|5=
+
{{ScriptFunction|bool|Networked|{ get;set; }|Should changes to this browser be streamed to other clients within the area?.|5=<pre>Space.Host.ExecutingObject.Browser.Networked=true</pre>}}
<pre></pre>}}
+
  
 
{{Scripting Navbox}}
 
{{Scripting Navbox}}

Revision as of 18:37, 14 December 2020

Members

Back

void Back ();

Equivalent to hitting the 'back' button within the browser.

Space.Host.ExecutingObject.Browser.Back()


CallFunction

void CallFunction (string name, string argument);

Calls a JS function in the browser with a single argument. The function name must begin with the characters "sinespace__".


Forward

void Forward ();

Equivalent to hitting the 'forward' button within the browser.

Space.Host.ExecutingObject.Browser.Forward()


RegisterFunction

void RegisterFunction (string name, closure function);

Registers a JS function in the browser. The function name must start with the characters "sinespace__".


Reload

void Reload ();

Refreshes and reloads the current webpage.

Space.Host.ExecutingObject.Browser.Reload()


SetURL

void SetURL (string url);

Sets the URL for the browser frame, and navigates to it. (A standard URL recognized by Chromium; e.g. https://www.youtube.com)

Space.Host.ExecutingObject.Browser.SetURL('https://www.youtube.com')



Properties

Networked

bool Networked { get;set; }

Should changes to this browser be streamed to other clients within the area?.

Space.Host.ExecutingObject.Browser.Networked=true