Avorion Script API Documentation

FighterController

This object is only available on the server.

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

property Entity entity[read-only]
property uuid entityId[read-only]

function Entity... getDeployedFighters(var squad)

function var getFighterStartError(unsigned int squadIndex, var fighterIndex)

function FighterTemplate getFighterStatsOfType(FighterType type)

Returns a lightweight copy of the first fighter found of the type (ie. the next fighter that would be started when startFighterOfType() would be called). Lightweight copy means the FighterTemplate without the plan.

Parameters

type The type of fighter

Returns

A copy of the first fighter found to match the type, without plan

function var getFighterTypeStartError(FighterType type)

function var setSquadOrders(unsigned int squad, FighterOrders orders, Uuid targetId)

Returns

nothing

function Entity, int startFighter(unsigned int squadIndex, var fighterIndex)

function Entity, int startFighterOfType(FighterType type)

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: 2.5.7 c8e4beec84f7