CreateWebUI: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Creates a new WebUI}}


{{FuncSyntax|CreateWebUI(x, y, width, height [, zOrder, frameRate])}}
{{FuncSyntax|CreateWebUI(x, y, width, height [, zOrder, frameRate])}}
Line 10: Line 10:
{{FuncParam|width|pixel width}}
{{FuncParam|width|pixel width}}
{{FuncParam|height |pixel height}}
{{FuncParam|height |pixel height}}
{{FuncParamOptional|zOrder|order in which the webui's are rendered}}
{{FuncParamOptional|zOrder|order in which the webui's are rendered. (Default: 1)}}
{{FuncParamOptional|frameRate|rendering rate (default: 16)}}
{{FuncParamOptional|frameRate|rendering rate (default: 16).}}


{{FuncReturnValue|web (number)}}
{{FuncReturnValue|web (number)}}


== Example ==
== Example ==
__EDIT_ME__
Creates a fullscreen Web UI.
<syntaxHighlight lang="lua">
function OnPackageStart()
WebGuiId = CreateWebUI(0.0, 0.0, 0.0, 0.0, 4, 32)
LoadWebFile(WebGuiId, "http://asset/"..GetPackageName().."/gui/gui.html")
SetWebAlignment(WebGuiId, 0.0, 0.0)
SetWebAnchors(WebGuiId, 0.0, 0.0, 1.0, 1.0)
SetWebVisibility(WebGuiId, WEB_HITINVISIBLE)
end
AddEvent("OnPackageStart", OnPackageStart)
</syntaxHighlight>


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

Latest revision as of 13:31, 5 January 2020

CreateWebUI

Type: Function
Context: Client
Introduced: v1.0

Description

Creates a new WebUI

Syntax

CreateWebUI(x, y, width, height [, zOrder, frameRate])

Parameters

  • x
    screen pixel x
  • y
    screen pixel y
  • width
    pixel width
  • height
    pixel height
  • zOrder (optional)
    order in which the webui's are rendered. (Default: 1)
  • frameRate (optional)
    rendering rate (default: 16).

Return Value

  • web (number)

Example

Creates a fullscreen Web UI.

function OnPackageStart()
	WebGuiId = CreateWebUI(0.0, 0.0, 0.0, 0.0, 4, 32)
	LoadWebFile(WebGuiId, "http://asset/"..GetPackageName().."/gui/gui.html")
	SetWebAlignment(WebGuiId, 0.0, 0.0)
	SetWebAnchors(WebGuiId, 0.0, 0.0, 1.0, 1.0)
	SetWebVisibility(WebGuiId, WEB_HITINVISIBLE)
end
AddEvent("OnPackageStart", OnPackageStart)

See also