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)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
* This is a JavaScript visible object
+
* This is a JavaScript global object named '''GUI'''
−
* This is a JavaScript global object named 'GUI'
+
 
===Remarks <nowiki>[</nowiki>[{{fullurl:GUI Global Remarks|action=edit}} edit]<nowiki>]</nowiki>===
 
===Remarks <nowiki>[</nowiki>[{{fullurl:GUI Global Remarks|action=edit}} edit]<nowiki>]</nowiki>===
−
{{:GUI Global Remarks}}
+
{{#ifexist:GUI Global Remarks|{{:GUI Global Remarks}}|}}
  
 
===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 22: 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===
 
:{{CSharp|GUIBaseWindow CreateBaseWindow(string name {{=}} "")}}
 
:{{CSharp|GUIBaseWindow CreateBaseWindow(string name {{=}} "")}}
 +
 +
:{{CSharp|GUIContainer CreateComponent(string type)}}
  
 
:{{CSharp|GUIBaseWindow CreateRawWindow(string name {{=}} "")}}
 
:{{CSharp|GUIBaseWindow CreateRawWindow(string name {{=}} "")}}
Line 33: Line 43:
  
 
:{{CSharp|void DefineLocalTemplates(string json)}}
 
:{{CSharp|void DefineLocalTemplates(string json)}}
 +
 +
:{{CSharp|void DropFocus()}}
  
 
:{{CSharp|void EnableFreecam(bool enabled)}}
 
:{{CSharp|void EnableFreecam(bool enabled)}}
  
 
:{{CSharp|string[] FindResources(string path, string extensions)}}
 
:{{CSharp|string[] FindResources(string path, string extensions)}}
 +
 +
:{{CSharp|bool GetKey(string key)}}
 +
 +
:{{CSharp|IEnumerable<string> GetTypeNames()}}
  
 
:{{CSharp|GUIBaseWindow GetWindowByName(string name)}}
 
:{{CSharp|GUIBaseWindow GetWindowByName(string name)}}
Line 42: Line 58:
 
:{{CSharp|void InfoFadeout(string message)}}
 
:{{CSharp|void InfoFadeout(string message)}}
  
−
:{{CSharp|void LoadTemplates(string filename)}}
+
:{{CSharp|string LoadJSON(string filename)}}
 +
 
 +
:{{CSharp|void LoadTemplates(string uiFile, string uiOverlayFile {{=}} NULL)}}
  
 
:{{CSharp|GUIBaseWindow LoadUI(string json)}}
 
:{{CSharp|GUIBaseWindow LoadUI(string json)}}
  
−
:{{CSharp|GUIBaseWindow LoadUIFile(string filename)}}
+
:{{CSharp|GUIBaseWindow LoadUIFile(string uiFile, string layerName {{=}} NULL)}}
 +
 
 +
:{{CSharp|GUIBaseWindow LoadUIFileEx(string uiFile, string uiOverlayFile, string layerName {{=}} NULL)}}
  
 
:{{CSharp|string LoadUISettings(string filename)}}
 
:{{CSharp|string LoadUISettings(string filename)}}
Line 57: Line 77:
  
 
:{{CSharp|void RegisterTutorialItem(string tutorialIdentifier, string itemIdentifier, GUIContainer target, string message)}}
 
:{{CSharp|void RegisterTutorialItem(string tutorialIdentifier, string itemIdentifier, GUIContainer target, string message)}}
 +
 +
:{{CSharp|void Reload()}}
  
 
:{{CSharp|void SetCameraBloom(float amount)}}
 
:{{CSharp|void SetCameraBloom(float amount)}}
Line 72: Line 94:
 
:{{CSharp|void SetCameraSaturation(float amount)}}
 
:{{CSharp|void SetCameraSaturation(float amount)}}
  
−
:{{CSharp|void SetCameraShake(DetailsBlock details, float amount)}}
+
:{{CSharp|void SetCameraShake(float amount)}}
  
 
:{{CSharp|void SetCameraVignetting(bool enabled, float vignettingAmount, float edgeBlurAmount)}}
 
:{{CSharp|void SetCameraVignetting(bool enabled, float vignettingAmount, float edgeBlurAmount)}}
Line 84: Line 106:
 
:{{CSharp|void SetTooltipOffset(float x, float y)}}
 
:{{CSharp|void SetTooltipOffset(float x, float y)}}
  
−
:{{CSharp|void ShowConfirmation(string title, string description, string buttonOptions, JSFlexibleFunction callback)}}
+
:{{CSharp|void ShowConfirmation(AutoString title, AutoString description, string buttonOptions, JSFlexibleFunction callback)}}
  
−
:{{CSharp|void ShowNotification(string title, string description, string buttons, int timeoutInMilliseconds {{=}} 0, JSFlexibleFunction callback {{=}} NULL)}}
+
:{{CSharp|void ShowNotification(AutoString title, AutoString description, string buttons, int timeoutInMilliseconds {{=}} 0, JSFlexibleFunction callback {{=}} NULL)}}
  
 
:{{CSharp|void ShowTutorial(string tutorialIdentifier)}}
 
:{{CSharp|void ShowTutorial(string tutorialIdentifier)}}
  
 
__NOTOC____NOEDITSECTION__
 
__NOTOC____NOEDITSECTION__

Latest revision as of 12:10, 30 April 2019

  • 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 = "")
GUIContainer CreateComponent(string type)
GUIBaseWindow CreateRawWindow(string name = "")
GUIWindow CreateWindow(string name = "")
void DefineGlobalTemplates(string json)
void DefineLocalTemplates(string json)
void DropFocus()
void EnableFreecam(bool enabled)
string[] FindResources(string path, string extensions)
bool GetKey(string key)
IEnumerable<string> GetTypeNames()
GUIBaseWindow GetWindowByName(string name)
void InfoFadeout(string message)
string LoadJSON(string filename)
void LoadTemplates(string uiFile, string uiOverlayFile = NULL)
GUIBaseWindow LoadUI(string json)
GUIBaseWindow LoadUIFile(string uiFile, string layerName = NULL)
GUIBaseWindow LoadUIFileEx(string uiFile, string uiOverlayFile, 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 Reload()
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(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)


Retrieved from "http://wiki.virtualworldweb.com/index.php?title=GUI_Global&oldid=5556"