wiki.sine.space | sinespace

Difference between revisions of "Scripting/SBrowserSurface"

From wiki.sine.space
Jump to: navigation, search
m
Line 15: Line 15:
  
 
==Properties==
 
==Properties==
{{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>}}
+
{{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>|6= <pre> --the below scipt makes this object toggle Networking on it's parent browser
 +
--(Example: browser controls)
 +
--[Required: This object needs its parent to have the browser component]
 +
 
 +
thisGameObject = Space.Host.ExecutingObject
 +
 
 +
OnClick = function()
 +
 
 +
  if thisGameObject.Parent.Browser.Networked then
 +
  thisGameObject.Parent.Browser.Networked = false
 +
    Space.Log("Browser will not be networked")
 +
  else
 +
    thisGameObject.Parent.Browser.Networked = true
 +
    Space.Log("Browser will be networked")
 +
  end
 +
 
 +
end
 +
 
 +
thisGameObject.AddClickable()
 +
thisGameObject.Clickable.Tooltip = "Click to toggle Networking on Browser"
 +
thisGameObject.Clickable.OnClick(OnClick)  </pre>}}
  
 
{{ScriptFunction|bool|Muted|{ get;set; }|Whether this Browser Surface is muted or not.|5=<pre>Space.Host.ExecutingObject.Browser.Muted=true</pre>|6=<pre>--the below scipt makes this object a clickable that mutes/unmutes a browser surface
 
{{ScriptFunction|bool|Muted|{ get;set; }|Whether this Browser Surface is muted or not.|5=<pre>Space.Host.ExecutingObject.Browser.Muted=true</pre>|6=<pre>--the below scipt makes this object a clickable that mutes/unmutes a browser surface

Revision as of 03:29, 13 August 2021

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


 --the below scipt makes this object toggle Networking on it's parent browser
--(Example: browser controls)
--[Required: This object needs its parent to have the browser component]

thisGameObject = Space.Host.ExecutingObject

OnClick = function()

  if thisGameObject.Parent.Browser.Networked then
   thisGameObject.Parent.Browser.Networked = false
    Space.Log("Browser will not be networked")
  else
    thisGameObject.Parent.Browser.Networked = true
    Space.Log("Browser will be networked")
  end

end

thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "Click to toggle Networking on Browser"
thisGameObject.Clickable.OnClick(OnClick)   

Muted

bool Muted { get;set; }

Whether this Browser Surface is muted or not.

Space.Host.ExecutingObject.Browser.Muted=true


--the below scipt makes this object a clickable that mutes/unmutes a browser surface
--(Example: Browser Mute button )
--[Required: This object's parent needs to be an object with BrowserSurface component in it]

thisGameObject = Space.Host.ExecutingObject


OnClick = function()

  if thisGameObject.Parent.Browser.Muted then
   thisGameObject.Parent.Browser.Muted = false
    Space.Log("Browser unmuted")
  else
    thisGameObject.Parent.Browser.Muted = true
    Space.Log("Browser muted")
  end

end

thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "Click to Mute/Unmute Browser"
thisGameObject.Clickable.OnClick(OnClick)  

CanGoBack

bool CanGoBack { get; }

Returns whether this Browser Surface can navigate back

CanGoBack = Space.Host.ExecutingObject.Browser.CanGoBack


 --the below scipt makes this Browser object show/hide it's Forward and Back
--buttons according to wether the actions are possible or not
--(Example: browser navigation )
--[Required: This object needs the forward and back objects added to the references section in scripting runtime]

thisGameObject = Space.Host.ExecutingObject
forwardButton = Space.Host.GetReference("Forward Button")
backButton = Space.Host.GetReference("Back Button")

OnUpdate = function()
 
 if thisGameObject.Browser.CanGoBack then
   backButton.Active = true
  else backButton.Active = false
end

if thisGameObject.Browser.CanGoForward then
  forwardButton.Active = true
else forwardButton.Active = false
end

  
end



thisGameObject.SubscribeToEvents()
thisGameObject.OnUpdate(OnUpdate)

 

CanGoForward

bool CanGoForward { get; }

Returns whether this Browser Surface can navigate forward

CanGoForward = Space.Host.ExecutingObject.Browser.CanGoForward


 --the below scipt makes this Browser object show/hide it's Forward and Back
--buttons according to wether the actions are possible or not
--(Example: browser navigation )
--[Required: This object needs the forward and back objects added to the references section in scripting runtime]

thisGameObject = Space.Host.ExecutingObject
forwardButton = Space.Host.GetReference("Forward Button")
backButton = Space.Host.GetReference("Back Button")

OnUpdate = function()
 
 if thisGameObject.Browser.CanGoBack then
   backButton.Active = true
  else backButton.Active = false
end

if thisGameObject.Browser.CanGoForward then
  forwardButton.Active = true
else forwardButton.Active = false
end

  
end



thisGameObject.SubscribeToEvents()
thisGameObject.OnUpdate(OnUpdate)