Avorion Script API Documentation

Home Functions Search
Search:
Hangar Hangar

Properties
entity
entityId
freeSpace
maxFighters
maxSquads
minFighters
numFighters
numSquads
numSupportedSquads
occupiedSpace
space

Member Functions
addFighter
addSquad
canLand
clear
collectAllFighters
fighterTypeMatchesSquad
getBlueprint
getFighter
getFighterDPS
getHighestMaterialInSquadMainCategory
getRandomStartPosition
getSquad
getSquadDPS
getSquadFighters
getSquadFighterType
getSquadFreeSlots
getSquadHasRawMinersOrSalvagers
getSquadId
getSquadMainWeaponCategory
getSquadMaxFighters
getSquadName
getSquads
moveFighterToSquad
moveSquad
removeFighter
removeSquad
setBlueprint
setSquad
setSquadName

Hangar

function Hangar(var id)

Parameters

id The id of the entity this component belongs to, or the entity itself, must be an id of an existing entity or nil for the entity in the current script context

Returns

A new instance of Hangar

property Entity entity[read-only]
property uuid entityId[read-only]
property float freeSpace[read-only]
property static int maxFighters[read-only]
property int maxSquads[read-only]
property static int minFighters[read-only]
property unsigned int numFighters[read-only]
property unsigned int numSquads[read-only]
property unsigned int numSupportedSquads[read-only]
property float occupiedSpace[read-only]
property static float space[read-only]

function var addFighter(unsigned int squad, FighterTemplate fighter)

Returns

nothing

function unsigned int addSquad(string name)

function bool canLand(Entity entity)

function var clear()

Returns

nothing

function var collectAllFighters()

Returns

nothing

function bool fighterTypeMatchesSquad(FighterTemplate fighter, unsigned int squadIndex)

function FighterTemplate getBlueprint(unsigned int squadIndex)

function FighterTemplate getFighter(unsigned int squadIndex, unsigned int fighterIndex)

function double getFighterDPS()

function Material getHighestMaterialInSquadMainCategory(unsigned int squadIndex)

function Matrix getRandomStartPosition()

function Squad getSquad(unsigned int index)

Returns a full squad. Caution: This function has to do a lot of copy operations and is slow.

Parameters

index The index of the squad to get

Returns

A Squad object containing the squad, or nil if no squad with the given index exists

function double getSquadDPS(unsigned int squadIndex)

function unsigned int getSquadFighters(unsigned int squadIndex)

function var getSquadFighterType(unsigned int squadIndex)

function unsigned int getSquadFreeSlots(unsigned int squadIndex)

function bool getSquadHasRawMinersOrSalvagers(unsigned int squadIndex)

function Uuid getSquadId(unsigned int squadIndex)

function var getSquadMainWeaponCategory(unsigned int squadIndex)

Returns the weapon type that most fighters of this squad are equipped with. Use this to determine if an AI controlled ship can use this squad to mine or salvage. In case mulitple weapon types are equally present a random one is returned.

function unsigned int getSquadMaxFighters(unsigned int squadIndex)

function var getSquadName(unsigned int squadIndex)

function unsigned int... getSquads()

function var moveFighterToSquad(unsigned int squadIndex, unsigned int fighterIndex, unsigned int newSquadIndex)

Returns

nothing

function var moveSquad(unsigned int squadIndex, unsigned int newSquadIndex)

Returns

nothing

function var removeFighter(unsigned int index, unsigned int squad)

Returns

nothing

function var removeSquad(unsigned int index)

Returns

nothing

function var setBlueprint(unsigned int squad, FighterTemplate [or nil] fighter)

Returns

nothing

function var setSquad(unsigned int index, Squad squad)

Sets a full squad. Caution: This function has to do a lot of copy operations and is slow.

Parameters

index The index of the squad to set
squad A Squad object that should be set as the given squad

Returns

nothing

function var setSquadName(unsigned int index, string newName)

Returns

nothing

Overview
Home Functions Search
Search:
Callbacks
Callbacks Alliance [Client] Callbacks Alliance [Server] Callbacks Alliance [Server] Callbacks Entity Callbacks Galaxy Callbacks Player Callbacks Player [Client] Callbacks Sector Callbacks Server Callbacks
Predefined Functions & Example Scripts
Command Entity FactionDatabase PlanGenerator Player Sector Server UsableInventoryItem
Common Components
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
Common Objects
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
Client Components
EntityIcon EntityTooltip PlanMesh ReadOnlyIcon ReadOnlyPlanMesh ReadOnlyScriptUI ReadOnlyTooltip ScriptUI
Client Objects
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
Client UI Objects
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
Server Components
EntityTransferrer FighterController Loot ReadOnlyEntityTransferrer ReadOnlyFighterController ReadOnlyLoot ReadOnlyTurretController ReadOnlyWreckageCreator TurretController WreckageCreator
Server Objects
Alliance [Server] Faction [Server] Galaxy [Server] Player [Server] ReadOnlySector Sector [Server] Server ShipDatabaseEntry [Server]
Enums
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

Work in Progress.

Copyright © 2025 Boxelware GmbH. All rights reserved.