_window.lua

--- @class window
--- @field public BGColor argb Background color
--- @field public Checked fun(): boolean Returns TRUE if the button has been checked
--- @field public Child window Child with this name
--- @field public Children fun(): boolean Returns TRUE if the window has children
--- @field public DoClose fun() Does the action of closing a window
--- @field public DoOpen fun() Does the action of opening a window
--- @field public Enabled fun(): boolean Returns TRUE if the window is enabled
--- @field public FirstChild window First child window
--- @field public Height fun(): number Height in pixels
--- @field public Highlighted boolean Returns TRUE if the window is highlighted
--- @field public HisTradeReady boolean Has the other person clicked the Trade button?
--- @field public HScrollMax fun(): number Horizontal scrollbar range
--- @field public HScrollPos fun(): number Horizontal scrollbar position
--- @field public HScrollPct fun(): number Horizontal scrollbar position in % to range from 0 to 100
--- @field public Items fun(): number Number of items in a Listbox or Combobox
--- @field public LeftMouseDown fun() Does the action of clicking the left mouse button down
--- @field public LeftMouseHeld fun() Does the action of holding the left mouse button
--- @field public LeftMouseHeldUp fun() does the action of holding the left mouse button up
--- @field public LeftMouseUp fun() Does the action of clicking the left mouse button up
--- @field public List fun(): string Get the text for the #th item in a list box. Only works on list boxes. Use of ,y is optional and allows selection of the column of the window to get text from or Find an item in a list box by partial match (use window.List[=text] for exact). Only works on list boxes. Use of ,y is optional and allows selection of the column of the window to search in.
--- @field public Minimized fun(): boolean Returns TRUE if the window is minimized
--- @field public MouseOver fun(): boolean Returns TRUE if the mouse is currently over the window
--- @field public MyTradeReady fun(): boolean Have I clicked the Trade button?
--- @field public Name fun(): string Name of window piece, e.g. "ChatWindow" for top level windows, or the piece name for child windows. Note: this is Custom UI dependent
--- @field public Next window Next sibling window
--- @field public Open fun(): boolean Returns TRUE if the window is open
--- @field public Parent window Parent window
--- @field public RightMouseDown fun() does the action of clicking the right mouse button
--- @field public RightMouseHeld fun() Does the action of holding the right mouse button
--- @field public RightMouseHeldUp fun() Does the action of holding the right mouse button up
--- @field public RightMouseUp fun() Does the action of clicking the right mouse button up
--- @field public Select fun() Selects the specified window
--- @field public ScreenID fun(): string ScreenID of window piece. Note: This is not Custom UI dependent, it must be the same on all UIs
--- @field public Siblings fun(): boolean Returns TRUE if the window has siblings
--- @field public Style fun(): number Window style code
--- @field public Text fun(): string Window's text
--- @field public Tooltip fun(): string TooltipReference text
--- @field public Type fun(): string Type of window piece (Screen for top level windows, or Listbox, Button, Gauge, Label, Editbox, Slider, etc)
--- @field public VScrollMax fun(): number Vertical scrollbar range
--- @field public VScrollPct fun(): number Vertical scrollbar position in % to range from 0 to 100
--- @field public VScrollPos fun(): number Vertical scrollbar position
--- @field public Width fun(): number Width in pixels
--- @field public X fun(): number Screen X position
--- @field public Y fun(): number Screen Y position
--- @field public ToString fun(): boolean TRUE if window exists, FALSE if not