1305 lines
46 KiB
HTML
1305 lines
46 KiB
HTML
<html>
|
|
<head>
|
|
<title> ControlUnit</title>
|
|
<link rel="stylesheet" href="stylesheet.css"/>
|
|
<meta charset="utf-8"/>
|
|
</head>
|
|
<body>
|
|
<div class="maincentered">
|
|
<div class="maincontent">
|
|
<h1 class="documentationheader">Avorion Script API Documentation</h1>
|
|
<div class="sitemap">
|
|
<div class="headerlisting flexheader">
|
|
<div>
|
|
<a href="index.html">Home</a>
|
|
<a href="Functions.html">Functions</a>
|
|
<a href="Search.html">Search</a>
|
|
</div>
|
|
<div class="flexheaderwhitespace"></div>
|
|
<form action="Search.html" method="get">Search:<input name="search" class="headersearchinput" type="search"></form></div></div>
|
|
<div class="floatleft">
|
|
<div class="codecontainer">
|
|
<table>
|
|
<tr>
|
|
<td>
|
|
<a class="type" href="ControlUnit.html">ControlUnit</a>
|
|
<a class="function" href="#ControlUnit">ControlUnit</a>
|
|
</td>
|
|
</tr>
|
|
<tr><td><br/></td></tr>
|
|
<tr><td><span class="docheader">Properties</span></td></tr>
|
|
<tr><td>
|
|
<a href="#autoPilotEnabled">autoPilotEnabled</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#desiredVelocity">desiredVelocity</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#entity">entity</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#entityId">entityId</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#hasPilot">hasPilot</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isBoosting">isBoosting</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isDrifting">isDrifting</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isStrafing">isStrafing</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isTurning">isTurning</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#numFreeSeats">numFreeSeats</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#numOccupiedSeats">numOccupiedSeats</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#turningSpeedFactor">turningSpeedFactor</a>
|
|
</td></tr>
|
|
<tr><td><br/></td></tr>
|
|
<tr><td><span class="docheader">Member Functions</span></td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#addSeat">addSeat</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#addSeatSquad">addSeatSquad</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#addSeatWeaponGroup">addSeatWeaponGroup</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#driftToLocation">driftToLocation</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#flyToLocation">flyToLocation</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getActiveWeapons">getActiveWeapons</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getAimedPositionBySeat">getAimedPositionBySeat</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getAimedPositionByWeaponGroup">getAimedPositionByWeaponGroup</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getAimedPositions">getAimedPositions</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getAllControlActions">getAllControlActions</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getControlActions">getControlActions</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getControlActionsByWeaponGroup">getControlActionsByWeaponGroup</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getFlownToLocation">getFlownToLocation</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getSeatByWeaponGroup">getSeatByWeaponGroup</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getSeats">getSeats</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getSelectedObject">getSelectedObject</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getSelectedObjectId">getSelectedObjectId</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getSelectedObjectIds">getSelectedObjectIds</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#isFiring">isFiring</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#isFiringTorpedoes">isFiringTorpedoes</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#isPlayerAPilot">isPlayerAPilot</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#mayControlSquad">mayControlSquad</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#mayControlWeaponGroup">mayControlWeaponGroup</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#maySteer">maySteer</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#removeSeat">removeSeat</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#setAimedPosition">setAimedPosition</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#setControlActions">setControlActions</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#setDesiredVelocity">setDesiredVelocity</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#setKeyDownMask">setKeyDownMask</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#setKeyUpMask">setKeyUpMask</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#setSelectedObjectId">setSelectedObjectId</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#setTurningSpeedFactor">setTurningSpeedFactor</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#stopShip">stopShip</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#stopSteering">stopSteering</a>
|
|
</td></tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="floatright">
|
|
<h1>ControlUnit</h1>
|
|
<div id="ControlUnit" class="codecontainer">
|
|
<div id="ControlUnit" class="function">
|
|
<p>
|
|
<span class="keyword">function </span> ControlUnit(<span class="type">var</span> <span class="parameter">id</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="ControlUnit" class="">
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">id</span>
|
|
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 <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
A new instance of ControlUnit
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="Properties" class="codecontainer">
|
|
<div id="autoPilotEnabled">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">autoPilotEnabled</span></td><td align="right"></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="desiredVelocity">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span class="property">desiredVelocity</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
The current velocity the ship is trying to fly from 0 to 1, where 0 means standstill and 1 means the maximum speed the ship can fly without boosting.
|
|
</div>
|
|
</div>
|
|
<div id="entity">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">Entity </span> <span class="property">entity</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="entityId">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">uuid </span> <span class="property">entityId</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="hasPilot">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">hasPilot</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="isBoosting">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">isBoosting</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="isDrifting">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">isDrifting</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="isStrafing">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">isStrafing</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="isTurning">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">isTurning</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="numFreeSeats">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span class="property">numFreeSeats</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="numOccupiedSeats">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span class="property">numOccupiedSeats</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="turningSpeedFactor">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">vec3 </span> <span class="property">turningSpeedFactor</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
A vec3 containing the turning speed multipliers for axis x, y, z. The turning speed factor is a multiplier for the turning speed of a ship, and is set in flyToLocation(), to smoothen turning once the ship looks towards its target (to avoid jittering).
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="addSeat" class="codecontainer">
|
|
<div id="addSeat" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addSeat() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="addSeat" class="">
|
|
<p>
|
|
Adds a new seat.
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addSeatSquad" class="codecontainer">
|
|
<div id="addSeatSquad" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addSeatSquad(<span class="type">int</span> <span class="parameter">seatIndex</span>, <span class="type">int</span> <span class="parameter">fighterSquadIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="addSeatSquad" class="">
|
|
<p>
|
|
Adds a new fighter squad for a given seat.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">seatIndex</span>
|
|
The index of the seat (0-9) <br/>
|
|
<span class="parameter">fighterSquadIndex</span>
|
|
The index of the fighter squad (0-9) <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addSeatWeaponGroup" class="codecontainer">
|
|
<div id="addSeatWeaponGroup" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addSeatWeaponGroup(<span class="type">int</span> <span class="parameter">seatIndex</span>, <span class="type">int</span> <span class="parameter">weaponGroupIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="addSeatWeaponGroup" class="">
|
|
<p>
|
|
Adds a new weapon group for a given seat.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">seatIndex</span>
|
|
The index of the seat (0-9) <br/>
|
|
<span class="parameter">weaponGroupIndex</span>
|
|
The index of the weapon group (0-9) <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="driftToLocation" class="codecontainer">
|
|
<div id="driftToLocation" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> driftToLocation(<span class="type">vec3</span> <span class="parameter">location</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="driftToLocation" class="">
|
|
<p>
|
|
Executes the button presses necessary to have the ship drift to the target location. Drifting to a location means using only thrusters and not the main engine. This function must be called every tick in order to work correctly.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">location</span>
|
|
The target location to drift towards. <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="flyToLocation" class="codecontainer">
|
|
<div id="flyToLocation" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> flyToLocation(<span class="type">vec3</span> <span class="parameter">location</span>, <span class="type">float</span> <span class="parameter">velocityAtTarget</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="flyToLocation" class="">
|
|
<p>
|
|
Executes the button presses necessary to have the ship turn and fly to the target location. This function must be called every tick in order to work correctly.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">location</span>
|
|
The target location to fly towards <br/>
|
|
<span class="parameter">velocityAtTarget</span>
|
|
The physical velocity that the ship should have when arriving at its destination. Use real velocity (m/s) here, not desired velocity (0% - 100%) <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getActiveWeapons" class="codecontainer">
|
|
<div id="getActiveWeapons" class="function">
|
|
<p>
|
|
<span class="keyword">function bitset<10></span> getActiveWeapons() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getActiveWeapons" class="">
|
|
<p>
|
|
Returns a list of bools representing the currently active weapon groups.
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getAimedPositionBySeat" class="codecontainer">
|
|
<div id="getAimedPositionBySeat" class="function">
|
|
<p>
|
|
<span class="keyword">function vec3</span> getAimedPositionBySeat(<span class="type">int</span> <span class="parameter">seatIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getAimedPositionBySeat" class="">
|
|
<p>
|
|
Returns the aimed position of a given seat.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">seatIndex</span>
|
|
The index of the seat <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getAimedPositionByWeaponGroup" class="codecontainer">
|
|
<div id="getAimedPositionByWeaponGroup" class="function">
|
|
<p>
|
|
<span class="keyword">function vec3</span> getAimedPositionByWeaponGroup(<span class="type">int</span> <span class="parameter">groupIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getAimedPositionByWeaponGroup" class="">
|
|
<p>
|
|
Returns the aimed position of the seat that controls the given weapon group.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">groupIndex</span>
|
|
The weapon group of the seat <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getAimedPositions" class="codecontainer">
|
|
<div id="getAimedPositions" class="function">
|
|
<p>
|
|
<span class="keyword">function vec3...</span> getAimedPositions() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getAimedPositions" class="">
|
|
<p>
|
|
Returns a list of aimed positions of all seats
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getAllControlActions" class="codecontainer">
|
|
<div id="getAllControlActions" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getAllControlActions() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getAllControlActions" class="">
|
|
<p>
|
|
Returns a list of bitsets (represented as ints) of control actions of all seats.
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getControlActions" class="codecontainer">
|
|
<div id="getControlActions" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> getControlActions(<span class="type">int</span> <span class="parameter">seatIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getControlActions" class="">
|
|
<p>
|
|
Returns the bitset of control actions of a given seat.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">seatIndex</span>
|
|
The index of the seat <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getControlActionsByWeaponGroup" class="codecontainer">
|
|
<div id="getControlActionsByWeaponGroup" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> getControlActionsByWeaponGroup(<span class="type">int</span> <span class="parameter">groupIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getControlActionsByWeaponGroup" class="">
|
|
<p>
|
|
Returns the bitset of control actions of the seat that controls the given weapon group.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">groupIndex</span>
|
|
The weapon group of the seat <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getFlownToLocation" class="codecontainer">
|
|
<div id="getFlownToLocation" class="function">
|
|
<p>
|
|
<span class="keyword">function vec3</span> getFlownToLocation() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getFlownToLocation" class="">
|
|
<p>
|
|
Returns the currently flown to location, which is set by calls to flyToLocation. Note: When the AI flies towards a location, it also sets this.
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getSeatByWeaponGroup" class="codecontainer">
|
|
<div id="getSeatByWeaponGroup" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> getSeatByWeaponGroup(<span class="type">int</span> <span class="parameter">groupIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getSeatByWeaponGroup" class="">
|
|
<p>
|
|
Returns the seat that controls a particular weapon group.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">groupIndex</span>
|
|
The weapon group of the seat <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getSeats" class="codecontainer">
|
|
<div id="getSeats" class="function">
|
|
<p>
|
|
<span class="keyword">function ControlUnitSeat...</span> getSeats() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getSeats" class="">
|
|
<p>
|
|
Returns a list of seats of the control unit.
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getSelectedObject" class="codecontainer">
|
|
<div id="getSelectedObject" class="function">
|
|
<p>
|
|
<span class="keyword">function Entity</span> getSelectedObject(<span class="type">int</span> <span class="parameter">seatIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getSelectedObject" class="">
|
|
<p>
|
|
Returns the selected object of a given seat.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">seatIndex</span>
|
|
The index of the seat <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getSelectedObjectId" class="codecontainer">
|
|
<div id="getSelectedObjectId" class="function">
|
|
<p>
|
|
<span class="keyword">function uuid</span> getSelectedObjectId(<span class="type">int</span> <span class="parameter">seatIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getSelectedObjectId" class="">
|
|
<p>
|
|
Returns the id of the selected object of a given seat.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">seatIndex</span>
|
|
The index of the seat <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getSelectedObjectIds" class="codecontainer">
|
|
<div id="getSelectedObjectIds" class="function">
|
|
<p>
|
|
<span class="keyword">function uuid...</span> getSelectedObjectIds() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getSelectedObjectIds" class="">
|
|
<p>
|
|
Returns a list of selected target ids of all seats
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isFiring" class="codecontainer">
|
|
<div id="isFiring" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> isFiring(<span class="type">int</span> <span class="parameter">seat</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="isFiring" class="">
|
|
<p>
|
|
Checks if the given seat is currently pushing "Fire" (see ControlActionBit.Fire1)
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isFiringTorpedoes" class="codecontainer">
|
|
<div id="isFiringTorpedoes" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> isFiringTorpedoes(<span class="type">int</span> <span class="parameter">seat</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="isFiringTorpedoes" class="">
|
|
<p>
|
|
Checks if the given seat is currently pushing "Fire Torpedoes" (see ControlActionBit.Fire2)
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isPlayerAPilot" class="codecontainer">
|
|
<div id="isPlayerAPilot" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> isPlayerAPilot(<span class="type">int</span> <span class="parameter">playerIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="isPlayerAPilot" class="">
|
|
<p>
|
|
Checks if the given player is setting in any seat of the control unit.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">playerIndex</span>
|
|
The index of the player <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="mayControlSquad" class="codecontainer">
|
|
<div id="mayControlSquad" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> mayControlSquad(<span class="type">int</span> <span class="parameter">playerIndex</span>, <span class="type">int</span> <span class="parameter">squadIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="mayControlSquad" class="">
|
|
<p>
|
|
Checks if the given player has the right to control the given fighter squad.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">playerIndex</span>
|
|
The index of the player <br/>
|
|
<span class="parameter">squadIndex</span>
|
|
The index of the squad <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="mayControlWeaponGroup" class="codecontainer">
|
|
<div id="mayControlWeaponGroup" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> mayControlWeaponGroup(<span class="type">int</span> <span class="parameter">playerIndex</span>, <span class="type">int</span> <span class="parameter">groupIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="mayControlWeaponGroup" class="">
|
|
<p>
|
|
Checks if the given player has the right to control the given weapon group.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">playerIndex</span>
|
|
The index of the player <br/>
|
|
<span class="parameter">groupIndex</span>
|
|
The index of the weapon group <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="maySteer" class="codecontainer">
|
|
<div id="maySteer" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> maySteer(<span class="type">int</span> <span class="parameter">playerIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="maySteer" class="">
|
|
<p>
|
|
Checks if the given player has the right to pilot (steer) the ship. The player must be sitting in the pilot seat.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">playerIndex</span>
|
|
The index of the player <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeSeat" class="codecontainer">
|
|
<div id="removeSeat" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeSeat(<span class="type">int</span> <span class="parameter">seatIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="removeSeat" class="">
|
|
<p>
|
|
Removes the given seat. Seat 0 can't be removed.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">seatIndex</span>
|
|
The seat index between 1 and the amount of seats minus 1 <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setAimedPosition" class="codecontainer">
|
|
<div id="setAimedPosition" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setAimedPosition(<span class="type">vec3</span> <span class="parameter">location</span>, <span class="type">int</span> <span class="parameter">seatIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setAimedPosition" class="">
|
|
<p>
|
|
Sets the current position that the non-independent turrets of the ship should aim at. This is, for example, what is set when the player aims.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">location</span>
|
|
The location that the turrets should aim at <br/>
|
|
<span class="parameter">seatIndex</span>
|
|
The seat that the position should be set for <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setControlActions" class="codecontainer">
|
|
<div id="setControlActions" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setControlActions(<span class="type">int</span> <span class="parameter">mask</span>, <span class="type">int</span> <span class="parameter">seatIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setControlActions" class="">
|
|
<p>
|
|
Sets the current control actions of the ship. A control action is basically a virtual button that is pressed on the control unit.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">mask</span>
|
|
A bitset of buttons that are pressed (see ControlActionBit) <br/>
|
|
<span class="parameter">seatIndex</span>
|
|
The seat that the control actions should be set for <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setDesiredVelocity" class="codecontainer">
|
|
<div id="setDesiredVelocity" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setDesiredVelocity(<span class="type">float</span> <span class="parameter">desiredVelocity</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setDesiredVelocity" class="">
|
|
<p>
|
|
Sets the desired velocity of the ship. Desired velocity is measured from 0 (standstill) to 1 (maximum speed the ship can fly). The engine of the ship will accelerate normally until the desired velocity is reached. This will not influence boosting.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">desiredVelocity</span>
|
|
The desired velocity to use (0 to 1) <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setKeyDownMask" class="codecontainer">
|
|
<div id="setKeyDownMask" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setKeyDownMask(<span class="type">int</span> <span class="parameter">mask</span>, <span class="type">int</span> <span class="parameter">seatIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setKeyDownMask" class="">
|
|
<p>
|
|
Enables control actions of the ship. A control action is basically a virtual button that is pressed on the control unit. This function presses them (as in: pushes them down).
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">mask</span>
|
|
A bitset of buttons that are pressed (see ControlActionBit) <br/>
|
|
<span class="parameter">seatIndex</span>
|
|
The seat that the control actions should be set for <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setKeyUpMask" class="codecontainer">
|
|
<div id="setKeyUpMask" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setKeyUpMask(<span class="type">int</span> <span class="parameter">mask</span>, <span class="type">int</span> <span class="parameter">seatIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setKeyUpMask" class="">
|
|
<p>
|
|
Disables control actions of the ship. A control action is basically a virtual button that is pressed on the control unit. This function releases them.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">mask</span>
|
|
A bitset of buttons that are released (see ControlActionBit) <br/>
|
|
<span class="parameter">seatIndex</span>
|
|
The seat that the control actions should be set for <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setSelectedObjectId" class="codecontainer">
|
|
<div id="setSelectedObjectId" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setSelectedObjectId(<span class="type">Uuid</span> <span class="parameter">location</span>, <span class="type">int</span> <span class="parameter">seatIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setSelectedObjectId" class="">
|
|
<p>
|
|
Sets the current position that the non-independent turrets of the ship should aim at. This is, for example, what is set when the player aims.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">location</span>
|
|
The location that the turrets should aim at <br/>
|
|
<span class="parameter">seatIndex</span>
|
|
The seat that the position should be set for <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setTurningSpeedFactor" class="codecontainer">
|
|
<div id="setTurningSpeedFactor" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setTurningSpeedFactor(<span class="type">vec3</span> <span class="parameter">factor</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setTurningSpeedFactor" class="">
|
|
<p>
|
|
Sets the current turning speed factor. The turning speed factor is a multiplier for the turning speed of a ship, used in flyToLocation(), to smoothen turning once the ship looks towards its target (to avoid jittering). It is set during flyToLocation(), so make sure to set it to (1, 1, 1) if you want to control the ship yourself.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">factor</span>
|
|
A vec3 containing the turning speed multipliers for axis x, y, z <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="stopShip" class="codecontainer">
|
|
<div id="stopShip" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> stopShip() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="stopShip" class="">
|
|
<p>
|
|
Releases all buttons and sets the ship's desired velocity to 0.
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="stopSteering" class="codecontainer">
|
|
<div id="stopSteering" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> stopSteering() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="stopSteering" class="">
|
|
<p>
|
|
Releases all buttons but keeps the ship's desired velocity.
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sitemap">
|
|
<div class="flexheader"> <div class="headerlisting">
|
|
<span class="docheader">Overview</span>
|
|
<br> <a href="index.html">Home</a>
|
|
<a href="Functions.html">Functions</a>
|
|
<a href="Search.html">Search</a>
|
|
</div> <div class="flexheaderwhitespace"></div>
|
|
<form action="Search.html" method="get"> Search:<input name="search" class="headersearchinput" type="search"> </form></div><div class="headerlisting">
|
|
<span class="docheader">Callbacks</span>
|
|
<br><a href="Callbacks.html"> Callbacks</a>
|
|
<a href="Alliance [Client] Callbacks.html">Alliance [Client] Callbacks</a>
|
|
<a href="Alliance [Server] Callbacks.html">Alliance [Server] Callbacks</a>
|
|
<a href="Alliance [Server] Callbacks.html">Alliance [Server] Callbacks</a>
|
|
<a href="Entity Callbacks.html">Entity Callbacks</a>
|
|
<a href="Galaxy Callbacks.html">Galaxy Callbacks</a>
|
|
<a href="Player Callbacks.html">Player Callbacks</a>
|
|
<a href="Player [Client] Callbacks.html">Player [Client] Callbacks</a>
|
|
<a href="Sector Callbacks.html">Sector Callbacks</a>
|
|
<a href="Server Callbacks.html">Server Callbacks</a>
|
|
</div><div class="headerlisting">
|
|
<span class="docheader">Predefined Functions & Example Scripts</span>
|
|
<br><a href="CommandFunctions.html">Command</a>
|
|
<a href="EntityFunctions.html">Entity</a>
|
|
<a href="FactionDatabaseFunctions.html">FactionDatabase</a>
|
|
<a href="PlanGeneratorFunctions.html">PlanGenerator</a>
|
|
<a href="PlayerFunctions.html">Player</a>
|
|
<a href="SectorFunctions.html">Sector</a>
|
|
<a href="ServerFunctions.html">Server</a>
|
|
<a href="UsableInventoryItemFunctions.html">UsableInventoryItem</a>
|
|
</div><div class="headerlisting">
|
|
<span class="docheader">Common Components</span>
|
|
<br><a href="Boarding.html">Boarding</a>
|
|
<a href="BspTree.html">BspTree</a>
|
|
<a href="CargoBay.html">CargoBay</a>
|
|
<a href="CargoLoot.html">CargoLoot</a>
|
|
<a href="ControlUnit.html">ControlUnit</a>
|
|
<a href="CrewComponent.html">CrewComponent</a>
|
|
<a href="DeletionTimer.html">DeletionTimer</a>
|
|
<a href="DirectFlightPhysics.html">DirectFlightPhysics</a>
|
|
<a href="DockingClamps.html">DockingClamps</a>
|
|
<a href="DockingParent.html">DockingParent</a>
|
|
<a href="DockingPositions.html">DockingPositions</a>
|
|
<a href="Durability.html">Durability</a>
|
|
<a href="EnergySystem.html">EnergySystem</a>
|
|
<a href="Engine.html">Engine</a>
|
|
<a href="FighterAI.html">FighterAI</a>
|
|
<a href="Hangar.html">Hangar</a>
|
|
<a href="HyperspaceEngine.html">HyperspaceEngine</a>
|
|
<a href="InteractionText.html">InteractionText</a>
|
|
<a href="InventoryItemLoot.html">InventoryItemLoot</a>
|
|
<a href="Owner.html">Owner</a>
|
|
<a href="Physics.html">Physics</a>
|
|
<a href="Plan.html">Plan</a>
|
|
<a href="ReadOnlyBoarding.html">ReadOnlyBoarding</a>
|
|
<a href="ReadOnlyBspTree.html">ReadOnlyBspTree</a>
|
|
<a href="ReadOnlyCargoBay.html">ReadOnlyCargoBay</a>
|
|
<a href="ReadOnlyControlUnit.html">ReadOnlyControlUnit</a>
|
|
<a href="ReadOnlyCrew.html">ReadOnlyCrew</a>
|
|
<a href="ReadOnlyDeletionTimer.html">ReadOnlyDeletionTimer</a>
|
|
<a href="ReadOnlyEnergySystem.html">ReadOnlyEnergySystem</a>
|
|
<a href="ReadOnlyEngine.html">ReadOnlyEngine</a>
|
|
<a href="ReadOnlyFighterAI.html">ReadOnlyFighterAI</a>
|
|
<a href="ReadOnlyHangar.html">ReadOnlyHangar</a>
|
|
<a href="ReadOnlyHyperspaceEngine.html">ReadOnlyHyperspaceEngine</a>
|
|
<a href="ReadOnlyInteractionText.html">ReadOnlyInteractionText</a>
|
|
<a href="ReadOnlyOwner.html">ReadOnlyOwner</a>
|
|
<a href="ReadOnlyPhysics.html">ReadOnlyPhysics</a>
|
|
<a href="ReadOnlyPlan.html">ReadOnlyPlan</a>
|
|
<a href="ReadOnlyShipAI.html">ReadOnlyShipAI</a>
|
|
<a href="ReadOnlyShipSystem.html">ReadOnlyShipSystem</a>
|
|
<a href="ReadOnlyTorpedoAI [Server] [Client] [Server] [Client].html">ReadOnlyTorpedoAI [Server] [Client] [Server] [Client]</a>
|
|
<a href="ReadOnlyTorpedoAI [Server] [Client] [Server] [Client].html">ReadOnlyTorpedoAI [Server] [Client] [Server] [Client]</a>
|
|
<a href="ReadOnlyTorpedoLauncher.html">ReadOnlyTorpedoLauncher</a>
|
|
<a href="ReadOnlyTurretBases.html">ReadOnlyTurretBases</a>
|
|
<a href="ReadOnlyVelocity.html">ReadOnlyVelocity</a>
|
|
<a href="ReadOnlyWeapons.html">ReadOnlyWeapons</a>
|
|
<a href="ReadOnlyWormHole.html">ReadOnlyWormHole</a>
|
|
<a href="Shield.html">Shield</a>
|
|
<a href="ShipAI.html">ShipAI</a>
|
|
<a href="ShipSystem.html">ShipSystem</a>
|
|
<a href="StructuralIntegrity.html">StructuralIntegrity</a>
|
|
<a href="SystemUpgradeLoot.html">SystemUpgradeLoot</a>
|
|
<a href="Thrusters.html">Thrusters</a>
|
|
<a href="Torpedo.html">Torpedo</a>
|
|
<a href="TorpedoAI.html">TorpedoAI</a>
|
|
<a href="TorpedoLauncher.html">TorpedoLauncher</a>
|
|
<a href="Turret.html">Turret</a>
|
|
<a href="TurretAI.html">TurretAI</a>
|
|
<a href="TurretBases.html">TurretBases</a>
|
|
<a href="Velocity.html">Velocity</a>
|
|
<a href="Weapons.html">Weapons</a>
|
|
<a href="WormHole.html">WormHole</a>
|
|
</div><div class="headerlisting">
|
|
<span class="docheader">Common Objects</span>
|
|
<br><a href="AllianceMember.html">AllianceMember</a>
|
|
<a href="AllianceRank.html">AllianceRank</a>
|
|
<a href="BlockPlan.html">BlockPlan</a>
|
|
<a href="BlockPlanBlock.html">BlockPlanBlock</a>
|
|
<a href="BlockStatistics.html">BlockStatistics</a>
|
|
<a href="Box.html">Box</a>
|
|
<a href="Captain.html">Captain</a>
|
|
<a href="Color.html">Color</a>
|
|
<a href="ControlUnitSeat.html">ControlUnitSeat</a>
|
|
<a href="CraftDesign.html">CraftDesign</a>
|
|
<a href="CraftStatsOverview.html">CraftStatsOverview</a>
|
|
<a href="Crew.html">Crew</a>
|
|
<a href="CrewMan.html">CrewMan</a>
|
|
<a href="CrewProfession.html">CrewProfession</a>
|
|
<a href="DebugInfo.html">DebugInfo</a>
|
|
<a href="dvec2.html">dvec2</a>
|
|
<a href="dvec3.html">dvec3</a>
|
|
<a href="dvec4.html">dvec4</a>
|
|
<a href="Entity.html">Entity</a>
|
|
<a href="EntityDescriptor.html">EntityDescriptor</a>
|
|
<a href="FighterTemplate.html">FighterTemplate</a>
|
|
<a href="Format.html">Format</a>
|
|
<a href="GameSettings.html">GameSettings</a>
|
|
<a href="Group.html">Group</a>
|
|
<a href="HighResolutionTimer.html">HighResolutionTimer</a>
|
|
<a href="Inventory.html">Inventory</a>
|
|
<a href="InventoryTurret.html">InventoryTurret</a>
|
|
<a href="ivec2.html">ivec2</a>
|
|
<a href="ivec3.html">ivec3</a>
|
|
<a href="ivec4.html">ivec4</a>
|
|
<a href="Language.html">Language</a>
|
|
<a href="Mail.html">Mail</a>
|
|
<a href="Material.html">Material</a>
|
|
<a href="Matrix.html">Matrix</a>
|
|
<a href="ModManager.html">ModManager</a>
|
|
<a href="NamedFormat.html">NamedFormat</a>
|
|
<a href="PlanBspTree.html">PlanBspTree</a>
|
|
<a href="PlanetSpecifics.html">PlanetSpecifics</a>
|
|
<a href="PlanGenerationStage.html">PlanGenerationStage</a>
|
|
<a href="PlanPart.html">PlanPart</a>
|
|
<a href="PlanStyle.html">PlanStyle</a>
|
|
<a href="PlayerId.html">PlayerId</a>
|
|
<a href="PluralForm.html">PluralForm</a>
|
|
<a href="Profiler.html">Profiler</a>
|
|
<a href="QuadTree.html">QuadTree</a>
|
|
<a href="Random.html">Random</a>
|
|
<a href="Rarity.html">Rarity</a>
|
|
<a href="Ray.html">Ray</a>
|
|
<a href="ReadOnlyEntity.html">ReadOnlyEntity</a>
|
|
<a href="Rect.html">Rect</a>
|
|
<a href="Relation.html">Relation</a>
|
|
<a href="Scenario.html">Scenario</a>
|
|
<a href="SectorView.html">SectorView</a>
|
|
<a href="Seed.html">Seed</a>
|
|
<a href="Sphere.html">Sphere</a>
|
|
<a href="Squad.html">Squad</a>
|
|
<a href="SystemUpgradeTemplate.html">SystemUpgradeTemplate</a>
|
|
<a href="Timer.html">Timer</a>
|
|
<a href="Tooltip.html">Tooltip</a>
|
|
<a href="TooltipLine.html">TooltipLine</a>
|
|
<a href="TorpedoShaft.html">TorpedoShaft</a>
|
|
<a href="TorpedoTemplate.html">TorpedoTemplate</a>
|
|
<a href="TradingGood.html">TradingGood</a>
|
|
<a href="TurretDesign.html">TurretDesign</a>
|
|
<a href="TurretDesignPart.html">TurretDesignPart</a>
|
|
<a href="TurretTemplate.html">TurretTemplate</a>
|
|
<a href="UsableInventoryItem.html">UsableInventoryItem</a>
|
|
<a href="Uuid.html">Uuid</a>
|
|
<a href="VanillaInventoryItem.html">VanillaInventoryItem</a>
|
|
<a href="vec2.html">vec2</a>
|
|
<a href="vec3.html">vec3</a>
|
|
<a href="vec4.html">vec4</a>
|
|
<a href="Version.html">Version</a>
|
|
<a href="Weapon.html">Weapon</a>
|
|
</div><div class="headerlisting">
|
|
<span class="docheader">Client Components</span>
|
|
<br><a href="EntityIcon.html">EntityIcon</a>
|
|
<a href="EntityTooltip.html">EntityTooltip</a>
|
|
<a href="PlanMesh.html">PlanMesh</a>
|
|
<a href="ReadOnlyIcon.html">ReadOnlyIcon</a>
|
|
<a href="ReadOnlyPlanMesh.html">ReadOnlyPlanMesh</a>
|
|
<a href="ReadOnlyScriptUI.html">ReadOnlyScriptUI</a>
|
|
<a href="ReadOnlyTooltip.html">ReadOnlyTooltip</a>
|
|
<a href="ScriptUI.html">ScriptUI</a>
|
|
</div><div class="headerlisting">
|
|
<span class="docheader">Client Objects</span>
|
|
<br><a href="Achievements.html">Achievements</a>
|
|
<a href="Alliance [Client].html">Alliance [Client]</a>
|
|
<a href="CameraKeyFrame.html">CameraKeyFrame</a>
|
|
<a href="CaptainSelectionItem.html">CaptainSelectionItem</a>
|
|
<a href="Client.html">Client</a>
|
|
<a href="ClientSettings.html">ClientSettings</a>
|
|
<a href="ColorSelectionItem.html">ColorSelectionItem</a>
|
|
<a href="CraftDesignSelectionItem.html">CraftDesignSelectionItem</a>
|
|
<a href="Faction [Client].html">Faction [Client]</a>
|
|
<a href="Galaxy [Client].html">Galaxy [Client]</a>
|
|
<a href="GalaxyMap.html">GalaxyMap</a>
|
|
<a href="GameInput.html">GameInput</a>
|
|
<a href="GlowFX.html">GlowFX</a>
|
|
<a href="IconSelectionItem.html">IconSelectionItem</a>
|
|
<a href="InputWindow.html">InputWindow</a>
|
|
<a href="InventoryReferenceSelectionItem.html">InventoryReferenceSelectionItem</a>
|
|
<a href="InventorySelectionItem.html">InventorySelectionItem</a>
|
|
<a href="Keyboard.html">Keyboard</a>
|
|
<a href="LaserFX.html">LaserFX</a>
|
|
<a href="Mouse.html">Mouse</a>
|
|
<a href="Music.html">Music</a>
|
|
<a href="PixelIconSelectionItem.html">PixelIconSelectionItem</a>
|
|
<a href="Planet.html">Planet</a>
|
|
<a href="Player [Client].html">Player [Client]</a>
|
|
<a href="PlayerWindow.html">PlayerWindow</a>
|
|
<a href="RefractionFX.html">RefractionFX</a>
|
|
<a href="Sector [Client].html">Sector [Client]</a>
|
|
<a href="SelectionItem.html">SelectionItem</a>
|
|
<a href="ShipDatabaseEntry [Client].html">ShipDatabaseEntry [Client]</a>
|
|
<a href="SoundSource.html">SoundSource</a>
|
|
<a href="StrategyState.html">StrategyState</a>
|
|
<a href="TargetIndicator.html">TargetIndicator</a>
|
|
<a href="TooltipRenderer.html">TooltipRenderer</a>
|
|
<a href="TurretDesignSelectionItem.html">TurretDesignSelectionItem</a>
|
|
</div><div class="headerlisting">
|
|
<span class="docheader">Client UI Objects</span>
|
|
<br><a href="AllianceEmblem.html">AllianceEmblem</a>
|
|
<a href="AllianceTab.html">AllianceTab</a>
|
|
<a href="ArrowLine.html">ArrowLine</a>
|
|
<a href="Button [Client] [Client].html">Button [Client] [Client]</a>
|
|
<a href="Button [Client] [Client].html">Button [Client] [Client]</a>
|
|
<a href="CaptainIcon.html">CaptainIcon</a>
|
|
<a href="CaptainProfile.html">CaptainProfile</a>
|
|
<a href="CheckBox.html">CheckBox</a>
|
|
<a href="ComboBox.html">ComboBox</a>
|
|
<a href="ContextMenu.html">ContextMenu</a>
|
|
<a href="CraftPortrait.html">CraftPortrait</a>
|
|
<a href="CrewBar.html">CrewBar</a>
|
|
<a href="Frame.html">Frame</a>
|
|
<a href="Hud.html">Hud</a>
|
|
<a href="InventorySelection.html">InventorySelection</a>
|
|
<a href="Label.html">Label</a>
|
|
<a href="Line.html">Line</a>
|
|
<a href="ListBox.html">ListBox</a>
|
|
<a href="ListBoxEx.html">ListBoxEx</a>
|
|
<a href="MapArrowLine.html">MapArrowLine</a>
|
|
<a href="MapIcon.html">MapIcon</a>
|
|
<a href="MultiLineTextBox.html">MultiLineTextBox</a>
|
|
<a href="NumbersBar.html">NumbersBar</a>
|
|
<a href="Picture.html">Picture</a>
|
|
<a href="PlanDisplayer.html">PlanDisplayer</a>
|
|
<a href="ProgressBar.html">ProgressBar</a>
|
|
<a href="SavedDesignsSelection.html">SavedDesignsSelection</a>
|
|
<a href="ScrollFrame.html">ScrollFrame</a>
|
|
<a href="Selection.html">Selection</a>
|
|
<a href="ShipWindow.html">ShipWindow</a>
|
|
<a href="Slider.html">Slider</a>
|
|
<a href="StatisticsBar.html">StatisticsBar</a>
|
|
<a href="Tab.html">Tab</a>
|
|
<a href="TabbedWindow.html">TabbedWindow</a>
|
|
<a href="TextBox.html">TextBox</a>
|
|
<a href="TextField.html">TextField</a>
|
|
<a href="TooltipDisplayer.html">TooltipDisplayer</a>
|
|
<a href="Tree.html">Tree</a>
|
|
<a href="UIArbitraryHorizontalSplitter.html">UIArbitraryHorizontalSplitter</a>
|
|
<a href="UIArbitraryVerticalSplitter.html">UIArbitraryVerticalSplitter</a>
|
|
<a href="UIContainer.html">UIContainer</a>
|
|
<a href="UIElement.html">UIElement</a>
|
|
<a href="UIGridSplitter.html">UIGridSplitter</a>
|
|
<a href="UIHorizontalLister.html">UIHorizontalLister</a>
|
|
<a href="UIHorizontalMultiSplitter.html">UIHorizontalMultiSplitter</a>
|
|
<a href="UIHorizontalSplitter.html">UIHorizontalSplitter</a>
|
|
<a href="UIOrganizer.html">UIOrganizer</a>
|
|
<a href="UIRect.html">UIRect</a>
|
|
<a href="UIRenderer.html">UIRenderer</a>
|
|
<a href="UIVerticalLister.html">UIVerticalLister</a>
|
|
<a href="UIVerticalMultiSplitter.html">UIVerticalMultiSplitter</a>
|
|
<a href="UIVerticalSplitter.html">UIVerticalSplitter</a>
|
|
<a href="ValueComboBox.html">ValueComboBox</a>
|
|
<a href="Window.html">Window</a>
|
|
</div><div class="headerlisting">
|
|
<span class="docheader">Server Components</span>
|
|
<br><a href="EntityTransferrer.html">EntityTransferrer</a>
|
|
<a href="FighterController.html">FighterController</a>
|
|
<a href="Loot.html">Loot</a>
|
|
<a href="ReadOnlyEntityTransferrer.html">ReadOnlyEntityTransferrer</a>
|
|
<a href="ReadOnlyFighterController.html">ReadOnlyFighterController</a>
|
|
<a href="ReadOnlyLoot.html">ReadOnlyLoot</a>
|
|
<a href="ReadOnlyTurretController.html">ReadOnlyTurretController</a>
|
|
<a href="ReadOnlyWreckageCreator.html">ReadOnlyWreckageCreator</a>
|
|
<a href="TurretController.html">TurretController</a>
|
|
<a href="WreckageCreator.html">WreckageCreator</a>
|
|
</div><div class="headerlisting">
|
|
<span class="docheader">Server Objects</span>
|
|
<br><a href="Alliance [Server].html">Alliance [Server]</a>
|
|
<a href="Faction [Server].html">Faction [Server]</a>
|
|
<a href="Galaxy [Server].html">Galaxy [Server]</a>
|
|
<a href="Player [Server].html">Player [Server]</a>
|
|
<a href="ReadOnlySector.html">ReadOnlySector</a>
|
|
<a href="Sector [Server].html">Sector [Server]</a>
|
|
<a href="Server.html">Server</a>
|
|
<a href="ShipDatabaseEntry [Server].html">ShipDatabaseEntry [Server]</a>
|
|
</div><div class="lastheaderlisting">
|
|
<span class="docheader">Enums</span>
|
|
<br><a href="Enums.html#AIState">AIState</a>
|
|
<a href="Enums.html#AlliancePrivilege">AlliancePrivilege</a>
|
|
<a href="Enums.html#BeamShape">BeamShape</a>
|
|
<a href="Enums.html#BlockShading">BlockShading</a>
|
|
<a href="Enums.html#BlockStructure">BlockStructure</a>
|
|
<a href="Enums.html#BlockType">BlockType</a>
|
|
<a href="Enums.html#BlockType2">BlockType2</a>
|
|
<a href="Enums.html#BoxType">BoxType</a>
|
|
<a href="Enums.html#BuildError">BuildError</a>
|
|
<a href="Enums.html#CaptainGenderId">CaptainGenderId</a>
|
|
<a href="Enums.html#ChatChannel">ChatChannel</a>
|
|
<a href="Enums.html#ChatMessageType">ChatMessageType</a>
|
|
<a href="Enums.html#ComponentType">ComponentType</a>
|
|
<a href="Enums.html#ControlAction">ControlAction</a>
|
|
<a href="Enums.html#ControlActionBit">ControlActionBit</a>
|
|
<a href="Enums.html#ControlStyle">ControlStyle</a>
|
|
<a href="Enums.html#CoolingType">CoolingType</a>
|
|
<a href="Enums.html#CraftStatsOverviewStat">CraftStatsOverviewStat</a>
|
|
<a href="Enums.html#CrewProfessionType">CrewProfessionType</a>
|
|
<a href="Enums.html#CrewRank">CrewRank</a>
|
|
<a href="Enums.html#DamageSource">DamageSource</a>
|
|
<a href="Enums.html#DamageType">DamageType</a>
|
|
<a href="Enums.html#DeletionType">DeletionType</a>
|
|
<a href="Enums.html#Difficulty">Difficulty</a>
|
|
<a href="Enums.html#EntityArrivalType">EntityArrivalType</a>
|
|
<a href="Enums.html#EntityType">EntityType</a>
|
|
<a href="Enums.html#FighterOrders">FighterOrders</a>
|
|
<a href="Enums.html#FighterStartError">FighterStartError</a>
|
|
<a href="Enums.html#FighterType">FighterType</a>
|
|
<a href="Enums.html#FontType">FontType</a>
|
|
<a href="Enums.html#ImpactParticles">ImpactParticles</a>
|
|
<a href="Enums.html#InventoryItemType">InventoryItemType</a>
|
|
<a href="Enums.html#JumpError">JumpError</a>
|
|
<a href="Enums.html#KeyboardKey">KeyboardKey</a>
|
|
<a href="Enums.html#ListBoxEntryType">ListBoxEntryType</a>
|
|
<a href="Enums.html#MalusReason">MalusReason</a>
|
|
<a href="Enums.html#MaterialType">MaterialType</a>
|
|
<a href="Enums.html#MoonType">MoonType</a>
|
|
<a href="Enums.html#MouseButton">MouseButton</a>
|
|
<a href="Enums.html#PlanetType">PlanetType</a>
|
|
<a href="Enums.html#PlanTypeFilter">PlanTypeFilter</a>
|
|
<a href="Enums.html#PlayerStateType">PlayerStateType</a>
|
|
<a href="Enums.html#ProjectileShape">ProjectileShape</a>
|
|
<a href="Enums.html#RarityType">RarityType</a>
|
|
<a href="Enums.html#RelationStatus">RelationStatus</a>
|
|
<a href="Enums.html#SavedDesignType">SavedDesignType</a>
|
|
<a href="Enums.html#ScenarioType">ScenarioType</a>
|
|
<a href="Enums.html#SectorChangeType">SectorChangeType</a>
|
|
<a href="Enums.html#ShipAvailability">ShipAvailability</a>
|
|
<a href="Enums.html#SoundType">SoundType</a>
|
|
<a href="Enums.html#StatsBonuses">StatsBonuses</a>
|
|
<a href="Enums.html#TargetIndicatorVisuals">TargetIndicatorVisuals</a>
|
|
<a href="Enums.html#TransformationFeature">TransformationFeature</a>
|
|
<a href="Enums.html#TurretAutoFireMode">TurretAutoFireMode</a>
|
|
<a href="Enums.html#TurretSlotType">TurretSlotType</a>
|
|
<a href="Enums.html#WeaponAppearance">WeaponAppearance</a>
|
|
<a href="Enums.html#WeaponCategory">WeaponCategory</a>
|
|
</div></div>
|
|
<div class="disclaimer">
|
|
<p>This is the official documentation for the scripting API of Avorion. This documentation is automatically generated and <strong>not</strong> 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.</p>
|
|
<p>Work in Progress. Documentation of Avorion Version: 2.5.8 a0d3f0b5b065</p>
|
|
</div>
|
|
<div class="footer">
|
|
<p align="center">Work in Progress.</p>
|
|
<p align="center">Copyright © 2025 Boxelware GmbH. All rights reserved.</p>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|