Avorion Script API Documentation
ShipAI
function ShipAI(var id)
Parameters
Returns
A new instance of ShipAI
| property uuid attackedEntity | [read-only] |
| property Entity entity | [read-only] |
| property uuid entityId | [read-only] |
| property vec3 flyTarget | [read-only] |
| property bool isAttackingSomething | [read-only] |
| property bool isBusy | [read-only] |
| property bool isStuck | [read-only] |
| property int state | [read-only] |
function bool enemyFightersPresent()
function bool enemyShipsPresent(var countCivilEnemies)
function Entity... getEnemies()
function Entity... getEnemyFighters()
function Entity... getEnemyShips()
function Entity getNearestEnemy()
function uuid... getRegisteredEnemyEntities()
function int... getRegisteredEnemyFactions()
function uuid... getRegisteredFriendEntities()
function int... getRegisteredFriendFactions()
function bool isEnemy(Entity other)
function bool isEnemyPresent(var countCivilEnemies)
function bool isRegisteredEnemy(Entity other)
function bool isRegisteredFriend(Entity other)
function var registerEnemyEntity(Uuid index)
Returns
nothing
function var registerEnemyFaction(int index)
Returns
nothing
function var registerFriendEntity(Uuid index)
Returns
nothing
function var registerFriendFaction(int index)
Returns
nothing
function var setAggressive(var attackCivilShips, var canFinish)
Returns
nothing
function var setAttack(Entity entity)
Returns
nothing
function var setBoard(Entity entity)
Returns
nothing
function var setEscort(Entity entity)
Returns
nothing
function var setFly(vec3 location, float arrivalRadius, var collisionException)
Returns
nothing
function var setFlyLinear(vec3 location, float arrivalRadius, var avoidCollisions)
Returns
nothing
function var setFollow(Entity entity)
Returns
nothing
function var setGuard(vec3 location)
Returns
nothing
function var setHarvest(Entity entity)
Returns
nothing
function var setIdle()
Returns
nothing
function var setJump(int x, int y)
Returns
nothing
function var setPassive()
Returns
nothing
function var setPassiveShooting(bool in)
Returns
nothing
function var setPassiveTurning(vec3 location)
Returns
nothing
function var setRepair()
Returns
nothing
function var setRepairTarget(Entity entity)
Returns
nothing
function var setStatus(string status, string_pair... arguments)
Sets the status that will be set in the ship info and other places (eg. ships/fleet tab)
Parameters
arguments Set the string arguments (if format string is used) as vector of string_pair.
Returns
nothing
function var stop()
Returns
nothing
function var unregisterEnemyEntity(Uuid index)
Returns
nothing
function var unregisterEnemyFaction(int index)
Returns
nothing
function var unregisterFriendEntity(Uuid index)
Returns
nothing
function var unregisterFriendFaction(int index)
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