Avorion Script API Documentation

ScrollFrame : UIContainer

This object is only available on the client.

function ScrollFrame(int index)

Returns

A new instance of ScrollFrame

property int paddingBottom[write-only]
property int paddingTop[write-only]
property int scrollSpeed[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 scroll(int numSteps)

Returns

nothing

function var clear()

Inherited from UIContainer

Returns

nothing

function AllianceEmblem createAllianceEmblem(Rect rect, int allianceIndex)

Inherited from UIContainer

function ArrowLine createArrowLine()

Inherited from UIContainer

function Button createButton(Rect rect, string caption, string function)

Inherited from UIContainer

function CaptainIcon createCaptainIcon(Rect rect)

Inherited from UIContainer

function CaptainProfile createCaptainProfile(Rect rect)

Inherited from UIContainer

function CheckBox createCheckBox(Rect rect, string caption, string onCheckedFunction)

Inherited from UIContainer

function ComboBox createComboBox(Rect rect, string onSelectedFunction)

Inherited from UIContainer

function UIContainer createContainer(Rect rect)

Inherited from UIContainer

function ContextMenu createContextMenu()

Inherited from UIContainer

function CraftPortrait createCraftPortrait(Rect rect, string function)

Inherited from UIContainer

function CrewBar createCrewBar(Rect rect)

Inherited from UIContainer

function Frame createFrame(Rect rect)

Inherited from UIContainer

function InputWindow createInputWindow()

Inherited from UIContainer

function InventorySelection createInventorySelection(Rect rect, int width)

Inherited from UIContainer

function Label createLabel(var position, string caption, int fontSize)

Inherited from UIContainer

function Line createLine(vec2 a, vec2 b)

Inherited from UIContainer

function ListBox createListBox(Rect rect)

Inherited from UIContainer

function ListBoxEx createListBoxEx(Rect rect)

Inherited from UIContainer

function MapArrowLine createMapArrowLine()

Inherited from UIContainer

function MapIcon createMapIcon(string texture, ivec2 coordinates, Color [or nil] color)

Inherited from UIContainer

function MultiLineTextBox createMultiLineTextBox(Rect rect)

Inherited from UIContainer

function NumbersBar createNumbersBar(Rect rect)

Inherited from UIContainer

function Picture createPicture(Rect rect, string path)

Inherited from UIContainer

function PlanDisplayer createPlanDisplayer(Rect rect)

Inherited from UIContainer

function ProgressBar createProgressBar(Rect rect, Color color)

Inherited from UIContainer

function UIRect createRect(Rect rect, Color color)

Inherited from UIContainer

function Button createRoundButton(Rect rect, string icon, string function)

Inherited from UIContainer

function SavedDesignsSelection createSavedDesignsSelection(Rect rect, int width)

Inherited from UIContainer

function ScrollFrame createScrollFrame(Rect rect)

Inherited from UIContainer

function Selection createSelection(Rect rect, int width)

Inherited from UIContainer

function Slider createSlider(Rect rect, int min, int max, int steps, string caption, string onValueChangedFunction)

Inherited from UIContainer

function StatisticsBar createStatisticsBar(Rect rect, Color color)

Inherited from UIContainer

function TabbedWindow createTabbedWindow(Rect rect)

Inherited from UIContainer

function TextBox createTextBox(Rect rect, string onTextChangedFunction)

Inherited from UIContainer

function TextField createTextField(Rect rect, string text)

Inherited from UIContainer

function TooltipDisplayer createTooltipDisplayer(Rect rect)

Inherited from UIContainer

function Tree createTree(Rect rect)

Inherited from UIContainer

function ValueComboBox createValueComboBox(Rect rect, string onSelectedFunction)

Inherited from UIContainer

function Window createWindow(Rect rect)

Inherited from UIContainer

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