Difference between revisions of "SendShowOrHideAllUIEvent"

From Nomad DB
 
Line 1: Line 1:
Toggle the HUD visibility state
+
Enables or disables the whole UI.
  
 
== Syntax ==
 
== Syntax ==
Line 5: Line 5:
 
SendShowOrHideAllUIEvent(visible)
 
SendShowOrHideAllUIEvent(visible)
 
</syntaxhighlight>
 
</syntaxhighlight>
* '''visible''' (number): 0 to disable and 1 to enable the HUD
+
* '''visible''' (number): Whether the UI should be enabled or not (0 = disabled; 1 = enabled)
 
* '''Returns''' (boolean): Whether the call has been successful or not
 
* '''Returns''' (boolean): Whether the call has been successful or not
  
 
== Example ==
 
== Example ==
The example below will disable my HUD
+
Disables the whole UI.
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
SendShowOrHideAllUIEvent(0)
 
SendShowOrHideAllUIEvent(0)
</syntaxhighlight>
 
 
The example below will enable my HUD
 
<syntaxhighlight lang="lua">
 
SendShowOrHideAllUIEvent(1)
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Latest revision as of 20:13, 16 April 2020

Enables or disables the whole UI.

Syntax

SendShowOrHideAllUIEvent(visible)
  • visible (number): Whether the UI should be enabled or not (0 = disabled; 1 = enabled)
  • Returns (boolean): Whether the call has been successful or not

Example

Disables the whole UI.

SendShowOrHideAllUIEvent(0)

Related Pages