Avorion Script API Documentation
UIContainer : UIElement
This object is only available on the client.
function UIContainer(int index)
Returns
A new instance of UIContainer
| 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 clear()
Returns
nothing
function AllianceEmblem createAllianceEmblem(Rect rect, int allianceIndex)
function ArrowLine createArrowLine()
function Button createButton(Rect rect, string caption, string function)
function CaptainIcon createCaptainIcon(Rect rect)
function CaptainProfile createCaptainProfile(Rect rect)
function CheckBox createCheckBox(Rect rect, string caption, string onCheckedFunction)
function ComboBox createComboBox(Rect rect, string onSelectedFunction)
function UIContainer createContainer(Rect rect)
function ContextMenu createContextMenu()
function CraftPortrait createCraftPortrait(Rect rect, string function)
function CrewBar createCrewBar(Rect rect)
function Frame createFrame(Rect rect)
function InputWindow createInputWindow()
function InventorySelection createInventorySelection(Rect rect, int width)
function Label createLabel(var position, string caption, int fontSize)
function Line createLine(vec2 a, vec2 b)
function ListBox createListBox(Rect rect)
function ListBoxEx createListBoxEx(Rect rect)
function MapArrowLine createMapArrowLine()
function MapIcon createMapIcon(string texture, ivec2 coordinates, Color [or nil] color)
function MultiLineTextBox createMultiLineTextBox(Rect rect)
function NumbersBar createNumbersBar(Rect rect)
function Picture createPicture(Rect rect, string path)
function PlanDisplayer createPlanDisplayer(Rect rect)
function ProgressBar createProgressBar(Rect rect, Color color)
function UIRect createRect(Rect rect, Color color)
function Button createRoundButton(Rect rect, string icon, string function)
function SavedDesignsSelection createSavedDesignsSelection(Rect rect, int width)
function ScrollFrame createScrollFrame(Rect rect)
function Selection createSelection(Rect rect, int width)
function Slider createSlider(Rect rect, int min, int max, int steps, string caption, string onValueChangedFunction)
function StatisticsBar createStatisticsBar(Rect rect, Color color)
function TabbedWindow createTabbedWindow(Rect rect)
function TextBox createTextBox(Rect rect, string onTextChangedFunction)
function TextField createTextField(Rect rect, string text)
function TooltipDisplayer createTooltipDisplayer(Rect rect)
function Tree createTree(Rect rect)
function ValueComboBox createValueComboBox(Rect rect, string onSelectedFunction)
function Window createWindow(Rect rect)
function var hide()
function bool isMouseOverAndUnobscured()
Inherited from UIElement
function var show()
Callbacks Alliance [Client] Callbacks Alliance [Server] Callbacks Alliance [Server] Callbacks Entity Callbacks Galaxy Callbacks Player Callbacks Player [Client] Callbacks Sector Callbacks Server Callbacks
Command Entity FactionDatabase PlanGenerator Player Sector Server UsableInventoryItem
Boarding BspTree CargoBay CargoLoot ControlUnit CrewComponent DeletionTimer DirectFlightPhysics DockingClamps DockingParent DockingPositions Durability EnergySystem Engine FighterAI Hangar HyperspaceEngine InteractionText InventoryItemLoot Owner Physics Plan ReadOnlyBoarding ReadOnlyBspTree ReadOnlyCargoBay ReadOnlyControlUnit ReadOnlyCrew ReadOnlyDeletionTimer ReadOnlyEnergySystem ReadOnlyEngine ReadOnlyFighterAI ReadOnlyHangar ReadOnlyHyperspaceEngine ReadOnlyInteractionText ReadOnlyOwner ReadOnlyPhysics ReadOnlyPlan ReadOnlyShipAI ReadOnlyShipSystem ReadOnlyTorpedoAI [Server] [Client] [Server] [Client] ReadOnlyTorpedoAI [Server] [Client] [Server] [Client] ReadOnlyTorpedoLauncher ReadOnlyTurretBases ReadOnlyVelocity ReadOnlyWeapons ReadOnlyWormHole Shield ShipAI ShipSystem StructuralIntegrity SystemUpgradeLoot Thrusters Torpedo TorpedoAI TorpedoLauncher Turret TurretAI TurretBases Velocity Weapons WormHole
AllianceMember AllianceRank BlockPlan BlockPlanBlock BlockStatistics Box Captain Color ControlUnitSeat CraftDesign CraftStatsOverview Crew CrewMan CrewProfession DebugInfo dvec2 dvec3 dvec4 Entity EntityDescriptor FighterTemplate Format GameSettings Group HighResolutionTimer Inventory InventoryTurret ivec2 ivec3 ivec4 Language Mail Material Matrix ModManager NamedFormat PlanBspTree PlanetSpecifics PlanGenerationStage PlanPart PlanStyle PlayerId PluralForm Profiler QuadTree Random Rarity Ray ReadOnlyEntity Rect Relation Scenario SectorView Seed Sphere Squad SystemUpgradeTemplate Timer Tooltip TooltipLine TorpedoShaft TorpedoTemplate TradingGood TurretDesign TurretDesignPart TurretTemplate UsableInventoryItem Uuid VanillaInventoryItem vec2 vec3 vec4 Version Weapon
EntityIcon EntityTooltip PlanMesh ReadOnlyIcon ReadOnlyPlanMesh ReadOnlyScriptUI ReadOnlyTooltip ScriptUI
Achievements Alliance [Client] CameraKeyFrame CaptainSelectionItem Client ClientSettings ColorSelectionItem CraftDesignSelectionItem Faction [Client] Galaxy [Client] GalaxyMap GameInput GlowFX IconSelectionItem InputWindow InventoryReferenceSelectionItem InventorySelectionItem Keyboard LaserFX Mouse Music PixelIconSelectionItem Planet Player [Client] PlayerWindow RefractionFX Sector [Client] SelectionItem ShipDatabaseEntry [Client] SoundSource StrategyState TargetIndicator TooltipRenderer TurretDesignSelectionItem
AllianceEmblem AllianceTab ArrowLine Button [Client] [Client] Button [Client] [Client] CaptainIcon CaptainProfile CheckBox ComboBox ContextMenu CraftPortrait CrewBar Frame Hud InventorySelection Label Line ListBox ListBoxEx MapArrowLine MapIcon MultiLineTextBox NumbersBar Picture PlanDisplayer ProgressBar SavedDesignsSelection ScrollFrame Selection ShipWindow Slider StatisticsBar Tab TabbedWindow TextBox TextField TooltipDisplayer Tree UIArbitraryHorizontalSplitter UIArbitraryVerticalSplitter UIContainer UIElement UIGridSplitter UIHorizontalLister UIHorizontalMultiSplitter UIHorizontalSplitter UIOrganizer UIRect UIRenderer UIVerticalLister UIVerticalMultiSplitter UIVerticalSplitter ValueComboBox Window
EntityTransferrer FighterController Loot ReadOnlyEntityTransferrer ReadOnlyFighterController ReadOnlyLoot ReadOnlyTurretController ReadOnlyWreckageCreator TurretController WreckageCreator
Alliance [Server] Faction [Server] Galaxy [Server] Player [Server] ReadOnlySector Sector [Server] Server ShipDatabaseEntry [Server]
AIState AlliancePrivilege BeamShape BlockShading BlockStructure BlockType BlockType2 BoxType BuildError CaptainGenderId ChatChannel ChatMessageType ComponentType ControlAction ControlActionBit ControlStyle CoolingType CraftStatsOverviewStat CrewProfessionType CrewRank DamageSource DamageType DeletionType Difficulty EntityArrivalType EntityType FighterOrders FighterStartError FighterType FontType ImpactParticles InventoryItemType JumpError KeyboardKey ListBoxEntryType MalusReason MaterialType MoonType MouseButton PlanetType PlayerStateType ProjectileShape RarityType RelationStatus SavedDesignType ScenarioType SectorChangeType ShipAvailability SoundType StatsBonuses TargetIndicatorVisuals TransformationFeature TurretAutoFireMode TurretSlotType WeaponAppearance WeaponCategory
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