Avorion Script API Documentation

ControlUnit

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

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