Difference between revisions of "GUIBaseWindow"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the GUIBaseWindow class)
(Documentation for the GUIBaseWindow class)
Line 1: Line 1:
A basic panel that can hold components somewhere on the screen
 
 
 
*'''Inherits class: [[GUIContainer]]'''
 
*'''Inherits class: [[GUIContainer]]'''
 
* This is a JavaScript visible object
 
* This is a JavaScript visible object
Line 8: Line 6:
 
===Properties===
 
===Properties===
 
:{{CSharp|GUISprite Background {get;} }}
 
:{{CSharp|GUISprite Background {get;} }}
::
 
::Reference to the background image for the window
 
  
 
:{{CSharp|Color32 BackgroundColor {get; set;} }}
 
:{{CSharp|Color32 BackgroundColor {get; set;} }}
::
 
::Tint color applied to the background image
 
  
 
:{{CSharp|JSVector4 Border {get; set;} }}
 
:{{CSharp|JSVector4 Border {get; set;} }}
::
 
::Border to use for slicing the background image
 
  
 
:{{CSharp|bool FullScreenEffect {get; set;} }}
 
:{{CSharp|bool FullScreenEffect {get; set;} }}
::
 
::Should the full screen blur effect be active while this window is visible?
 
  
 
:{{CSharp|GUIContainer ParentContainer {get; set;} }}
 
:{{CSharp|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).
 
  
 
:{{CSharp|bool ShowWhileLoading {get; set;} }}
 
:{{CSharp|bool ShowWhileLoading {get; set;} }}
::
 
::Does this window appear on top of the loading screen?
 
  
 
:{{CSharp|bool Visible {get; set;} }}
 
:{{CSharp|bool Visible {get; set;} }}
 +
 
===Events===
 
===Events===
 
:{{CSharp|OnHide()}}
 
:{{CSharp|OnHide()}}
::
 
::Event called when the visible value of this window becomes false
 
  
 
:{{CSharp|OnShow()}}
 
:{{CSharp|OnShow()}}
::
 
::Event called when the visible value of this window becomes true
 
  
 
===Methods===
 
===Methods===
 
:{{CSharp|void BringToFront()}}
 
:{{CSharp|void BringToFront()}}
::
 
::Move this window to the front of the Z order
 
  
 
__NOTOC____NOEDITSECTION__
 
__NOTOC____NOEDITSECTION__

Revision as of 14:16, 15 January 2018

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

Remarks [edit]

Properties

GUISprite Background {get;}
Color32 BackgroundColor {get; set;}
JSVector4 Border {get; set;}
bool FullScreenEffect {get; set;}
GUIContainer ParentContainer {get; set;}
bool ShowWhileLoading {get; set;}
bool Visible {get; set;}

Events

OnHide()
OnShow()

Methods

void BringToFront()