Avorion Script API Documentation

ShipAI

function ShipAI(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 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

status a string that will be used as status, can be a format string for easier translation.

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

Overview
Home Functions Search
Search:

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