Avorion Script API Documentation

ListBoxEx : UIElement

This object is only available on the client.

function ListBoxEx(int index)

Returns

A new instance of ListBoxEx

property unsigned int columns
property bool empty[read-only]
property bool entriesSelectable
property int font[write-only]
property int fontSize
property bool headline[write-only]
property string onAddedFunction
property string onChangedFunction
property string onClearFunction
property string onRemoveFunction
property string onSelectFunction
property int rowHeight
property int rows[read-only]
property int scrollPosition
property int selected[read-only]
property var selectedValue[read-only]
property int size[read-only]
property vec2 center
property float height
property int index[read-only]
property int layer
property vec2 localCenter[read-only]
property vec2 localPosition[read-only]
property Rect localRect[read-only]
property vec2 lower
property bool mouseOver[read-only]
property vec2 position
property Rect rect
property vec2 size
property var tooltip
property int tooltipWidth[write-only]
property vec2 upper
property bool visible
property float width

function var addRow()

Returns

nothing

function var clampScrollPosition()

Returns

nothing

function var clear()

Returns

nothing

function var deselect()

Returns

nothing

function int getColumnWidth(unsigned int index)

function string, bool, bool, Color, var getEntry(unsigned int column, unsigned int row)

function var removeRow(int index)

Returns

nothing

function var select(int index)

Returns

nothing

function var selectNoCallback(int index)

Returns

nothing

function var selectValue(var value)

Returns

nothing

function var selectValueNoCallback(var value)

Returns

nothing

function var setColumnWidth(unsigned int index, int width)

Returns

nothing

function var setEntry(unsigned int column, unsigned int row, string text, bool bold, bool italic, Color color, var entryWidth, var align)

Returns

nothing

function var setEntryNoCallback(unsigned int column, unsigned int row, string text, bool bold, bool italic, Color color, var entryWidth, var align)

Returns

nothing

function var setEntryTooltip(unsigned int column, unsigned int row, string text)

Returns

nothing

function var setEntryType(unsigned int column, unsigned int row, int type)

Returns

nothing

function var setEntryValue(unsigned int column, unsigned int row, var value)

Returns

nothing

function var setTooltip(unsigned int row, string text)

Returns

nothing

function var hide()

Inherited from UIElement

Returns

nothing

function bool isMouseOverAndUnobscured()

Inherited from UIElement

function var show()

Inherited from UIElement

Returns

nothing

Overview
Home Functions Search
Search:

This is the official documentation for the scripting API of Avorion. This documentation is automatically generated and not necessarily complete. Depending on the context in which functions exist, some documentation such as descriptions, return values or variable names or types may be missing.

Work in Progress. Documentation of Avorion Version: 2.5.7 c8e4beec84f7