This element allows you require other mods to be loaded and initialized prior to initializing this mod.
This element contains a text description of the mod
Removes a window and all of it’s children from the current UI.
The expandable listbox in HelpWindow will be our main example and reference for this tutorial and I’ll be ruthlessly copying and pasting its code into this page.
The DockableWindow provides basic window functionality and allows multiple DockableWindows to be joined together in one or more groups.
Returns the string name of the child window of the dockable window group
Returns the string name of the root window of the dockable window group
Returns the tab offset for the specified window.
Returns the string that is shown on the tab button for the dockable window.
Returns the string name of the top window of the dockable window group
Returns true if the window is a child of the root window
Sets if a dockable window’s tab should be shown (and drawn) on the screen.
Returns the string name of the child window of the dockable window group
Set’s the parent offset to use when the root window is deleted.
Set’s the Offset of the first tab from the left side of the window.
Sets if a dockable window’s tab should be shown (and drawn) on the screen.
Sets the text displayed on the button
Determines the existence of the specified window.
Name of the Button definition to use for the down button.
The offset for the DownButton from the bottom left of the scrollbar window.
This flag allow you to specify the draw order for the button.
When drawing this button, should the highlight state be drawn over-top the background image?
The DynamicImage provides a rectangular shaped display for a texture.
Returns if the image is currently displaying a valid texture.
Rotates the image arround it’s center.
Sets the texture displayed on this image.
Sets the explicit texture coordinates to be used for this image.
Sets the texture’s mirrored orientation for this dynamic image.
Sets the textureScale value.
Sets the slice to be displayed in this DynamicImage.
The EditBox is the generic text-input window element.
Returns the name of the font currently used.
Returns the input history for the EditBox.
Returns the text currently displayed.
Returns the current text color for the display.
Returns the text currently displayed.
Inserts text at the current cursor location.
Sets the font for the text display
Allows you to disable text from automatically being added to the EditBox display when a key is pressed.
Sets the input history for the edit box.
Sets the text currently displayed.
Sets the color for the text display.
This event is broadcast when the enter key processing has completed.
This event is broadcast when the enter key processing has completed.
All events are cached in the lua table in the format of SystemData.Events.EVENT_NAME
This is a step by step guide to creating the listbox of your dreams.
The number of degrees arround the circle to fill.
Allows you to specify the blend mode used for this texture when rendering.
First of all we need to create a .xml file that will contain the definition of our window, and a .lua file that will contain the basic code that the .xml file will be referencing to.
The FixedFontLabel is an extension of the Label element that restricts the font.
The name of the Font definition to use.
This element defines a font defintion.
Force anchor processing for all windows.
The name of a HorizontalResizeIMage definition for the foregroupd ‘filled’image.
The frames per second at which to play the animation
If true, does not render the middle middle section of the image.
The FullResizeImage allows you to create automatically tiling images to produce backgrounds and frame.
The FullResizeImage must be defined entirely in XML and does not have any run-time functions.
Returns if the UI is currently checking for circular dependencies.
Returns the data for the specified icon.
Returns if the Lua debug library will be loaded when reloading the UI
Returns the data for the specified map icon.
Returns the current screen resolution.
Returns a string from a string table with the substitution tags replaced by values in the params table.
Returns the specified string from a string table
Returns if lua-error handling is currently turned on.
Name of the HorizontalResizeImage definition to use for the background for the scroll area.
The gutter distance between each page.
Should the window element process mouse events?
Name of the UI Texture to use for the highlight image layer.
The size of the input history (tracked automatically when the enter key is pressed) to track.
The HorizontalResizeImage allows you to create an image that will automatically resize to fit a window of any width.
The HorizontalScrollbar is a combination window element that automates a scroll bar functionality.
Returns the line size.
Returns the maximum scroll position.
Returns the page size.
Returns the current scroll position
Sets the line size.
Sets the maximum scroll position
Sets the page size.
Sets the current scroll position
The HorizontalScrollWindow is a container window that provides a horizontal scrolling panel for all of it’s child windows.
Returns the current scroll position offset.
Sets the current scroll position offset.
Updates the childscrollwindow and scrollbar to reflect it’s current contents.