Avorion Script API Documentation
UIOrganizer
This object is only available on the client.
function UIOrganizer(var a, var b)
Expects either a Rect specifying the rect of this UI organizer for parameter a and nil for b, or a vec2 for a and a vec2 for b, specifying the lower and upper bounds for the UI organizer rect.
Examples:
UIOrganizer(Rect(0, 20, 150, 250))
UIOrganizer(vec2(0, 20), vec2(150, 250))
Parameters
b Nil if a is a Rect, or a vec2 if a is a vec2
Returns
A new instance of UIOrganizer
| 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
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
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
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
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
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
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
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
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
Returns
A copy of the given rect, aligned to the specific side
function UIElement placeElementBottom(UIElement element)
Aligns the given UI element to a specific side
Parameters
Returns
A reference to the given UI element
function UIElement placeElementBottomLeft(UIElement element)
Aligns the given UI element to a specific side
Parameters
Returns
A reference to the given UI element
function UIElement placeElementBottomRight(UIElement element)
Aligns the given UI element to a specific side
Parameters
Returns
A reference to the given UI element
function UIElement placeElementCenter(UIElement element)
Aligns the given UI element to a specific side
Parameters
Returns
A reference to the given UI element
function UIElement placeElementLeft(UIElement element)
Aligns the given UI element to a specific side
Parameters
Returns
A reference to the given UI element
function UIElement placeElementRight(UIElement element)
Aligns the given UI element to a specific side
Parameters
Returns
A reference to the given UI element
function UIElement placeElementTop(UIElement element)
Aligns the given UI element to a specific side
Parameters
Returns
A reference to the given UI element
function UIElement placeElementTopLeft(UIElement element)
Aligns the given UI element to a specific side
Parameters
Returns
A reference to the given UI element
function UIElement placeElementTopRight(UIElement element)
Aligns the given UI element to a specific side
Parameters
Returns
A reference to the given UI element
function var setMargin(int left, int right, int top, int bottom)
Parameters
right margin on the right side
top margin on the top side
bottom margin on the bottom side
Returns
nothing
function var setPadding(int left, int right, int top, int bottom)
Parameters
right padding on the right side
top padding on the top side
bottom padding on the bottom side
Returns
nothing
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