Difference between revisions of "GUI Global"
From Virtual World Web Wiki
(Documentation for the GUI Global class) |
(Documentation for the GUI Global class) |
||
Line 5: | Line 5: | ||
===Properties=== | ===Properties=== | ||
− | :{{CSharp| | + | :{{CSharp|float DPI {get;} }} |
− | :{{CSharp| | + | :{{CSharp|float Framerate {get;} }} |
− | :{{CSharp| | + | :{{CSharp|float FramerateFrequency {get; set;} }} |
:{{CSharp|int Height {get;} }} | :{{CSharp|int Height {get;} }} | ||
Line 17: | Line 17: | ||
:{{CSharp|bool IsLoading {get;} }} | :{{CSharp|bool IsLoading {get;} }} | ||
− | :{{CSharp| | + | :{{CSharp|float Latency {get;} }} |
:{{CSharp|int Width {get;} }} | :{{CSharp|int Width {get;} }} | ||
Line 24: | Line 24: | ||
===Methods=== | ===Methods=== | ||
− | :{{CSharp|GUIBaseWindow CreateBaseWindow(string name)}} | + | :{{CSharp|GUIBaseWindow CreateBaseWindow(string name {{=}} "")}} |
− | :{{CSharp|GUIBaseWindow CreateRawWindow(string name)}} | + | :{{CSharp|GUIBaseWindow CreateRawWindow(string name {{=}} "")}} |
− | :{{CSharp|GUIWindow CreateWindow(string name)}} | + | :{{CSharp|GUIWindow CreateWindow(string name {{=}} "")}} |
:{{CSharp|void DefineGlobalTemplates(string json)}} | :{{CSharp|void DefineGlobalTemplates(string json)}} | ||
Line 50: | Line 50: | ||
:{{CSharp|string LoadUISettings(string filename)}} | :{{CSharp|string LoadUISettings(string filename)}} | ||
− | :{{CSharp|bool NavigateTo(string address, string startpoint)}} | + | :{{CSharp|bool NavigateTo(string address, string startpoint {{=}} "")}} |
− | :{{CSharp|GUIWindow NewWindow(string name)}} | + | :{{CSharp|GUIWindow NewWindow(string name {{=}} "")}} |
:{{CSharp|bool RegisterGlobalTexture(string name, ResourceValue texture)}} | :{{CSharp|bool RegisterGlobalTexture(string name, ResourceValue texture)}} | ||
Line 58: | Line 58: | ||
:{{CSharp|void RegisterTutorialItem(string tutorialIdentifier, string itemIdentifier, GUIContainer target, string message)}} | :{{CSharp|void RegisterTutorialItem(string tutorialIdentifier, string itemIdentifier, GUIContainer target, string message)}} | ||
− | :{{CSharp|void SetCameraBloom( | + | :{{CSharp|void SetCameraBloom(float amount)}} |
− | :{{CSharp|void SetCameraBlur(bool enabled, | + | :{{CSharp|void SetCameraBlur(bool enabled, float amount)}} |
− | :{{CSharp|void SetCameraContrastEnhance( | + | :{{CSharp|void SetCameraContrastEnhance(float amount)}} |
− | :{{CSharp|void SetCameraFisheye( | + | :{{CSharp|void SetCameraFisheye(float amount)}} |
− | :{{CSharp|void SetCameraMotionBlur( | + | :{{CSharp|void SetCameraMotionBlur(float amount)}} |
− | :{{CSharp|void SetCameraNoise( | + | :{{CSharp|void SetCameraNoise(float amount)}} |
− | :{{CSharp|void SetCameraSaturation( | + | :{{CSharp|void SetCameraSaturation(float amount)}} |
− | :{{CSharp|void SetCameraShake(DetailsBlock details, | + | :{{CSharp|void SetCameraShake(DetailsBlock details, float amount)}} |
− | :{{CSharp|void SetCameraVignetting(bool enabled, | + | :{{CSharp|void SetCameraVignetting(bool enabled, float vignettingAmount, float edgeBlurAmount)}} |
− | :{{CSharp|void SetCameraWobble( | + | :{{CSharp|void SetCameraWobble(float angle, float speed)}} |
− | :{{CSharp|void SetSmallTooltipOffset( | + | :{{CSharp|void SetSmallTooltipOffset(float x, float y)}} |
− | :{{CSharp|void SetTooltipDelay( | + | :{{CSharp|void SetTooltipDelay(float ms)}} |
− | :{{CSharp|void SetTooltipOffset( | + | :{{CSharp|void SetTooltipOffset(float x, float y)}} |
:{{CSharp|void ShowConfirmation(string title, string description, string buttonOptions, JSFlexibleFunction callback)}} | :{{CSharp|void ShowConfirmation(string title, string description, string buttonOptions, JSFlexibleFunction callback)}} | ||
− | :{{CSharp|void ShowNotification(string title, string description, string buttons, int timeoutInMilliseconds, JSFlexibleFunction callback)}} | + | :{{CSharp|void ShowNotification(string title, string description, string buttons, int timeoutInMilliseconds {{=}} 0, JSFlexibleFunction callback {{=}} NULL)}} |
:{{CSharp|void ShowTutorial(string tutorialIdentifier)}} | :{{CSharp|void ShowTutorial(string tutorialIdentifier)}} | ||
__NOTOC____NOEDITSECTION__ | __NOTOC____NOEDITSECTION__ |
Revision as of 17:56, 20 February 2017
- This is a JavaScript visible object
- This is a JavaScript global object named 'GUI'
Remarks [edit]
Properties
- 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
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)
- void LoadTemplates(string filename)
- GUIBaseWindow LoadUI(string json)
- GUIBaseWindow LoadUIFile(string filename)
- 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(string title, string description, string buttonOptions, JSFlexibleFunction callback)
- void ShowNotification(string title, string description, string buttons, int timeoutInMilliseconds = 0, JSFlexibleFunction callback = NULL)
- void ShowTutorial(string tutorialIdentifier)