Difference between revisions of "GUIPanel"
From Virtual World Web Wiki
(Documentation for the GUIPanel class) |
(Documentation for the GUIPanel class) |
||
(7 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | * '''Inherits class: [[GUILayoutComponent]]''' | + | A component representing a panel with layout and subcomponents |
+ | |||
+ | *'''Inherits class: [[GUILayoutComponent]]''' | ||
* This is a JavaScript visible object | * This is a JavaScript visible object | ||
===Remarks <nowiki>[</nowiki>[{{fullurl:GUIPanel Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ===Remarks <nowiki>[</nowiki>[{{fullurl:GUIPanel Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ||
− | {{:GUIPanel Remarks}} | + | {{#ifexist:GUIPanel Remarks|{{:GUIPanel Remarks}}|}} |
===Properties=== | ===Properties=== | ||
+ | :{{CSharp|bool BackgroundBlur {get; set;} }} | ||
+ | :: | ||
+ | ::Should background of the panel be blurred | ||
+ | |||
:{{CSharp|JSVector4 Border {get; set;} }} | :{{CSharp|JSVector4 Border {get; set;} }} | ||
+ | :: | ||
+ | ::Border for the Image sprite. | ||
+ | |||
+ | :{{CSharp|bool ContrastEffect {get; set;} }} | ||
+ | :: | ||
+ | ::Enables a high-contrast effect on the panel | ||
+ | |||
+ | :{{CSharp|bool EffectsColorMode {get; set;} }} | ||
+ | :: | ||
+ | ::Enables DarkMode for the contrast effect | ||
:{{CSharp|GUISprite Image {get;} }} | :{{CSharp|GUISprite Image {get;} }} | ||
+ | :: | ||
+ | ::Reference to the image background of the panel | ||
:{{CSharp|Type ImageType {get; set;} }} | :{{CSharp|Type ImageType {get; set;} }} | ||
+ | :: | ||
+ | ::ImageType for the Image sprite | ||
:{{CSharp|bool Mask {get; set;} }} | :{{CSharp|bool Mask {get; set;} }} | ||
+ | :: | ||
+ | ::Whether this panel should mask its contents (i.e.: clip them against its image) | ||
:{{CSharp|bool PreserveAspect {get; set;} }} | :{{CSharp|bool PreserveAspect {get; set;} }} | ||
+ | :: | ||
+ | ::PreserveAspect for the Image sprite | ||
+ | |||
+ | :{{CSharp|bool RaycastMask {get; set;} }} | ||
__NOTOC____NOEDITSECTION__ | __NOTOC____NOEDITSECTION__ |
Latest revision as of 14:43, 20 April 2018
A component representing a panel with layout and subcomponents
- Inherits class: GUILayoutComponent
- This is a JavaScript visible object
Remarks [edit]
Properties
- bool BackgroundBlur {get; set;}
- Should background of the panel be blurred
- JSVector4 Border {get; set;}
- Border for the Image sprite.
- bool ContrastEffect {get; set;}
- Enables a high-contrast effect on the panel
- bool EffectsColorMode {get; set;}
- Enables DarkMode for the contrast effect
- GUISprite Image {get;}
- Reference to the image background of the panel
- Type ImageType {get; set;}
- ImageType for the Image sprite
- bool Mask {get; set;}
- Whether this panel should mask its contents (i.e.: clip them against its image)
- bool PreserveAspect {get; set;}
- PreserveAspect for the Image sprite
- bool RaycastMask {get; set;}