Skip to content
luxe API

luxe: ui/window.control

Data

Section titled “Data”
import "luxe: ui/window.control" for Data

no docs found

Variables

Section titled “Variables”
var bring_to_front : Bool = true
var closable : Bool = true
var collapsible : Bool = true
var resizable : Bool = true
var draggable : Bool = true
var title_height : Num = 40
var text : String = ""
var align : WindowAlignH = WindowAlignH.left
var align_vertical : WindowAlignV = WindowAlignV.center
var localization : Localization = Object
var max_visible : Num = -1
var text_margin : Float4 = [8, 0, 8, 0]
var override : Object = Object

Localization

Section titled “Localization”
import "luxe: ui/window.control" for Localization

no docs found

Variables

Section titled “Variables”
var key : String = null
var space : String = "game"
var args : List = []

UIWindow

Section titled “UIWindow”
import "luxe: ui/window.control" for UIWindow

UIWindow is a Control with a title bar, close button, and can be moved around and resized like a windowed application on a desktop operating system. As you’d expect, you can attach other Controls to it that stay attached as you move it around.

  var window = UIWindow.create(ui)
  UIWindow.set_text(window, "I'm a window!")
  UIWindow.set_title_size(window, 24)
  UIWindow.set_text_size(window, 14)
  UIWindow.set_resizable(window, true)
  Control.set_bounds(window, 64, 64, 680, 360)

UIWindow.override(.)

Section titled “UIWindow.override(.)”
UIWindow.override(window : Control) : WindowInfo

no docs found

UIWindow.override_text(.)

Section titled “UIWindow.override_text(.)”
UIWindow.override_text(window : Control) : LabelInfo

no docs found

UIWindow.override_base(.)

Section titled “UIWindow.override_base(.)”
UIWindow.override_base(window : Control) : PanelInfo

no docs found

UIWindow.override_header(.)

Section titled “UIWindow.override_header(.)”
UIWindow.override_header(window : Control) : PanelInfo

no docs found

UIWindow.create(.)

Section titled “UIWindow.create(.)”
UIWindow.create(ui_entity : Entity) : UIWindow

Create a new UIWindow control for the given UI.

UIWindow.close(.)

Section titled “UIWindow.close(.)”
UIWindow.close(window : Control) : None

Make the given window disappear.

UIWindow.set_collapsed(..)

Section titled “UIWindow.set_collapsed(..)”
UIWindow.set_collapsed(window : Control, state : Bool) : None

Set whether the given window’s body is drawn (false, uncollapsed) or only the titlebar (true, collapsed).

UIWindow.get_collapsed(.)

Section titled “UIWindow.get_collapsed(.)”
UIWindow.get_collapsed(window : Control) : Bool

Get if the given window is collapsed.

UIWindow.set_text(..)

Section titled “UIWindow.set_text(..)”
UIWindow.set_text(window : Control, text : String) : None

Set the titlebar text of the given window.

UIWindow.get_text(.)

Section titled “UIWindow.get_text(.)”
UIWindow.get_text(window : Control) : String

Get the titlebar text of the given window.

UIWindow.set_text_size(..)

Section titled “UIWindow.set_text_size(..)”
UIWindow.set_text_size(window : Control, size : Num) : None

Set the size of the text on a window.

UIWindow.get_text_size(.)

Section titled “UIWindow.get_text_size(.)”
UIWindow.get_text_size(window : Control) : Num

Get the size of the text on a window.

UIWindow.set_text_color(..)

Section titled “UIWindow.set_text_color(..)”
UIWindow.set_text_color(window : Control, color : Color) : None

Set the color of the window text.

UIWindow.get_text_color(.)

Section titled “UIWindow.get_text_color(.)”
UIWindow.get_text_color(window : Control) : Color

Get the color of a window.

UIWindow.get_text_font(.)

Section titled “UIWindow.get_text_font(.)”
UIWindow.get_text_font(window : Control) : Font

Get the font asset id of the text on the window. The asset id is returned as the string hash, to get the string use Strings.get.

UIWindow.set_text_font(..)

Section titled “UIWindow.set_text_font(..)”
UIWindow.set_text_font(window : Control, font : Font) : None

Set the font of the text on a window.

UIWindow.set_title_size(..)

Section titled “UIWindow.set_title_size(..)”
UIWindow.set_title_size(window : Control, size : Num) : None

Set the height of the titlebar of the given window.

UIWindow.set_resizable(..)

Section titled “UIWindow.set_resizable(..)”
UIWindow.set_resizable(window : Control, state : Bool) : None

Set if a window can be resized by dragging its bottom right corner.

UIWindow.set_bring_to_front(..)

Section titled “UIWindow.set_bring_to_front(..)”
UIWindow.set_bring_to_front(window : Control, state : Bool) : None

Set if a window will bring itself to the front of the UI when interacted with.

UIWindow.set_closable(..)

Section titled “UIWindow.set_closable(..)”
UIWindow.set_closable(window : Control, state : Bool) : None

