Avorion Script API Documentation
ControlUnit
function ControlUnit(var id)
Parameters
Returns
A new instance of ControlUnit
| property float desiredVelocity | [read-only] |
| property Entity entity | [read-only] |
| property uuid entityId | [read-only] |
| property bool hasPilot | [read-only] |
| property bool isBoosting | [read-only] |
| property bool isDrifting | [read-only] |
| property bool isStrafing | [read-only] |
| property bool isTurning | [read-only] |
| property int numFreeSeats | [read-only] |
| property int numOccupiedSeats | [read-only] |
| property vec3 turningSpeedFactor | [read-only] |
function var addSeat()
Returns
nothing
function var addSeatSquad(int seatIndex, int squad)
Returns
nothing
function var addSeatWeaponGroup(int seatIndex, int weaponGroup)
Returns
nothing
function var driftToLocation(vec3 location)
Returns
nothing
function var flyToLocation(vec3 location, float targetVelocity)
Returns
nothing
function bitset<10> getActiveWeapons()
function vec3 getAimedPositionBySeat(int seatIndex)
function vec3 getAimedPositionByWeaponGroup(int weaponGroup)
function vec3... getAimedPositions()
function int... getAllControlActions()
function int getControlActions(int seat)
function int getControlActionsByWeaponGroup(int weaponGroup)
function vec3 getFlownToLocation()
function float getRotationFactor(float dot, float cross)
function int getSeatByWeaponGroup(int weaponGroup)
function ControlUnitSeat... getSeats()
function Entity getSelectedObject(int seat)
function uuid getSelectedObjectId(int seat)
function uuid... getSelectedObjectIds()
function bool isFiring(int seat)
function bool isFiringTorpedoes(int seat)
function bool isPlayerAPilot(int playerIndex)
function bool mayControlSquad(int playerIndex, int squad)
function bool mayControlWeaponGroup(int playerIndex, int group)
function bool maySteer(int playerIndex)
function var removeSeat(int seat)
Returns
nothing
function bool rotatingNecessary(float brake, vec3 axis, vec3 from, vec3 to)
function var setAimedPosition(vec3 in, int seat)
Returns
nothing
function var setControlActions(int in, int seat)
Returns
nothing
function var setDesiredVelocity(float in)
Returns
nothing
function var setKeyDownMask(int mask, int seat)
Returns
nothing
function var setKeyUpMask(int mask, int seat)
Returns
nothing
function var setSelectedObjectId(Uuid in, int seat)
Returns
nothing
function var setTurningSpeedFactor(vec3 in)
Returns
nothing
function var stopShip()
Returns
nothing
function var stopSteering()
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 ControlUnit DeletionTimer DirectFlightPhysics DockingPositions Durability EnergySystem Engine FighterAI Hangar InteractionText Owner Physics Plan ReadOnlyBoarding ReadOnlyBspTree ReadOnlyCargoBay ReadOnlyControlUnit ReadOnlyDeletionTimer ReadOnlyEnergySystem ReadOnlyEngine ReadOnlyFighterAI ReadOnlyHangar ReadOnlyInteractionText ReadOnlyOwner ReadOnlyPhysics ReadOnlyPlan ReadOnlyShipAI ReadOnlyShipSystem ReadOnlyTorpedoAI [Server] [Client] [Server] [Client] ReadOnlyTorpedoAI [Server] [Client] [Server] [Client] ReadOnlyTorpedoLauncher ReadOnlyTurretBases ReadOnlyVelocity ReadOnlyWeapons ReadOnlyWormHole Shield ShipAI ShipSystem SystemUpgradeLoot Thrusters Torpedo TorpedoAI TorpedoLauncher Turret TurretAI TurretBases Velocity Weapons WormHole
AllianceMember AllianceRank BlockPlan BlockPlanBlock BlockStatistics Box Color ControlUnitSeat CraftDesign Crew CrewMan CrewProfession DebugInfo dvec2 dvec3 dvec4 Entity EntityDescriptor FighterTemplate Format GameSettings 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 SectorView Seed Sphere SystemUpgradeTemplate Timer Tooltip TooltipLine TorpedoTemplate TradingGood TurretDesign TurretDesignPart TurretTemplate UsableInventoryItem Uuid VanillaInventoryItem vec2 vec3 vec4 Version Weapon
EntityIcon EntityTooltip PlanMesh ReadOnlyIcon ReadOnlyPlanMesh ReadOnlyScriptUI ReadOnlyTooltip ScriptUI
Achievements Alliance [Client] ClientSettings CraftDesignSelectionItem Faction [Client] Galaxy [Client] GalaxyMap GameInput InputWindow InventoryReferenceSelectionItem InventorySelectionItem Keyboard LaserFX Mouse Music Planet Player [Client] PlayerWindow Sector [Client] SelectionItem SoundSource TooltipRenderer TurretDesignSelectionItem
AllianceTab ArrowLine Button [Client] [Client] Button [Client] [Client] CheckBox ComboBox CraftPortrait Frame Hud InventorySelection Label Line ListBox ListBoxEx MapArrowLine MultiLineTextBox NumbersBar Picture PlanDisplayer ProgressBar SavedDesignsSelection ScrollFrame Selection ShipWindow Slider StatisticsBar Tab TabbedWindow TextBox TextField 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
AIState AlliancePrivilege BeamShape BlockShading BlockType BoxType ChatChannel ChatMessageType ComponentType ControlAction ControlActionBit CoolingType CrewProfessionType DamageSource DamageType DeletionType Difficulty EntityArrivalType EntityType FighterOrders FighterStartError FighterType FontType ImpactParticles InventoryItemType KeyboardKey ListBoxEntryType MalusReason MaterialType MoonType MouseButton PlanetType PlayerStateType ProjectileShape RarityType RelationStatus SavedDesignType SectorChangeType SoundType StatsBonuses TransformationFeature TurretAutoFireMode 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: 1.0 r22021 59065310fc1a