Avorion Script API Documentation

UIVerticalLister

This class gets a rect and aligns given elements in a list style inside the rect. Considers properties like margin and padding between the elements.

This object is only available on the client.

function UIVerticalLister(Rect rect, int padding, int margin)

Parameters

rect The rect in which the lister aligns its elenents
padding
margin

Returns

A new instance of UIVerticalLister

property Rect inner

[read-only]

property int margin

[write-only]

property int marginBottom

property int marginLeft

property int marginRight

property int marginTop

property int padding

[write-only]

property int paddingBottom

property int paddingLeft

property int paddingRight

property int paddingTop

property Rect rect

function Rect getBottomLeftRect(Rect rect)

Aligns the given rect to a specific side

Parameters

rect The given rect

Returns

A copy of the given rect, aligned to the specific side

function Rect getBottomRect(Rect rect)

Aligns the given rect to a specific side

Parameters

rect The given rect

Returns

A copy of the given rect, aligned to the specific side

function Rect getBottomRightRect(Rect rect)

Aligns the given rect to a specific side

Parameters

rect The given rect

Returns

A copy of the given rect, aligned to the specific side

function Rect getCenterRect(Rect rect)

Aligns the given rect to a specific side

Parameters

rect The given rect

Returns

A copy of the given rect, aligned to the specific side

function Rect getLeftRect(Rect rect)

Aligns the given rect to a specific side

Parameters

rect The given rect

Returns

A copy of the given rect, aligned to the specific side

function Rect getRightRect(Rect rect)

Aligns the given rect to a specific side

Parameters

rect The given rect

Returns

A copy of the given rect, aligned to the specific side

function Rect getTopLeftRect(Rect rect)

Aligns the given rect to a specific side

Parameters

rect The given rect

Returns

A copy of the given rect, aligned to the specific side

function Rect getTopRect(Rect rect)

Aligns the given rect to a specific side

Parameters

rect The given rect

Returns

A copy of the given rect, aligned to the specific side

function Rect getTopRightRect(Rect rect)

Aligns the given rect to a specific side

Parameters

rect The given rect

Returns

A copy of the given rect, aligned to the specific side

function var hasEnoughSpace(float vec)

Checks if there is enough space to fit a rect with the given height into the lister's remaining rect

Parameters

vec The size of the rect to test for

Returns

true if there's enough space, false if not

function Rect nextQuadraticRect()

function Rect nextRect(float height)

Returns the next rect of a certain height that would be created. The rect will have the full width of the rect given to the lister.

Parameters

height The height of the rect

Returns

The Rect

function UIElement placeCenter(vec2 vec)

Uses the given vector to create a Rect of size Rect(0, 0, vec.x, vec.y), places it in the list and centers it

Parameters

vec The given size of the rect to align

Returns

The aligned rect

function UIElement placeElementBottom(UIElement element)