Avorion Script API Documentation

CrewComponent

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

property int attackers[read-only]
property int autoAssignCrew[read-only]
property int engineers[read-only]
property int gunners[read-only]
property int maxSize[read-only]
property int mechanics[read-only]
property int miners[read-only]
property int pilots[read-only]
property int security[read-only]
property int size[read-only]
property int unemployed[read-only]

function var add(int amount, CrewMan crewman)

Returns

nothing

function var addPassenger(Captain captain)

Returns

nothing

function Crew buildIdealCrew(BlockPlan [or nil] plan)

function var, var, table<int, string> canAddCrew(int number, int profession, int change)

function var, var, table<int, string> canAddPassenger(var passenger)

function var changeEmployment(int amount, int profession)

Returns

nothing

function var clear()

Returns

nothing

function var clearPassengers()

Returns

nothing

function Captain getCaptain()

function table<CrewMan, unsigned int> getMembers()

function int getMembersByProfession(int profession)

function int getNumMembers(CrewMan crewman)

function Captain... getPassengers()

function table<CrewProfession, float> getWorkforce()

function bool hasCaptain(var captainClass)

function var kill(int num)

Returns

nothing

function var remove(int amount, CrewMan crewman)

Returns

nothing

function var removeByProfession(int amount, int crewProfessionType)

Returns

nothing

function var removePassenger(unsigned int index)

Returns

nothing

function var setCaptain(Captain [or nil] captain)

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