Difference between revisions of "GUI Global"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the GUI Global class)
(Documentation for the GUI Global class)
Line 4: Line 4:
  
 
===Properties===
 
===Properties===
 +
:{{CSharp|bool BackgroundBlur {get;} }}
 +
::
 +
::Returns whether or not the Frosted UI feature is enabled
 +
 
:{{CSharp|float DPI {get;} }}
 
:{{CSharp|float DPI {get;} }}
  
Line 21: Line 25:
 
::
 
::
 
::Returns the width (in pixels) of the client-usable screen space
 
::Returns the width (in pixels) of the client-usable screen space
 +
 +
===Events===
 +
:{{CSharp|OnBackgroundBlurChanged()}}
 +
::
 +
::Event fired when the user changes the preference for BackgroundBlur
  
 
===Methods===
 
===Methods===

Revision as of 13:29, 15 August 2018

  • This is a JavaScript global object named GUI

Remarks [edit]

Properties

bool BackgroundBlur {get;}
Returns whether or not the Frosted UI feature is enabled
float DPI {get;}
float Framerate {get;}
float FramerateFrequency {get; set;}
int Height {get;}
Returns the height (in pixels) of the client-usable screen space.
bool IsLoading {get;}
float Latency {get;}
int Width {get;}
Returns the width (in pixels) of the client-usable screen space

Events

OnBackgroundBlurChanged()
Event fired when the user changes the preference for BackgroundBlur

Methods

GUIBaseWindow CreateBaseWindow(string name = "")
GUIBaseWindow CreateRawWindow(string name = "")
GUIWindow CreateWindow(string name = "")
void DefineGlobalTemplates(string json)
void DefineLocalTemplates(string json)
void EnableFreecam(bool enabled)
string[] FindResources(string path, string extensions)
GUIBaseWindow GetWindowByName(string name)
void InfoFadeout(string message)
string LoadJSON(string filename)
void LoadTemplates(string filename)
GUIBaseWindow LoadUI(string json)
GUIBaseWindow LoadUIFile(string filename, string layername = NULL)
string LoadUISettings(string filename)
bool NavigateTo(string address, string startpoint = "")
GUIWindow NewWindow(string name = "")
bool RegisterGlobalTexture(string name, ResourceValue texture)
void RegisterTutorialItem(string tutorialIdentifier, string itemIdentifier, GUIContainer target, string message)
void SetCameraBloom(float amount)
void SetCameraBlur(bool enabled, float amount)
void SetCameraContrastEnhance(float amount)
void SetCameraFisheye(float amount)
void SetCameraMotionBlur(float amount)
void SetCameraNoise(float amount)
void SetCameraSaturation(float amount)
void SetCameraShake(DetailsBlock details, float amount)
void SetCameraVignetting(bool enabled, float vignettingAmount, float edgeBlurAmount)
void SetCameraWobble(float angle, float speed)
void SetSmallTooltipOffset(float x, float y)
void SetTooltipDelay(float ms)
void SetTooltipOffset(float x, float y)
void ShowConfirmation(AutoString title, AutoString description, string buttonOptions, JSFlexibleFunction callback)
void ShowNotification(AutoString title, AutoString description, string buttons, int timeoutInMilliseconds = 0, JSFlexibleFunction callback = NULL)
void ShowTutorial(string tutorialIdentifier)