SetWebVolume

From Onset Developer Wiki
Revision as of 14:01, 23 February 2022 by BlueMountains (talk | contribs) (Created page with "{{Info|Function|Client|1.5.5}} {{FuncDescription|Set the web UI audio volume.}} {{FuncSyntax|SetWebVolume(web, volume)}} {{FuncParameters}} {{FuncParam|web|The web identifier}} {{FuncParam|volume|The new audio volume, default: 1.0}} {{FuncReturnValue|This function returns '''true''' on success.}} == Example == <syntaxhighlight lang='Lua'> SetWebVolume(web, 0.5) </syntaxhighlight> {{RelatedFunctions}} {{Template:WebFunctions}}")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
SetWebVolume

Type: Function
Context: Client
Introduced: v1.5.5

Description

Set the web UI audio volume.

Syntax

SetWebVolume(web, volume)

Parameters

  • web
    The web identifier
  • volume
    The new audio volume, default: 1.0

Return Value

  • This function returns true on success.

Example

SetWebVolume(web, 0.5)

See also