SetWebLocation: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetWebLocation(web, x, y [, z])}} {{FuncParameters}} {{FuncParam|web|__EDIT_ME__}} {{FuncParam|x|_...")
 
No edit summary
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Set the location for the specified web.}}


{{FuncSyntax|SetWebLocation(web, x, y [, z])}}
{{FuncSyntax|SetWebLocation(web, x, y [, z])}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|web|__EDIT_ME__}}
{{FuncParam|web|The web identifier}}
{{FuncParam|x|__EDIT_ME__}}
{{FuncParam|x|The X axis}}
{{FuncParam|y |__EDIT_ME__}}
{{FuncParam|y |The Y axis}}
{{FuncParamOptional|z|__EDIT_ME__}}
{{FuncParamOptional|z|The Z axis}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' on success.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
SetWebLocation(webId, 0.0, 0.0)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{WebFunctions}}

Revision as of 17:24, 15 December 2019

SetWebLocation

Type: Function
Context: Client
Introduced: v1.0

Description

Set the location for the specified web.

Syntax

SetWebLocation(web, x, y [, z])

Parameters

  • web
    The web identifier
  • x
    The X axis
  • y
    The Y axis
  • z (optional)
    The Z axis

Return Value

  • Returns true on success.

Example

SetWebLocation(webId, 0.0, 0.0)

See also