Anvil
Public Member Functions | Properties | List of all members
Anvil.API.NuiWindow Class Reference

Represents a NUI scriptable window container. More...

Public Member Functions

 NuiWindow (NuiLayout root, NuiProperty< string > title)
 

Properties

NuiProperty< bool > AcceptsInput = true [get, set]
 Set to false to disable all input. All hover, clicks and keypresses will fall through. More...
 
NuiProperty< bool > Border = true [get, set]
 Gets or sets whether the window border should be rendered. More...
 
NuiProperty< bool > Closable = true [get, set]
 Gets or sets whether this window can be closed.
You must provide a way to close the window if you set this to false. More...
 
NuiProperty< bool >? Collapsed [get, set]
 Gets or sets whether this window is collapsed.
Use a static value to force the popup into a collapsed/unfolded state. More...
 
NuiProperty< NuiRect > Geometry = new NuiRect(-1, -1, 0, 0) [get, set]
 Gets or sets the geometry and bounds of this window.
Set x and y to -1.0 to center the window.
Set x and/or y to -2.0 to position the window's top left at the mouse cursor's position of that axis
Set x and/or y to -3.0 to center the window on the mouse cursor's position of that axis More...
 
string? Id [get, set]
 Gets or sets the element ID for this window. More...
 
NuiProperty< bool > Resizable = true [get, set]
 Gets or sets whether this window can be resized. More...
 
NuiLayout Root [get, set]
 Gets or sets the root parent layout containing the window content. More...
 
NuiProperty< string > Title [get, set]
 Gets or sets the title of this window. More...
 
NuiProperty< bool > Transparent = false [get, set]
 Gets or sets whether the background should be rendered. More...
 
int Version = 1 [get]
 Gets the current serialized version of this window. More...
 

Detailed Description

Represents a NUI scriptable window container.

Property Documentation

◆ AcceptsInput

NuiProperty<bool> Anvil.API.NuiWindow.AcceptsInput = true
getset

Set to false to disable all input. All hover, clicks and keypresses will fall through.

◆ Border

NuiProperty<bool> Anvil.API.NuiWindow.Border = true
getset

Gets or sets whether the window border should be rendered.

◆ Closable

NuiProperty<bool> Anvil.API.NuiWindow.Closable = true
getset

Gets or sets whether this window can be closed.
You must provide a way to close the window if you set this to false.

◆ Collapsed

NuiProperty<bool>? Anvil.API.NuiWindow.Collapsed
getset

Gets or sets whether this window is collapsed.
Use a static value to force the popup into a collapsed/unfolded state.

◆ Geometry

NuiProperty<NuiRect> Anvil.API.NuiWindow.Geometry = new NuiRect(-1, -1, 0, 0)
getset

Gets or sets the geometry and bounds of this window.
Set x and y to -1.0 to center the window.
Set x and/or y to -2.0 to position the window's top left at the mouse cursor's position of that axis
Set x and/or y to -3.0 to center the window on the mouse cursor's position of that axis

◆ Id

string? Anvil.API.NuiWindow.Id
getset

Gets or sets the element ID for this window.

◆ Resizable

NuiProperty<bool> Anvil.API.NuiWindow.Resizable = true
getset

Gets or sets whether this window can be resized.

◆ Root

NuiLayout Anvil.API.NuiWindow.Root
getset

Gets or sets the root parent layout containing the window content.

◆ Title

NuiProperty<string> Anvil.API.NuiWindow.Title
getset

Gets or sets the title of this window.

◆ Transparent

NuiProperty<bool> Anvil.API.NuiWindow.Transparent = false
getset

Gets or sets whether the background should be rendered.

◆ Version

int Anvil.API.NuiWindow.Version = 1
get

Gets the current serialized version of this window.

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