Avorion Script API Documentation

Selection : UIElement

This object is only available on the client.

function Selection(int index)

Returns

A new instance of Selection

property bool dragFromEnabled[write-only]
property bool dropIntoEnabled[write-only]
property bool dropIntoSelfEnabled[write-only]
property bool entriesHighlightable[write-only]
property bool entriesSelectable[write-only]
property bool hasSelectedItemFrame
property bool isRenderingDraggedItem[read-only]
property unsigned int maxHorizontalEntries[read-only]
property int numEntries[read-only]
property string onClickedFunction
property string onDeselectedFunction
property string onDroppedFunction
property string onInsertedFunction
property string onReceivedFunction
property string onSelectedFunction
property float padding[write-only]
property UserObject selected[read-only]
property ivec2 selectedKey[read-only]
property bool showScrollBar[write-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 add(var item, var pos)

Returns

nothing

function var addEmpty(var pos)

Returns

nothing

function var addEmptyRows(int amount)

Returns

nothing

function var clear()

Returns

nothing

function var fillRow()

Returns

nothing

function var fillWithEmptyRows()

Returns

nothing

function UserObject getItem(ivec2 key)

function table<ivec2, UserObject> getItems()

function ivec2 getMouseOveredKey()

function int, Rect getRect(int x, int y)

function var remove(ivec2 key)

Returns

nothing

function var select(ivec2 pos)

Returns

nothing

function var selectNoCallback(ivec2 pos)

Returns

nothing

function var setCustomRects(table_t rects)

Returns

nothing

function var setFieldSize(float in)

Returns

nothing

function var setShowScrollArrows(bool showTop, bool showBottom, float width)

Returns

nothing

function var unselect()

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