Difference between revisions of "GUIBaseWindow"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the GUIBaseWindow class)
(Documentation for the GUIBaseWindow class)
 
(2 intermediate revisions by the same user not shown)
Line 14: Line 14:
 
::
 
::
 
::Should we blur the back of the image
 
::Should we blur the back of the image
 +
 +
:{{CSharp|GUISprite BackgroundBlurMask {get;} }}
 +
::
 +
::Reference to the background blur mask for the window
  
 
:{{CSharp|Color32 BackgroundColor {get; set;} }}
 
:{{CSharp|Color32 BackgroundColor {get; set;} }}
Line 34: Line 38:
 
::
 
::
 
::Prevents this window from being brought to the front by clicking on it.
 
::Prevents this window from being brought to the front by clicking on it.
 +
 +
:{{CSharp|JSVector2 LayerAnchorMax {get; set;} }}
 +
 +
:{{CSharp|JSVector2 LayerAnchorMin {get; set;} }}
 +
 +
:{{CSharp|string LayerName {get;} }}
 +
 +
:{{CSharp|JSVector2 LayerPosition {get; set;} }}
 +
 +
:{{CSharp|JSVector2 LayerSizeDelta {get; set;} }}
  
 
:{{CSharp|GUIContainer ParentContainer {get; set;} }}
 
:{{CSharp|GUIContainer ParentContainer {get; set;} }}
Line 54: Line 68:
 
::
 
::
 
::Event called when the visible value of this window becomes false
 
::Event called when the visible value of this window becomes false
 +
 +
:{{CSharp|OnMethodInvoke()}}
  
 
:{{CSharp|OnShow()}}
 
:{{CSharp|OnShow()}}

Latest revision as of 17:25, 11 September 2019

A basic panel that can hold components somewhere on the screen

  • Inherits class: GUIContainer
  • This is a JavaScript visible object

Remarks [edit]

Properties

GUISprite Background {get;}
Reference to the background image for the window
bool BackgroundBlur {get; set;}
Should we blur the back of the image
GUISprite BackgroundBlurMask {get;}
Reference to the background blur mask for the window
Color32 BackgroundColor {get; set;}
Tint color applied to the background image
JSVector4 Border {get; set;}
Border to use for slicing the background image
bool FullScreenEffect {get; set;}
Should the full screen blur effect be active while this window is visible?
bool HideLoadingText {get; set;}
Does this window hide the "loading ..." text on the loading screen
bool IsHUD {get; set;}
Prevents this window from being brought to the front by clicking on it.
JSVector2 LayerAnchorMax {get; set;}
JSVector2 LayerAnchorMin {get; set;}
string LayerName {get;}
JSVector2 LayerPosition {get; set;}
JSVector2 LayerSizeDelta {get; set;}
GUIContainer ParentContainer {get; set;}
Parents this window inside another container (window or component). This reduces the autonomy of the window (and will destroy it if the parent is destroyed).
bool ShowWhileLoading {get; set;}
Does this window appear on top of the loading screen?
bool UseWorldCanvas {get; set;}
bool Visible {get; set;}
UIWorldCanvasExtended WorldCanvas {get;}

Events

OnEscape()
OnHide()
Event called when the visible value of this window becomes false
OnMethodInvoke()
OnShow()
Event called when the visible value of this window becomes true

Methods

void BringToFront()
Move this window to the front of the Z order