SetWebURL: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetWebURL(web, URL)}} {{FuncParameters}} {{FuncParam|web|__EDIT_ME__}} {{FuncParam|URL|__EDIT_ME__...")
 
No edit summary
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Set the web URL. Not all URLs are whitelisted and might not work.}}


{{FuncSyntax|SetWebURL(web, URL)}}
{{FuncSyntax|SetWebURL(web, URL)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|web|__EDIT_ME__}}
{{FuncParam|web|The web identifier}}
{{FuncParam|URL|__EDIT_ME__}}
{{FuncParam|URL|The URL}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns ''false''' on failure.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
SetWebURL(webId, "https://playonset.com")
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{Template:WebFunctions}}

Revision as of 07:45, 13 December 2019

SetWebURL

Type: Function
Context: Client
Introduced: v1.0

Description

Set the web URL. Not all URLs are whitelisted and might not work.

Syntax

SetWebURL(web, URL)

Parameters

  • web
    The web identifier
  • URL
    The URL

Return Value

  • Returns false' on failure.

Example

SetWebURL(webId, "https://playonset.com")

See also