CreateWebUI3D: 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|Creates a new WebUI in 3d space}}
{{FuncDescription|Creates a new WebUI in 3d space. Use [[DestroyWebUI]] to destroy it.}}


{{FuncSyntax|CreateWebUI3D(x, y, z, rx, ry, rz, width, height [, frameRate])}}
{{FuncSyntax|CreateWebUI3D(x, y, z, rx, ry, rz, width, height [, frameRate, AudioFalloffDistance])}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|x|__EDIT_ME__}}
{{FuncParam|x|The X axis}}
{{FuncParam|y|__EDIT_ME__}}
{{FuncParam|y|The Y axis}}
{{FuncParam|z|__EDIT_ME__}}
{{FuncParam|z|The Z axis}}
{{FuncParam|rx|__EDIT_ME__}}
{{FuncParam|rx|The RX axis}}
{{FuncParam|ry|__EDIT_ME__}}
{{FuncParam|ry|The RY axis}}
{{FuncParam|rz|__EDIT_ME__}}
{{FuncParam|rz|The RZ axis}}
{{FuncParam|width|__EDIT_ME__}}
{{FuncParam|width|The width}}
{{FuncParam|height |__EDIT_ME__}}
{{FuncParam|height |The height}}
{{FuncParamOptional|frameRate|__EDIT_ME__}}
{{FuncParamOptional|frameRate|The framerate}}
{{FuncParamOptional|AudioFalloffDistance|The distance in which the WebUI audio will fade. Default: '''1000.0'''}}


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


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
local cinemaUI = CreateWebUI3D(0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1360, 720, 60, 2000.0)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
[[CreateRemoteWebUI3D]]
{{WebFunctions}}
[[CreateWebUI]]
[[CreateRemoteWebUI]]
[[DestroyWebUI]]

Latest revision as of 09:32, 14 February 2022

CreateWebUI3D

Type: Function
Context: Client
Introduced: v1.0

Description

Creates a new WebUI in 3d space. Use DestroyWebUI to destroy it.

Syntax

CreateWebUI3D(x, y, z, rx, ry, rz, width, height [, frameRate, AudioFalloffDistance])

Parameters

  • x
    The X axis
  • y
    The Y axis
  • z
    The Z axis
  • rx
    The RX axis
  • ry
    The RY axis
  • rz
    The RZ axis
  • width
    The width
  • height
    The height
  • frameRate (optional)
    The framerate
  • AudioFalloffDistance (optional)
    The distance in which the WebUI audio will fade. Default: 1000.0

Return Value

  • web (number)

Example

local cinemaUI = CreateWebUI3D(0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1360, 720, 60, 2000.0)

See also