Set if a window has a Close button the user can press.

UIWindow.set_collapsible(..)

Section titled “UIWindow.set_collapsible(..)”
UIWindow.set_collapsible(window : Control, state : Bool) : None

Set if a window has a Collapse button the user can press.

UIWindow.set_draggable(..)

Section titled “UIWindow.set_draggable(..)”
UIWindow.set_draggable(window : Control, state : Bool) : None

Set if a window can be dragged around with the mouse.

UIWindow.get_resizable(.)

Section titled “UIWindow.get_resizable(.)”
UIWindow.get_resizable(window : Control) : Bool

Get if a window can be resized by the user.

UIWindow.get_bring_to_front(.)

Section titled “UIWindow.get_bring_to_front(.)”
UIWindow.get_bring_to_front(window : Control) : unknown

Get if a window will bring itself to the front of the UI when interacted with.

UIWindow.get_closable(.)

Section titled “UIWindow.get_closable(.)”
UIWindow.get_closable(window : Control) : unknown

Get if a window has its Close button visible.

UIWindow.get_collapsible(.)

Section titled “UIWindow.get_collapsible(.)”
UIWindow.get_collapsible(window : Control) : unknown

Get if a window has its Collapse button visible.

UIWindow.get_draggable(.)

Section titled “UIWindow.get_draggable(.)”
UIWindow.get_draggable(window : Control) : unknown

Get if a window can be dragged around with the mouse.

UIWindow.set_align(..)

Section titled “UIWindow.set_align(..)”
UIWindow.set_align(window : Control, align : TextAlign) : None

Set the horizontal alignment of the text on a window.

UIWindow.get_align(.)

Section titled “UIWindow.get_align(.)”
UIWindow.get_align(window : Control) : TextAlign

Get the horizontal alignment of the text on a window.

UIWindow.set_align_vertical(..)

Section titled “UIWindow.set_align_vertical(..)”
UIWindow.set_align_vertical(window : Control, align : TextAlign) : None

Set the vertical alignment of the text on a window.

UIWindow.get_align_vertical(.)

Section titled “UIWindow.get_align_vertical(.)”
UIWindow.get_align_vertical(window : Control) : TextAlign

Get the vertical alignment of the text on a window.

UIWindow.set_loc(…)

Section titled “UIWindow.set_loc(…)”
UIWindow.set_loc(window : Control, space : String, key : String) : None

no docs found

UIWindow.set_loc(..)

Section titled “UIWindow.set_loc(..)”
UIWindow.set_loc(window : Control, key : String) : None

no docs found

UIWindow.set_loc_with_args(…)

Section titled “UIWindow.set_loc_with_args(…)”
UIWindow.set_loc_with_args(window : Control, space : String, key : String, args : List) : None

no docs found

UIWindow.set_loc_with_args(…)

Section titled “UIWindow.set_loc_with_args(…)”
UIWindow.set_loc_with_args(window : Control, key : String, args : List) : None

no docs found

UIWindow.get_render_text(.)

Section titled “UIWindow.get_render_text(.)”
UIWindow.get_render_text(window : Control) : RenderText

Get the underlying lowlevel text render object. Usable with the Render.text_* API.

UIWindowChange

Section titled “UIWindowChange”
import "luxe: ui/window.control" for UIWindowChange

no docs found

UIWindowChange.close

Section titled “UIWindowChange.close”
UIWindowChange.close : unknown

no docs found

UIWindowChange.open

Section titled “UIWindowChange.open”
UIWindowChange.open : unknown

no docs found

UIWindowChange.collapse

Section titled “UIWindowChange.collapse”
UIWindowChange.collapse : unknown

no docs found

UIWindowChange.uncollapse

Section titled “UIWindowChange.uncollapse”
UIWindowChange.uncollapse : unknown

no docs found

UIWindowChange.move

Section titled “UIWindowChange.move”
UIWindowChange.move : unknown

no docs found

UIWindowChange.name(.)

Section titled “UIWindowChange.name(.)”
UIWindowChange.name(value : Any) : unknown

no docs found

WindowAlignH

Section titled “WindowAlignH”
import "luxe: ui/window.control" for WindowAlignH

no docs found

WindowAlignH.left

Section titled “WindowAlignH.left”
WindowAlignH.left : unknown

no docs found

WindowAlignH.center

Section titled “WindowAlignH.center”
WindowAlignH.center : unknown

no docs found

WindowAlignH.right

Section titled “WindowAlignH.right”
WindowAlignH.right : unknown

no docs found

WindowAlignV

Section titled “WindowAlignV”
import "luxe: ui/window.control" for WindowAlignV

no docs found

WindowAlignV.top

Section titled “WindowAlignV.top”
WindowAlignV.top : unknown

no docs found

WindowAlignV.center

Section titled “WindowAlignV.center”
WindowAlignV.center : unknown

no docs found

WindowAlignV.bottom

Section titled “WindowAlignV.bottom”
WindowAlignV.bottom : unknown

no docs found