Anvil
Anvil.API.NuiGroup Class Reference

A group, usually with a border and some padding, holding a single element. Can scroll.
Will not advise parent of size, so you need to let it fill a span (col/row) as if it was a element. More...

+ Inheritance diagram for Anvil.API.NuiGroup:
+ Collaboration diagram for Anvil.API.NuiGroup:

Public Member Functions

void SetLayout (NwPlayer player, int token, NuiLayout newLayout)
 Sets the group layout for a specific player + window token (override/partial update).
More...
 

Properties

bool Border = true [get, set]
 
NuiElementElement [get, set]
 
NuiLayoutLayout [get, set]
 
NuiScrollbars Scrollbars = NuiScrollbars.Auto [get, set]
 
override IEnumerable< NuiElementSerializedChildren [get]
 
override string Type [get]
 
- Properties inherited from Anvil.API.NuiLayout
abstract IEnumerable< NuiElementSerializedChildren [get]
 
- Properties inherited from Anvil.API.NuiElement
float? Aspect [get, set]
 The aspect ratio (x/y) for this element. More...
 
NuiProperty< string >? DisabledTooltip [get, set]
 Tooltips for disabled elements show on mouse hover. More...
 
List< NuiDrawListItem >? DrawList [get, set]
 
NuiProperty< bool >? Enabled [get, set]
 Toggles if this element is active/interactable, or disabled/greyed out. More...
 
NuiProperty< bool >? Encouraged [get, set]
 Encouraged elements have a breathing animated glow inside of it. More...
 
NuiProperty< Color >? ForegroundColor [get, set]
 Style the foreground color of this widget.
This is dependent on the widget in question and only supports solid/full colors right now (no texture skinning).
For example, labels would style their text color; progress bars would style the bar. More...
 
float? Height [get, set]
 The height of this element, in pixels. More...
 
string? Id [get, set]
 A unique identifier for this element. More...
 
float? Margin [get, set]
 The margin on the widget. The margin is the spacing outside of the widget. More...
 
float? Padding [get, set]
 The padding on the widget. The padding is the spacing inside of the widget. More...
 
NuiProperty< bool >? Scissor [get, set]
 
NuiProperty< string >? Tooltip [get, set]
 A tooltip to show when hovering over this element. More...
 
abstract string Type [get]
 
NuiProperty< bool >? Visible [get, set]
 Toggles if this element should/should not be rendered. Invisible elements still take up layout space, and cannot be clicked through. More...
 
float? Width [get, set]
 The width of this element, in pixels. More...
 

Detailed Description

A group, usually with a border and some padding, holding a single element. Can scroll.
Will not advise parent of size, so you need to let it fill a span (col/row) as if it was a element.

Member Function Documentation

◆ SetLayout()

void Anvil.API.NuiGroup.SetLayout ( NwPlayer  player,
int  token,
NuiLayout  newLayout 
)
inline

Sets the group layout for a specific player + window token (override/partial update).

Parameters
playerThe player with the window containing this group.
tokenThe token of the window to update.
newLayoutThe new layout to apply to this group.
Exceptions
InvalidOperationExceptionThrown if this group does not have an Id assigned.

The documentation for this class was generated from the following file: