window

This contains data related to the specified in-game window

Windows come in many forms, but all are represented with the generic window type. In some of the descriptions, a bold window type may be specified, which defines the behavior for that type of window.

Members

Type	Member	Description
argb	BGColor	Background color
bool	Checked	Returns TRUE if the button has been checked
window	Child[name]	Find a child window with the provided name
bool	Children	Returns TRUE if the window has children
window	CurrentTab	TabBox: Returns the Page window associated with the currently selected tab.
int	CurrentTabIndex	TabBox: Returns the index of the currently selected tab.
bool	Enabled	Returns TRUE if the window is enabled
window	FirstChild	First child window
int	GetCurSel	Index of the currently selected/highlighted item in a list or treeview
int	Height	Height in pixels
bool	Highlighted	Returns TRUE if the window is highlighted
bool	HisTradeReady	Has the other person clicked the Trade button?
int	HScrollMax	Horizontal scrollbar range
int	HScrollPos	Horizontal scrollbar position
int	HScrollPct	Horizontal scrollbar position in % to range from 0 to 100
int	Items	Number of items in a Listbox or Combobox
string	List[N,y]	Get the text for the Nth 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.
int	List[text,y]	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.
bool	Minimized	Returns TRUE if the window is minimized
bool	MouseOver	Returns TRUE if the mouse is currently over the window
bool	MyTradeReady	Have I clicked the Trade button?
string	Name	Name of window piece, e.g. "ChatWindow" for top level windows, or the piece name for child windows. Note: this is custom ui dependent
window	Next	Next sibling window
bool	Open	Returns TRUE if the window is open
window	Parent	Parent window
string	ScreenID	ScreenID of window piece. Note: This is not custom ui dependent, it must be the same on all UIs
bool	Siblings	Returns TRUE if the window has siblings
int	Style	Window style code
int	TabCount	TabBox: The number of tabs present in the TabBox.
window	Tab [#/Name]	TabBox: Looks up the Page window that matches the provided index or tab text.
string	Text	Window's text. STMLBox: returns the contents of the STML. Page: returns the name of the page's Tab.
string	Tooltip	TooltipReference text
string	Type	Type of window piece (Screen for top level windows, or Listbox, Button, Gauge, Label, Editbox, Slider, etc)
int	VScrollMax	Vertical scrollbar range
int	VScrollPct	Vertical scrollbar position in % to range from 0 to 100
int	VScrollPos	Vertical scrollbar position
int	Width	Width in pixels
int	X	Screen X position
int	Y	Screen Y position
string	To String	TRUE if window exists, FALSE if not

Methods

Name	Action
DoClose	Does the action of closing a window
DoOpen	Does the action of opening a window
LeftMouseDown	Does the action of clicking the left mouse button down
LeftMouseHeld	Does the action of holding the left mouse button
LeftMouseHeldUp	does the action of holding the left mouse button up
LeftMouseUp	Does the action of clicking the left mouse button up
RightMouseDown	does the action of clicking the right mouse button
RightMouseHeld	Does the action of holding the right mouse button
RightMouseHeldUp	Does the action of holding the right mouse button up
RightMouseUp	Does the action of clicking the right mouse button up
Select	Selects the specified window
SetCurrentTab [ # or Name ]	If the window is a TabBox, set the current tab by index or by name.

Usage

/invoke ${Window[MerchantWnd].DoOpen}

Expected Result: the Merchant window window appears

/echo ${Window[MerchantWnd].Open}

Returns TRUE if a Merchant window is open

/echo ${Window[windowname]}

Returns TRUE if the WindowName exists, but doesn't have to be opened.

/echo ${Window[MerchantWnd].Minimized}

Returns TRUE if the Window is opened and minimized

/echo ${Window[MerchantWnd/ItemList].List[=Water Flask,2]}

Returns the index (int) of Water Flask in the merchant's item list. ",2" means scan the second column, since that's where the item names are.

${Window[TradeskillWnd/RecipeList].List[=Inky Shadow Silk]}

Find an item in the tradeskill item list box by the exact name Inky Shadow Silk

${Window[TradeskillWnd/RecipeList].List[1]}

Get the first-column text for the 1^st item in the tradeskill item list box

${Window[tradewnd].HisTradeReady}

Return TRUE if the other person has clicked the Trade button in the Trade Window

${Window[tradewnd].MyTradeReady}

Return TRUE if I have clicked the Trade button in the Trade Window (TradeWnd)

${Window[RewardSelectionWnd/RewardPageTabWindow].Tab[Brew for the Day].Child[RewardSelectionOptionList].List[2]}

Returns the name of the 2^nd option in the list of rewards for the tab titled "Brew for the Day"