11940 lines
411 KiB
HTML
11940 lines
411 KiB
HTML
<html>
|
|
|
|
<head>
|
|
<title> CargoBay</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="CargoBay.html">CargoBay</a>
|
|
<a class="function" href="#CargoBay">CargoBay</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><br /></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="docheader">Properties</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="#alwaysStoreAtLeastOne">alwaysStoreAtLeastOne</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="#cargoHold">cargoHold</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="#cargoVolume">cargoVolume</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="#empty">empty</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="#entity">entity</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="#a">a</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="#fixedSize">fixedSize</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="#freeSpace">freeSpace</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="#numCargos">numCargos</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="#pickUpDangerous">pickUpDangerous</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="#pickUpDefaults">pickUpDefaults</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="#pickUpIllegal">pickUpIllegal</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="#pickUpOres">pickUpOres</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="#pickUpScrap">pickUpScrap</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a href="#pickUpStolen">pickUpStolen</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><br /></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="docheader">Member Functions</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="code" href="#add">add</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="code" href="#addCargo">addCargo</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="code" href="#clear">clear</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="code" href="#destroyCargo">destroyCargo</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="code" href="#findCargos">findCargos</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="code" href="#getCargo">getCargo</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="code" href="#getCargos">getCargos</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="code" href="#getNumCargos">getNumCargos</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="code" href="#getSummary">getSummary</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="code" href="#removeCargo">removeCargo</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="floatright">
|
|
<h1>CargoBay</h1>
|
|
<p>
|
|
This represents an interface to an entity in the scene. Creating an object of this type will not
|
|
create a
|
|
new entity in the scene, but will rather enable access to an existing entity. Use the Sector class
|
|
to
|
|
create new entities. <br /> Avorion uses an entity component system (See <a
|
|
href="https://en.wikipedia.org/wiki/Entity_component_system">entity component system on
|
|
Wikipedia</a>). Thus, some properties and functions are only available if the entity has the
|
|
corresponding component. The list of components can be found here: Enum ComponentType <br /> <br />
|
|
Note:
|
|
The <b>id</b> property of an Entity can be changed, but won't change the actual id of the underlying
|
|
entity. Instead, the entity interface will be pointing to another entity with the new id. Use this
|
|
for
|
|
performance tuning to avoid creating lots of entity interfaces. <br /> Note 2: This class is
|
|
considered
|
|
to have too many members and functions. Over time these will be phased out into their respective
|
|
component classes. Only a few frequently used properties and functions will remain for coding
|
|
comfort.
|
|
</p>
|
|
<div id="CargoBay" class="codecontainer">
|
|
<div id="CargoBay" class="function">
|
|
<p>
|
|
<span class="keyword">function </span> CargoBay(<span class="type">string</span> <span
|
|
class="parameter">name</span>, <span class="type">string</span> <span
|
|
class="parameter">plural</span>, <span class="type">string</span> <span
|
|
class="parameter">description</span>, <span class="type">string</span> <span
|
|
class="parameter">icon</span>, <span class="type">float</span> <span
|
|
class="parameter">price</span>, <span class="type">float</span> <span
|
|
class="parameter">size</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="CargoBay" class="">
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</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 CargoBay
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="Properties" class="codecontainer">
|
|
<div id="alwaysStoreAtLeastOne">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">alwaysStoreAtLeastOne</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="cargoHold">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">cargoHold</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="cargoVolume">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">cargoVolume</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="empty">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">empty</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="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="fixedSize">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">fixedSize</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="freeSpace">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">freeSpace</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="numCargos">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">numCargos</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="pickUpDangerous">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpDangerous</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="pickUpDefaults">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpDefaults</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="pickUpIllegal">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpIllegal</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="pickUpOres">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpOres</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="pickUpScrap">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpScrap</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="pickUpStolen">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpStolen</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="accuracy">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">accuracy</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="ancient">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">ancient</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="armed">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">armed</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="averageTech">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">averageTech</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="baseEnergyPerSecond">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">baseEnergyPerSecond</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="bestEfficiency">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">bestEfficiency</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="blackMarketDLCOnly">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">blackMarketDLCOnly</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="category">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">WeaponCategory </span>
|
|
<span class="property">category</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="civil">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">civil</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="coaxial">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">coaxial</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="continuousBeam">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">continuousBeam</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="coolingRate">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">coolingRate</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="coolingTime">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">coolingTime</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="coolingType">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">coolingType</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="crew">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Crew </span> <span
|
|
class="property">crew</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="damage">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">damage</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="damageType">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">damageType</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="deathExplosion">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">deathExplosion</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="dps">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">dps</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="energyIncreasePerSecond">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">energyIncreasePerSecond</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="favorite">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">favorite</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="fireRate">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">fireRate</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="firing">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">firing</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="firingsPerSecond">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">firingsPerSecond</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="flavorText">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">flavorText</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="heat">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">heat</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="heatPerShot">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">heatPerShot</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="holdingForce">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">holdingForce</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="hullDamageMultiplicator">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">hullDamageMultiplicator</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="hullDamageMultiplier">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">hullDamageMultiplier</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="hullRepairRate">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">hullRepairRate</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="intoTheRiftDLCOnly">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">intoTheRiftDLCOnly</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="itemType">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">itemType</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="material">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Material </span> <span
|
|
class="property">material</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="maxHeat">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">maxHeat</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="maxTech">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">maxTech</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="metalBestEfficiency">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">metalBestEfficiency</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="metalRawEfficiency">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">metalRawEfficiency</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="metalRefinedEfficiency">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">metalRefinedEfficiency</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="missionRelevant">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">missionRelevant</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="name">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">name</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="numVisibleWeapons">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">numVisibleWeapons</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="numWeapons">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">numWeapons</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="otherForce">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">otherForce</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="overheated">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">overheated</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="rarity">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Rarity </span> <span
|
|
class="property">rarity</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="reach">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">reach</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="recent">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">recent</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="requiredShootingEnergy">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">double </span> <span
|
|
class="property">requiredShootingEnergy</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="seeker">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">seeker</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="selfForce">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">selfForce</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="shieldDamageMultiplicator">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">shieldDamageMultiplicator</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="shieldDamageMultiplier">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">shieldDamageMultiplier</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="shieldPenetration">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">shieldPenetration</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="shieldRepairRate">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">shieldRepairRate</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="shootingTime">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">shootingTime</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="shotSpeed">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">shotSpeed</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="shotsPerFiring">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">shotsPerFiring</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="shotsPerSecond">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">shotsPerSecond</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="shotsUntilOverheated">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">shotsUntilOverheated</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="simultaneousShooting">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">simultaneousShooting</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="size">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">size</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="slots">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">slots</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="slotType">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">TurretSlotType </span>
|
|
<span class="property">slotType</span>
|
|
</td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="stackable">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">stackable</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="stoneBestEfficiency">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">stoneBestEfficiency</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="stoneDamageMultiplicator">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">stoneDamageMultiplicator</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="stoneDamageMultiplier">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">stoneDamageMultiplier</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="stoneRawEfficiency">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">stoneRawEfficiency</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="stoneRefinedEfficiency">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">stoneRefinedEfficiency</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="title">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">title</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="trash">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">trash</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="turningSpeed">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">turningSpeed</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="weaponIcon">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">string </span> <span
|
|
class="property">weaponIcon</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="weaponName">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">string </span> <span
|
|
class="property">weaponName</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="weaponPrefix">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">string </span> <span
|
|
class="property">weaponPrefix</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="includeCrew">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">includeCrew</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="includeEnergy">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">includeEnergy</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="includeUpgrades">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">includeUpgrades</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="aiOwned">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">aiOwned</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="allianceOwned">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">allianceOwned</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="canPassRifts">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">canPassRifts</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="controlActions">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">controlActions</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="crew">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Crew </span> <span
|
|
class="property">crew</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="crewSize">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">crewSize</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="damageMultiplier">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">damageMultiplier</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"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="dockable">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">dockable</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="dockingParent">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Uuid </span> <span
|
|
class="property">dockingParent</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="durability">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">double </span> <span
|
|
class="property">durability</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="excludedPlayer">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">excludedPlayer</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="exclusionTime">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">exclusionTime</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="factionIndex">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">factionIndex</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="fighterCargoPickup">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">fighterCargoPickup</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="firePower">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">double </span> <span
|
|
class="property">firePower</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="freeCargoSpace">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">freeCargoSpace</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="hyperspaceCooldown">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">hyperspaceCooldown</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="hyperspaceJumpReach">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">hyperspaceJumpReach</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="id">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Uuid </span> <span
|
|
class="property">id</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="idealCrew">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Crew </span> <span
|
|
class="property">idealCrew</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="index">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Uuid </span> <span
|
|
class="property">index</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="invincible">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">invincible</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="isAnomaly">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isAnomaly</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="isArmedTurret">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">isArmedTurret</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="isAsteroid">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isAsteroid</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="isContainer">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isContainer</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="isDrone">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isDrone</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="isFighter">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isFighter</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="isFlyable">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isFlyable</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="isLoot">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isLoot</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="isObviouslyMineable">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isObviouslyMineable</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="isOther">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isOther</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="isShieldActive">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">isShieldActive</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="isShip">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isShip</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="isStation">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isStation</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">var </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="isTurret">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isTurret</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="isUnarmedTurret">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">isUnarmedTurret</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="isUnknown">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isUnknown</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="isWormHole">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isWormHole</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="isWreckage">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isWreckage</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="look">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">vec3 </span> <span
|
|
class="property">look</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="mass">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">mass</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="maxCargoSpace">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">maxCargoSpace</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="maxCrewSize">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">maxCrewSize</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="maxDurability">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">maxDurability</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="minCrew">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Crew </span> <span
|
|
class="property">minCrew</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="mothership">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Entity </span> <span
|
|
class="property">mothership</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="name">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">string </span> <span
|
|
class="property">name</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="numCargos">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">numCargos</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="numDefenseWeapons">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">numDefenseWeapons</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="numDefenseWeaponsCurrentAttack">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">numDefenseWeaponsCurrentAttack</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="numDockingPositions">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">numDockingPositions</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="numTurrets">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">numTurrets</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="occupiedCargoSpace">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">occupiedCargoSpace</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="orientation">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Matrix </span> <span
|
|
class="property">orientation</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="playerOrAllianceOwned">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">playerOrAllianceOwned</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="playerOwned">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">playerOwned</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="position">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Matrix </span> <span
|
|
class="property">position</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="radius">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">radius</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="reservationTime">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">reservationTime</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="reservedPlayer">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">reservedPlayer</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="right">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">vec3 </span> <span
|
|
class="property">right</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="selectedObject">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">selectedObject</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="shieldDurability">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">double </span> <span
|
|
class="property">shieldDurability</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="shieldMaxDurability">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">double </span> <span
|
|
class="property">shieldMaxDurability</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="shieldMeshIntensity">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">shieldMeshIntensity</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="size">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">vec3 </span> <span
|
|
class="property">size</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="timeAlive">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">timeAlive</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="title">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">string </span> <span
|
|
class="property">title</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="translatedTitle">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">translatedTitle</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="translation">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">dvec3 </span> <span
|
|
class="property">translation</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="translationf">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">vec3 </span> <span
|
|
class="property">translationf</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="transporterRange">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">double </span> <span
|
|
class="property">transporterRange</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="type">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">type</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="typename">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">string </span> <span
|
|
class="property">typename</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="up">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">vec3 </span> <span
|
|
class="property">up</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="volume">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">volume</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="aiOwned">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">aiOwned</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="allianceOwned">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">allianceOwned</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="canPassRifts">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">canPassRifts</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="controlActions">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">controlActions</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="crew">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Crew </span> <span
|
|
class="property">crew</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="crewSize">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">crewSize</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="damageMultiplier">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">damageMultiplier</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"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="dockable">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">dockable</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="dockingParent">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Uuid </span> <span
|
|
class="property">dockingParent</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="durability">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">double </span> <span
|
|
class="property">durability</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="excludedPlayer">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">excludedPlayer</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="exclusionTime">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">exclusionTime</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="factionIndex">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">factionIndex</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="fighterCargoPickup">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">fighterCargoPickup</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="firePower">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">double </span> <span
|
|
class="property">firePower</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="freeCargoSpace">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">freeCargoSpace</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="hyperspaceCooldown">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">hyperspaceCooldown</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="hyperspaceJumpReach">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">hyperspaceJumpReach</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="id">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Uuid </span> <span
|
|
class="property">id</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="idealCrew">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Crew </span> <span
|
|
class="property">idealCrew</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="index">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Uuid </span> <span
|
|
class="property">index</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="invincible">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">invincible</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="isAnomaly">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isAnomaly</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="isArmedTurret">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">isArmedTurret</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="isAsteroid">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isAsteroid</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="isContainer">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isContainer</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="isDrone">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isDrone</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="isFighter">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isFighter</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="isFlyable">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isFlyable</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="isLoot">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isLoot</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="isObviouslyMineable">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isObviouslyMineable</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="isOther">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isOther</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="isShieldActive">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">isShieldActive</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="isShip">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isShip</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="isStation">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isStation</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">var </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="isTurret">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isTurret</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="isUnarmedTurret">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">isUnarmedTurret</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="isUnknown">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isUnknown</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="isWormHole">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isWormHole</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="isWreckage">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isWreckage</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="look">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">vec3 </span> <span
|
|
class="property">look</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="mass">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">mass</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="maxCargoSpace">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">maxCargoSpace</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="maxCrewSize">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">maxCrewSize</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="maxDurability">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">maxDurability</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="minCrew">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Crew </span> <span
|
|
class="property">minCrew</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="mothership">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Entity </span> <span
|
|
class="property">mothership</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="name">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">string </span> <span
|
|
class="property">name</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="numCargos">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">numCargos</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="numDefenseWeapons">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">numDefenseWeapons</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="numDefenseWeaponsCurrentAttack">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">numDefenseWeaponsCurrentAttack</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="numDockingPositions">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">numDockingPositions</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="numTurrets">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">numTurrets</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="occupiedCargoSpace">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">occupiedCargoSpace</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="orientation">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Matrix </span> <span
|
|
class="property">orientation</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="playerOrAllianceOwned">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">playerOrAllianceOwned</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="playerOwned">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">playerOwned</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="position">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">Matrix </span> <span
|
|
class="property">position</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="radius">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">radius</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="reservationTime">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">reservationTime</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="reservedPlayer">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">reservedPlayer</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="right">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">vec3 </span> <span
|
|
class="property">right</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="selectedObject">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">selectedObject</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="shieldDurability">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">double </span> <span
|
|
class="property">shieldDurability</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="shieldMaxDurability">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">double </span> <span
|
|
class="property">shieldMaxDurability</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="shieldMeshIntensity">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">shieldMeshIntensity</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="size">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">vec3 </span> <span
|
|
class="property">size</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="timeAlive">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">timeAlive</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="title">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">string </span> <span
|
|
class="property">title</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="translatedTitle">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">translatedTitle</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="translation">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">dvec3 </span> <span
|
|
class="property">translation</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="translationf">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">vec3 </span> <span
|
|
class="property">translationf</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="transporterRange">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">double </span> <span
|
|
class="property">transporterRange</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="type">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">type</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="typename">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">string </span> <span
|
|
class="property">typename</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="up">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">vec3 </span> <span
|
|
class="property">up</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="volume">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">var </span> <span
|
|
class="property">volume</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="blocked">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">blocked</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
True if the hyperspace engine is being blocked.
|
|
</div>
|
|
</div>
|
|
<div id="clearSpace">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">clearSpace</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Sets the hyperspace engine to "clear space", which speeds up the cooldown to avoid annoying
|
|
wait
|
|
times in empty sectors. This value is overridden if the engine is or gets blocked or
|
|
distorted.
|
|
</div>
|
|
</div>
|
|
<div id="consumerIcon">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">string </span> <span
|
|
class="property">consumerIcon</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Energy consumer icon of the engine as shown in the energy tab.
|
|
</div>
|
|
</div>
|
|
<div id="consumerName">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">string </span> <span
|
|
class="property">consumerName</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Energy consumer name of the engine as shown in the energy tab.
|
|
</div>
|
|
</div>
|
|
<div id="cooldown">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">cooldown</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Cooldown in seconds of the engine. Current cooldown is set to this on exhaustion of the
|
|
hyperspace
|
|
engine. When this value is changed, it will be overridden once the player builds, reloads or
|
|
installs upgrades.
|
|
</div>
|
|
</div>
|
|
<div id="cooldownSpeed">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">cooldownSpeed</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Cooldown speed factor. Default is 1, can be 0.25 (distorted), 0 (blocked) or up to 3 (clear
|
|
space).
|
|
If hyperspace energy efficiency is below 1, this value is adjusted accordingly.
|
|
</div>
|
|
</div>
|
|
<div id="currentCooldown">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">currentCooldown</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Current cooldown in seconds of the engine. this is the number that ticks down over time.
|
|
</div>
|
|
</div>
|
|
<div id="defaultPriority">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">defaultPriority</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Energy consumer default priority of the engine as shown in the energy tab.
|
|
</div>
|
|
</div>
|
|
<div id="displayedCooldown">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">displayedCooldown</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Cooldown in seconds as it would be displayed to the player. This result varies, depending on
|
|
distorts, clear space or blockage.
|
|
</div>
|
|
</div>
|
|
<div id="distorted">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">distorted</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
True if the hyperspace engine is being distorted. This is the case when a ship is under
|
|
attack or
|
|
when distort() was called.
|
|
</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="isSceneEmpty">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isSceneEmpty</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Checks if the scene is considered "empty enough" to set "clear space" to true, and thus
|
|
recharge
|
|
the engine quicker. This is the case when there are only group, own faction or alliance
|
|
member
|
|
ships present
|
|
</div>
|
|
</div>
|
|
<div id="passBlocked">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">passBlocked</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Whether or not the hyperspace engine is capable of jumping over rifts. When this value is
|
|
changed,
|
|
it will be overridden once the player builds or installs upgrades.
|
|
</div>
|
|
</div>
|
|
<div id="range">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">range</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Range in sectors of the engine. When this value is changed, it will be overridden once the
|
|
player
|
|
builds or installs upgrades.
|
|
</div>
|
|
</div>
|
|
<div id="requiredEnergy">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">double </span> <span
|
|
class="property">requiredEnergy</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Currently required energy of the engine as shown in the energy tab.
|
|
</div>
|
|
</div>
|
|
<div id="requiredEnergyForJump">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">requiredEnergyForJump</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Amount of energy in W required to do a hyperspace jump (or rather: recharge the engine)
|
|
</div>
|
|
</div>
|
|
<div id="blocked">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">blocked</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
True if the hyperspace engine is being blocked.
|
|
</div>
|
|
</div>
|
|
<div id="clearSpace">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">clearSpace</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Sets the hyperspace engine to "clear space", which speeds up the cooldown to avoid annoying
|
|
wait
|
|
times in empty sectors. This value is overridden if the engine is or gets blocked or
|
|
distorted.
|
|
</div>
|
|
</div>
|
|
<div id="consumerIcon">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">string </span> <span
|
|
class="property">consumerIcon</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Energy consumer icon of the engine as shown in the energy tab.
|
|
</div>
|
|
</div>
|
|
<div id="consumerName">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">string </span> <span
|
|
class="property">consumerName</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Energy consumer name of the engine as shown in the energy tab.
|
|
</div>
|
|
</div>
|
|
<div id="cooldown">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">cooldown</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Cooldown in seconds of the engine. Current cooldown is set to this on exhaustion of the
|
|
hyperspace
|
|
engine. When this value is changed, it will be overridden once the player builds, reloads or
|
|
installs upgrades.
|
|
</div>
|
|
</div>
|
|
<div id="cooldownSpeed">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">cooldownSpeed</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Cooldown speed factor. Default is 1, can be 0.25 (distorted), 0 (blocked) or up to 3 (clear
|
|
space).
|
|
If hyperspace energy efficiency is below 1, this value is adjusted accordingly.
|
|
</div>
|
|
</div>
|
|
<div id="currentCooldown">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">currentCooldown</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Current cooldown in seconds of the engine. this is the number that ticks down over time.
|
|
</div>
|
|
</div>
|
|
<div id="defaultPriority">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">defaultPriority</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Energy consumer default priority of the engine as shown in the energy tab.
|
|
</div>
|
|
</div>
|
|
<div id="displayedCooldown">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">displayedCooldown</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Cooldown in seconds as it would be displayed to the player. This result varies, depending on
|
|
distorts, clear space or blockage.
|
|
</div>
|
|
</div>
|
|
<div id="distorted">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">distorted</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
True if the hyperspace engine is being distorted. This is the case when a ship is under
|
|
attack or
|
|
when distort() was called.
|
|
</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="isSceneEmpty">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">isSceneEmpty</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Checks if the scene is considered "empty enough" to set "clear space" to true, and thus
|
|
recharge
|
|
the engine quicker. This is the case when there are only group, own faction or alliance
|
|
member
|
|
ships present
|
|
</div>
|
|
</div>
|
|
<div id="passBlocked">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">passBlocked</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Whether or not the hyperspace engine is capable of jumping over rifts. When this value is
|
|
changed,
|
|
it will be overridden once the player builds or installs upgrades.
|
|
</div>
|
|
</div>
|
|
<div id="range">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">range</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Range in sectors of the engine. When this value is changed, it will be overridden once the
|
|
player
|
|
builds or installs upgrades.
|
|
</div>
|
|
</div>
|
|
<div id="requiredEnergy">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">double </span> <span
|
|
class="property">requiredEnergy</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Currently required energy of the engine as shown in the energy tab.
|
|
</div>
|
|
</div>
|
|
<div id="requiredEnergyForJump">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">requiredEnergyForJump</span></td>
|
|
<td align="right"><span><b>[read-only]</b></span></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Amount of energy in W required to do a hyperspace jump (or rather: recharge the engine)
|
|
</div>
|
|
</div>
|
|
<div id="alwaysStoreAtLeastOne">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">alwaysStoreAtLeastOne</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="cargoHold">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">cargoHold</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="cargoVolume">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">cargoVolume</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="empty">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">empty</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="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="fixedSize">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">fixedSize</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="freeSpace">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">freeSpace</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="numCargos">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">numCargos</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="pickUpDangerous">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpDangerous</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="pickUpDefaults">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpDefaults</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="pickUpIllegal">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpIllegal</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="pickUpOres">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpOres</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="pickUpScrap">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpScrap</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="pickUpStolen">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpStolen</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="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"><span><b>[read-only]</b></span></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">a</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 id="alwaysStoreAtLeastOne">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">alwaysStoreAtLeastOne</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="cargoHold">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">cargoHold</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="cargoVolume">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">cargoVolume</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="empty">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">empty</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="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="uuid">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">uuid </span> <span
|
|
class="property">a</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="fixedSize">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">fixedSize</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="freeSpace">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">float </span> <span
|
|
class="property">freeSpace</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="numCargos">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">numCargos</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="pickUpDangerous">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpDangerous</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="pickUpDefaults">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpDefaults</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="pickUpIllegal">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpIllegal</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="pickUpOres">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpOres</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="pickUpScrap">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpScrap</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="pickUpStolen">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span
|
|
class="property">pickUpStolen</span></td>
|
|
<td align="right"></td>
|
|
</tr>
|
|
</table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<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="a">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">uuid </span> <span
|
|
class="property">a</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 id="numDocks">
|
|
<table style="width:100%;">
|
|
<tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span
|
|
class="property">numDocks</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>
|
|
<div id="add" class="codecontainer">
|
|
<div id="add" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> add(<span class="type">CargoBay</span> <span
|
|
class="parameter">other</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="add" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addCargo" class="codecontainer">
|
|
<div id="addCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function unsigned int</span> addCargo(<span
|
|
class="type">TradingGood</span>
|
|
<span class="parameter">good</span>, <span class="type">int</span> <span
|
|
class="parameter">amount</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addCargo" class="">
|
|
<p>
|
|
Adds cargo to the entity. If the amount specified exceeds the maximum capacity of the cargo
|
|
bay, as
|
|
much cargo as still fits in will be added.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">good</span>
|
|
TradingGood that is to be added. <br />
|
|
<span class="parameter">amount</span>
|
|
The amount of cargo that should be added. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
How much was actually added (can be less than amount when cargo bay is full)
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="clear" class="codecontainer">
|
|
<div id="clear" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> clear() <br />
|
|
</p>
|
|
</div>
|
|
<div id="clear" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="destroyCargo" class="codecontainer">
|
|
<div id="destroyCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> destroyCargo(<span class="type">float</span> <span
|
|
class="parameter">volume</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="destroyCargo" class="">
|
|
<p>
|
|
Destroys cargo. The destruction distribution is generally equal over all goods.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">volume</span>
|
|
The amount of volume that should be destroyed. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="findCargos" class="codecontainer">
|
|
<div id="findCargos" class="function">
|
|
<p>
|
|
<span class="keyword">function table<TradingGood, int></span> findCargos(<span
|
|
class="type">string</span> <span class="parameter">name</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="findCargos" class="">
|
|
<p>
|
|
Finds all cargos with the given name.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
A string that will be matched with the 'name' property of the cargos. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
A map containing all matching goods, with the good as key and amount as value.
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCargo" class="codecontainer">
|
|
<div id="getCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function TradingGood, int...</span> getCargo(<span
|
|
class="type">unsigned
|
|
int</span> <span class="parameter">n</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCargo" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCargos" class="codecontainer">
|
|
<div id="getCargos" class="function">
|
|
<p>
|
|
<span class="keyword">function table<TradingGood, int></span> getCargos() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCargos" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getNumCargos" class="codecontainer">
|
|
<div id="getNumCargos" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> getNumCargos(<span class="type">var</span> <span
|
|
class="parameter">name</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getNumCargos" class="">
|
|
<p>
|
|
Counts all goods of the given type. When given a string, it will match the 'name' property
|
|
of the
|
|
goods. When given a TradingGood it will match the exact good.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
Either a TradingGood or a string containing the name of a trading good. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
The number of goods
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getSummary" class="codecontainer">
|
|
<div id="getSummary" class="function">
|
|
<p>
|
|
<span class="keyword">function string</span> getSummary(<span class="type">var</span> <span
|
|
class="parameter">goods</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getSummary" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeCargo" class="codecontainer">
|
|
<div id="removeCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeCargo(<span class="type">var</span> <span
|
|
class="parameter">good</span>, <span class="type">int</span> <span
|
|
class="parameter">amount</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="removeCargo" class="">
|
|
<p>
|
|
Removes cargo from the entity. When given a TradingGood, an exact check for that good will
|
|
be
|
|
performed. When given a string, only a name check will be performed, and which cargo will be
|
|
removed first is undefined if there are multiple goods with the same name. An example would
|
|
be
|
|
Energy Cells vs. Stolen Energy Cells. The 'name' property is the same, but the 'stolen'
|
|
property is
|
|
different.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">good</span>
|
|
Either a TradingGood or a string with the name of a good. <br />
|
|
<span class="parameter">amount</span>
|
|
The amount of cargo that should be removed. If this is more than there is on the ship, all
|
|
specified cargo will be removed. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="__eq" class="codecontainer">
|
|
<div id="__eq" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> __eq(<span class="type">var</span> <span
|
|
class="parameter">other</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="__eq" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addDescription" class="codecontainer">
|
|
<div id="addDescription" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addDescription(<span class="type">string</span>
|
|
<span class="parameter">str</span>, <span class="type">string</span> <span
|
|
class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addDescription" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addWeapon" class="codecontainer">
|
|
<div id="addWeapon" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addWeapon(<span class="type">var</span> <span
|
|
class="parameter">weapon</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addWeapon" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="clearDescriptions" class="codecontainer">
|
|
<div id="clearDescriptions" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> clearDescriptions() <br />
|
|
</p>
|
|
</div>
|
|
<div id="clearDescriptions" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="clearWeapons" class="codecontainer">
|
|
<div id="clearWeapons" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> clearWeapons() <br />
|
|
</p>
|
|
</div>
|
|
<div id="clearWeapons" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCrew" class="codecontainer">
|
|
<div id="getCrew" class="function">
|
|
<p>
|
|
<span class="keyword">function Crew</span> getCrew() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCrew" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getDescriptions" class="codecontainer">
|
|
<div id="getDescriptions" class="function">
|
|
<p>
|
|
<span class="keyword">function table<string, string></span> getDescriptions() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getDescriptions" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getWeapons" class="codecontainer">
|
|
<div id="getWeapons" class="function">
|
|
<p>
|
|
<span class="keyword">function Weapon...</span> getWeapons() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getWeapons" class="">
|
|
<p>
|
|
Returns all weapons of the object
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setBlackMarketDLCOnly" class="codecontainer">
|
|
<div id="setBlackMarketDLCOnly" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setBlackMarketDLCOnly() <br />
|
|
</p>
|
|
</div>
|
|
<div id="setBlackMarketDLCOnly" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setIntoTheRiftDLCOnly" class="codecontainer">
|
|
<div id="setIntoTheRiftDLCOnly" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setIntoTheRiftDLCOnly() <br />
|
|
</p>
|
|
</div>
|
|
<div id="setIntoTheRiftDLCOnly" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setRange" class="codecontainer">
|
|
<div id="setRange" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setRange(<span class="type">float</span> <span
|
|
class="parameter">range</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setRange" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="template" class="codecontainer">
|
|
<div id="template" class="function">
|
|
<p>
|
|
<span class="keyword">function TurretTemplate</span> template() <br />
|
|
</p>
|
|
</div>
|
|
<div id="template" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="updateStaticStats" class="codecontainer">
|
|
<div id="updateStaticStats" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> updateStaticStats() <br />
|
|
</p>
|
|
</div>
|
|
<div id="updateStaticStats" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getEfficiency" class="codecontainer">
|
|
<div id="getEfficiency" class="function">
|
|
<p>
|
|
<span class="keyword">function float</span> getEfficiency(<span
|
|
class="type">CraftStatsOverview::Stat</span> <span class="parameter">stat</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getEfficiency" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getUnit" class="codecontainer">
|
|
<div id="getUnit" class="function">
|
|
<p>
|
|
<span class="keyword">function string</span> getUnit(<span
|
|
class="type">CraftStatsOverview::Stat</span> <span class="parameter">stat</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getUnit" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getValue" class="codecontainer">
|
|
<div id="getValue" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getValue(<span
|
|
class="type">CraftStatsOverview::Stat</span> <span class="parameter">key</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getValue" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isBadValue" class="codecontainer">
|
|
<div id="isBadValue" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> isBadValue(<span
|
|
class="type">CraftStatsOverview::Stat</span> <span class="parameter">stat</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="isBadValue" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isDangerousValue" class="codecontainer">
|
|
<div id="isDangerousValue" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> isDangerousValue(<span
|
|
class="type">CraftStatsOverview::Stat</span> <span class="parameter">stat</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="isDangerousValue" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isRelevant" class="codecontainer">
|
|
<div id="isRelevant" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> isRelevant(<span
|
|
class="type">CraftStatsOverview::Stat</span> <span class="parameter">stat</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="isRelevant" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setIncludeImpact" class="codecontainer">
|
|
<div id="setIncludeImpact" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setIncludeImpact(<span class="type">bool</span>
|
|
<span class="parameter">crew</span>, <span class="type">bool</span> <span
|
|
class="parameter">energy</span>, <span class="type">bool</span> <span
|
|
class="parameter">upgrades</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setIncludeImpact" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="update" class="codecontainer">
|
|
<div id="update" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> update(<span class="type">Entity</span> <span
|
|
class="parameter">entity</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="update" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addComponent" class="codecontainer">
|
|
<div id="addComponent" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addComponent(<span class="type">Type</span> <span
|
|
class="parameter">type</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addComponent" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addComponents" class="codecontainer">
|
|
<div id="addComponents" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addComponents() <br />
|
|
</p>
|
|
</div>
|
|
<div id="addComponents" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getComponent" class="codecontainer">
|
|
<div id="getComponent" class="function">
|
|
<p>
|
|
<span class="keyword">function UserObject</span> getComponent(<span class="type">Type</span>
|
|
<span class="parameter">type</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getComponent" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeComponent" class="codecontainer">
|
|
<div id="removeComponent" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeComponent(<span class="type">Type</span>
|
|
<span class="parameter">type</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="removeComponent" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addAbsoluteBias" class="codecontainer">
|
|
<div id="addAbsoluteBias" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addAbsoluteBias(<span class="type">int</span>
|
|
<span class="parameter">type</span>, <span class="type">float</span> <span
|
|
class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addAbsoluteBias" class="">
|
|
<p>
|
|
Adds a flat bias for stat of type <b>type</b>. This bias will be added to stat after
|
|
multipliers
|
|
are considered. <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
Type of Bonus, e.g. acceleration, higher level crew <br />
|
|
<span class="parameter">value</span>
|
|
Bias added to base stats. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
key that can be used to access the multiplier
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addBaseMultiplier" class="codecontainer">
|
|
<div id="addBaseMultiplier" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addBaseMultiplier(<span class="type">int</span>
|
|
<span class="parameter">type</span>, <span class="type">float</span> <span
|
|
class="parameter">factor</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addBaseMultiplier" class="">
|
|
<p>
|
|
Adds a multiplyer for stat of type <b>type</b>. This is to increase a stat, so a factor of
|
|
0.3 will
|
|
become 1.3. <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
Type of Bonus, e.g. acceleration, higher level crew <br />
|
|
<span class="parameter">factor</span>
|
|
Factor that is used as Multiplier <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
key that can be used to access the multiplier
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addCargo" class="codecontainer">
|
|
<div id="addCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function unsigned int</span> addCargo(<span
|
|
class="type">TradingGood</span>
|
|
<span class="parameter">good</span>, <span class="type">int</span> <span
|
|
class="parameter">amount</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addCargo" class="">
|
|
<p>
|
|
Adds cargo to the entity. If the amount specified exceeds the maximum capacity of the cargo
|
|
bay, as
|
|
much cargo as still fits in will be added. <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">good</span>
|
|
TradingGood that is to be added. <br />
|
|
<span class="parameter">amount</span>
|
|
The amount of cargo that should be added. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
How much was actually added (can be less than amount when cargo bay is full)
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addCrew" class="codecontainer">
|
|
<div id="addCrew" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addCrew(<span class="type">int</span> <span
|
|
class="parameter">number</span>, <span class="type">CrewMan</span> <span
|
|
class="parameter">crewman</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addCrew" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addKeyedAbsoluteBias" class="codecontainer">
|
|
<div id="addKeyedAbsoluteBias" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addKeyedAbsoluteBias(<span class="type">int</span>
|
|
<span class="parameter">type</span>, <span class="type">int</span> <span
|
|
class="parameter">key</span>,
|
|
<span class="type">float</span> <span class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addKeyedAbsoluteBias" class="">
|
|
<p>
|
|
Exchanges flat bias at <b>key</b> with new value <span class="inheritedcode">Inherited from
|
|
<a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
Bonus type <br />
|
|
<span class="parameter">key</span>
|
|
Location of the bonus that will be changed <br />
|
|
<span class="parameter">value</span>
|
|
New value <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
key that can be used to access the multiplier
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addKeyedBaseMultiplier" class="codecontainer">
|
|
<div id="addKeyedBaseMultiplier" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addKeyedBaseMultiplier(<span
|
|
class="type">int</span>
|
|
<span class="parameter">type</span>, <span class="type">int</span> <span
|
|
class="parameter">key</span>, <span class="type">float</span> <span
|
|
class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addKeyedBaseMultiplier" class="">
|
|
<p>
|
|
Exchanges multiplier at <b>key</b> with new value <span class="inheritedcode">Inherited from
|
|
<a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
Bonus type <br />
|
|
<span class="parameter">key</span>
|
|
Location of the bonus that will be changed <br />
|
|
<span class="parameter">value</span>
|
|
New value <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
key that can be used to access the multiplier
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addKeyedMultiplier" class="codecontainer">
|
|
<div id="addKeyedMultiplier" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addKeyedMultiplier(<span class="type">int</span>
|
|
<span class="parameter">type</span>, <span class="type">int</span> <span
|
|
class="parameter">key</span>,
|
|
<span class="type">float</span> <span class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addKeyedMultiplier" class="">
|
|
<p>
|
|
Exchanges multiplier at <b>key</b> with new value <span class="inheritedcode">Inherited from
|
|
<a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
Bonus type <br />
|
|
<span class="parameter">key</span>
|
|
Location of the bonus that will be changed <br />
|
|
<span class="parameter">value</span>
|
|
New value <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
key that can be used to access the multiplier
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addKeyedMultiplyableBias" class="codecontainer">
|
|
<div id="addKeyedMultiplyableBias" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addKeyedMultiplyableBias(<span
|
|
class="type">int</span>
|
|
<span class="parameter">type</span>, <span class="type">int</span> <span
|
|
class="parameter">key</span>, <span class="type">float</span> <span
|
|
class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addKeyedMultiplyableBias" class="">
|
|
<p>
|
|
Exchanges bias at <b>key</b> with new value <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
Bonus type <br />
|
|
<span class="parameter">key</span>
|
|
Location of the bonus that will be changed <br />
|
|
<span class="parameter">value</span>
|
|
New value <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
key that can be used to access the multiplier
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addMultiplier" class="codecontainer">
|
|
<div id="addMultiplier" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addMultiplier(<span class="type">int</span> <span
|
|
class="parameter">type</span>, <span class="type">float</span> <span
|
|
class="parameter">factor</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addMultiplier" class="">
|
|
<p>
|
|
Adds a multiplyer for stat of type <b>type</b>. The factor will be used unchanged. <span
|
|
class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
Type of Bonus, e.g. acceleration, higher level crew <br />
|
|
<span class="parameter">factor</span>
|
|
Factor that is used as Multiplier <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
key that can be used to access the multiplier
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addMultiplyableBias" class="codecontainer">
|
|
<div id="addMultiplyableBias" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addMultiplyableBias(<span class="type">int</span>
|
|
<span class="parameter">type</span>, <span class="type">float</span> <span
|
|
class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addMultiplyableBias" class="">
|
|
<p>
|
|
Adds a bias for stat of type <b>type</b>. This bias will be added to stat before multipliers
|
|
are
|
|
considered. <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
Type of Bonus, e.g. acceleration, higher level crew <br />
|
|
<span class="parameter">value</span>
|
|
Bias added to base stats. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
key that can be used to access the multiplier
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addScript" class="codecontainer">
|
|
<div id="addScript" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addScript(<span class="type">string</span> <span
|
|
class="parameter">scriptPath</span>, <span class="type">var...</span> <span
|
|
class="parameter">arguments</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addScript" class="">
|
|
<p>
|
|
Adds a new script to an entity <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">scriptPath</span>
|
|
The path of the script that should be added <br />
|
|
<span class="parameter">arguments</span>
|
|
An arbitrary number of arguments that will be given to the 'initialize' function of the
|
|
added
|
|
script <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
0 on success, 1 if the entity could not be found
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addScriptOnce" class="codecontainer">
|
|
<div id="addScriptOnce" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addScriptOnce() <br />
|
|
</p>
|
|
</div>
|
|
<div id="addScriptOnce" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addTurret" class="codecontainer">
|
|
<div id="addTurret" class="function">
|
|
<p>
|
|
<span class="keyword">function Uuid</span> addTurret(<span
|
|
class="type">TurretTemplate</span> <span class="parameter">turret</span>, <span
|
|
class="type">Matrix</span> <span class="parameter">position</span>, <span
|
|
class="type">int</span> <span class="parameter">part</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addTurret" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="blockHyperspace" class="codecontainer">
|
|
<div id="blockHyperspace" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> blockHyperspace(<span class="type">float</span>
|
|
<span class="parameter">time</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="blockHyperspace" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="callbacksRegistered" class="codecontainer">
|
|
<div id="callbacksRegistered" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> callbacksRegistered(<span
|
|
class="type">string</span>
|
|
<span class="parameter">callbackName</span>, <span class="type">var</span> <span
|
|
class="parameter">functionName</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="callbacksRegistered" class="">
|
|
<p>
|
|
Check how many functions are registered to a callback from the current script VM. <span
|
|
class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">callbackName</span>
|
|
The name of the callback <br />
|
|
<span class="parameter">functionName</span>
|
|
The name of the function for which to check. If nil, will count all functions that are
|
|
registered
|
|
to this callback. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
The amount of functions registered to the callback
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="canAddCrew" class="codecontainer">
|
|
<div id="canAddCrew" class="function">
|
|
<p>
|
|
<span class="keyword">function var, var, table<int, string></span> canAddCrew(<span
|
|
class="type">int</span> <span class="parameter">number</span>, <span
|
|
class="type">int</span>
|
|
<span class="parameter">profession</span>, <span class="type">bool</span> <span
|
|
class="parameter">change</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="canAddCrew" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="changeCrew" class="codecontainer">
|
|
<div id="changeCrew" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> changeCrew(<span class="type">int</span> <span
|
|
class="parameter">number</span>, <span class="type">int</span> <span
|
|
class="parameter">profession</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="changeCrew" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="changeShield" class="codecontainer">
|
|
<div id="changeShield" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> changeShield(<span class="type">double</span>
|
|
<span class="parameter">delta</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="changeShield" class="">
|
|
<p>
|
|
Adds delta to shield durability <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">delta</span>
|
|
<br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="clearCargoBay" class="codecontainer">
|
|
<div id="clearCargoBay" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> clearCargoBay() <br />
|
|
</p>
|
|
</div>
|
|
<div id="clearCargoBay" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="clearValues" class="codecontainer">
|
|
<div id="clearValues" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> clearValues() <br />
|
|
</p>
|
|
</div>
|
|
<div id="clearValues" class="">
|
|
<p>
|
|
Removes all custom values of the object <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="damageShield" class="codecontainer">
|
|
<div id="damageShield" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> damageShield(<span class="type">double</span>
|
|
<span class="parameter">amount</span>, <span class="type">vec3</span> <span
|
|
class="parameter">location</span>, <span class="type">Uuid</span> <span
|
|
class="parameter">inflictorId</span>, <span class="type">var</span> <span
|
|
class="parameter">damageSource</span>, <span class="type">var</span> <span
|
|
class="parameter">damageType</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="damageShield" class="">
|
|
<p>
|
|
Damages shield by delta amount, location and inflictorId are not necessary, but can be added
|
|
if it
|
|
is needed, e.g. you want to do effects on hitpoint. <span class="inheritedcode">Inherited
|
|
from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">delta</span>
|
|
<br />
|
|
<span class="parameter">location</span>
|
|
<br />
|
|
<span class="parameter">inflictorId</span>
|
|
<br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="destroy" class="codecontainer">
|
|
<div id="destroy" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> destroy(<span class="type">Uuid</span> <span
|
|
class="parameter">inflictorId</span>, <span class="type">var</span> <span
|
|
class="parameter">damageSource</span>, <span class="type">var</span> <span
|
|
class="parameter">damageType</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="destroy" class="">
|
|
<p>
|
|
Destroy entity by inflicting more damage than durability of entity <span
|
|
class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">inflictorId</span>
|
|
Index of the entity that destroys the block <br />
|
|
<span class="parameter">damageSource</span>
|
|
Source of damage. Can be Weaponry, Collision, Decay, Torpedo or Arbitrary. * <br />
|
|
<span class="parameter">damageType</span>
|
|
Type of damage received. Damage can be of type Physical, Energy, Electric, Plasma,
|
|
AntiMatter or
|
|
Fragments. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="destroyBlock" class="codecontainer">
|
|
<div id="destroyBlock" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> destroyBlock(<span class="type">int</span> <span
|
|
class="parameter">index</span>, <span class="type">Uuid</span> <span
|
|
class="parameter">inflictorId</span>, <span class="type">var</span> <span
|
|
class="parameter">damageSource</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="destroyBlock" class="">
|
|
<p>
|
|
Destroy one block <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">index</span>
|
|
Index of the block that is destroyed <br />
|
|
<span class="parameter">inflictorId</span>
|
|
Index of the entity that destroys the block <br />
|
|
<span class="parameter">damageSource</span>
|
|
Source of damage. Can be Weaponry, Collision, Decay, Torpedo or Arbitrary. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="destroyCargo" class="codecontainer">
|
|
<div id="destroyCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> destroyCargo(<span class="type">float</span> <span
|
|
class="parameter">volume</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="destroyCargo" class="">
|
|
<p>
|
|
Destroys cargo. The destruction distribution is generally equal over all goods. <span
|
|
class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">volume</span>
|
|
The amount of volume that should be destroyed. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="disableFlightAssistFor" class="codecontainer">
|
|
<div id="disableFlightAssistFor" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> disableFlightAssistFor(<span
|
|
class="type">float</span>
|
|
<span class="parameter">time</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="disableFlightAssistFor" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="distortHyperspace" class="codecontainer">
|
|
<div id="distortHyperspace" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> distortHyperspace(<span class="type">float</span>
|
|
<span class="parameter">time</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="distortHyperspace" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="findCargos" class="codecontainer">
|
|
<div id="findCargos" class="function">
|
|
<p>
|
|
<span class="keyword">function table<TradingGood, int></span> findCargos(<span
|
|
class="type">string</span> <span class="parameter">name</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="findCargos" class="">
|
|
<p>
|
|
Finds all cargos with the given name. <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
A string that will be matched with the 'name' property of the cargos. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
A map containing all matching goods, with the good as key and amount as value.
|
|
</p>
|
|
</div>
|
|
</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">seat</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getAimedPositionBySeat" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</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>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getAllowedArbitraryTurrets" class="codecontainer">
|
|
<div id="getAllowedArbitraryTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getAllowedArbitraryTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getAllowedArbitraryTurrets" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getAllowedArmedTurrets" class="codecontainer">
|
|
<div id="getAllowedArmedTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getAllowedArmedTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getAllowedArmedTurrets" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getAllowedUnarmedTurrets" class="codecontainer">
|
|
<div id="getAllowedUnarmedTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getAllowedUnarmedTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getAllowedUnarmedTurrets" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getAttachedBlockIndex" class="codecontainer">
|
|
<div id="getAttachedBlockIndex" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getAttachedBlockIndex() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getAttachedBlockIndex" class="">
|
|
<p>
|
|
Returns the Index of the block that the turret is build on <span
|
|
class="inheritedcode">Inherited
|
|
from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getBoostedValue" class="codecontainer">
|
|
<div id="getBoostedValue" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getBoostedValue(<span class="type">int</span>
|
|
<span class="parameter">type</span>, <span class="type">float</span> <span
|
|
class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getBoostedValue" class="">
|
|
<p>
|
|
Returns value with included bonus, in case a bonus exists. Returns Nil if no bonuses at all,
|
|
returns value if no bonuses for this stat exist. <span class="inheritedcode">Inherited from
|
|
<a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
type of bonus stat, e.g. acceleration, higher level crew <br />
|
|
<span class="parameter">value</span>
|
|
the value, that might be changed by bonuses <br />
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getBoundingBox" class="codecontainer">
|
|
<div id="getBoundingBox" class="function">
|
|
<p>
|
|
<span class="keyword">function Box</span> getBoundingBox() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getBoundingBox" class="">
|
|
<p>
|
|
Returns Bounding Box for entity, use this if you need exact Bounding Box, e.g. for collision
|
|
detection when entities are close to each other. <span class="inheritedcode">Inherited from
|
|
<a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getBoundingSphere" class="codecontainer">
|
|
<div id="getBoundingSphere" class="function">
|
|
<p>
|
|
<span class="keyword">function Sphere</span> getBoundingSphere() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getBoundingSphere" class="">
|
|
<p>
|
|
Returns Bounding Sphere for entity. Much faster than Bounding Box, but not as accurate. Use
|
|
this if
|
|
you need to check often. <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCaptain" class="codecontainer">
|
|
<div id="getCaptain" class="function">
|
|
<p>
|
|
<span class="keyword">function Captain</span> getCaptain() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCaptain" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCargo" class="codecontainer">
|
|
<div id="getCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function TradingGood, int...</span> getCargo(<span
|
|
class="type">unsigned
|
|
int</span> <span class="parameter">n</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCargo" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCargoAmount" class="codecontainer">
|
|
<div id="getCargoAmount" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> getCargoAmount(<span class="type">var</span> <span
|
|
class="parameter">name</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCargoAmount" class="">
|
|
<p>
|
|
Counts all goods of the given type. When given a string, it will match the 'name' property
|
|
of the
|
|
goods. When given a TradingGood it will match the exact good. <span
|
|
class="inheritedcode">Inherited
|
|
from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
Either a TradingGood or a string containing the name of a trading good. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
The number of goods
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCargos" class="codecontainer">
|
|
<div id="getCargos" class="function">
|
|
<p>
|
|
<span class="keyword">function table<TradingGood, int></span> getCargos() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCargos" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCrewMembers" class="codecontainer">
|
|
<div id="getCrewMembers" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getCrewMembers(<span class="type">int</span> <span
|
|
class="parameter">profession</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCrewMembers" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getDamageContributorPlayerFactions" class="codecontainer">
|
|
<div id="getDamageContributorPlayerFactions" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getDamageContributorPlayerFactions() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getDamageContributorPlayerFactions" class="">
|
|
<p>
|
|
Lists all players and alliances that contributed damage to the entity <span
|
|
class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
Indices of all players and alliances that contributed damage to the entity
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getDamageContributorPlayers" class="codecontainer">
|
|
<div id="getDamageContributorPlayers" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getDamageContributorPlayers() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getDamageContributorPlayers" class="">
|
|
<p>
|
|
Lists all players that contributed damage to the entity <span
|
|
class="inheritedcode">Inherited from
|
|
<a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
Indices of all players that contributed damage to the entity
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getDamageContributors" class="codecontainer">
|
|
<div id="getDamageContributors" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getDamageContributors() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getDamageContributors" class="">
|
|
<p>
|
|
Lists all factions that contributed damage to the entity <span
|
|
class="inheritedcode">Inherited from
|
|
<a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
Indices of all factions that contributed damage to the entity
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getDockedGroupBoundingBox" class="codecontainer">
|
|
<div id="getDockedGroupBoundingBox" class="function">
|
|
<p>
|
|
<span class="keyword">function Box</span> getDockedGroupBoundingBox() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getDockedGroupBoundingBox" class="">
|
|
<p>
|
|
Returns Bounding Box for entity, but enlarged to also fit around all docked objects. Use
|
|
this if
|
|
you need exact Bounding Box, e.g. for collision detection when entities are close to each
|
|
other.
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getDockedGroupBoundingSphere" class="codecontainer">
|
|
<div id="getDockedGroupBoundingSphere" class="function">
|
|
<p>
|
|
<span class="keyword">function Sphere</span> getDockedGroupBoundingSphere() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getDockedGroupBoundingSphere" class="">
|
|
<p>
|
|
Returns Bounding Box for entity, but enlarged to also fit around all docked objects. Use
|
|
this if
|
|
you need exact Bounding Box, e.g. for collision detection when entities are close to each
|
|
other.
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getDockingPositions" class="codecontainer">
|
|
<div id="getDockingPositions" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getDockingPositions() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getDockingPositions" class="">
|
|
<p>
|
|
Lists all docking positions that the entity has <span class="inheritedcode">Inherited from
|
|
<a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
A table that contains a key-value pair (id, table) for each dock: <id, {position,
|
|
direction, id}>
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getFreeArbitraryTurrets" class="codecontainer">
|
|
<div id="getFreeArbitraryTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getFreeArbitraryTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getFreeArbitraryTurrets" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getFreeArmedTurrets" class="codecontainer">
|
|
<div id="getFreeArmedTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getFreeArmedTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getFreeArmedTurrets" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getFreeUnarmedTurrets" class="codecontainer">
|
|
<div id="getFreeUnarmedTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getFreeUnarmedTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getFreeUnarmedTurrets" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getFullPlanCopy" class="codecontainer">
|
|
<div id="getFullPlanCopy" class="function">
|
|
<p>
|
|
<span class="keyword">function BlockPlan</span> getFullPlanCopy() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getFullPlanCopy" class="">
|
|
<p>
|
|
Returns the plan of the entity. This copies the entire plan, keep that in mind when using
|
|
plans
|
|
with large block counts. <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
A copy of the plan of the entity
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getLowestMineableMaterial" class="codecontainer">
|
|
<div id="getLowestMineableMaterial" class="function">
|
|
<p>
|
|
<span class="keyword">function Material</span> getLowestMineableMaterial() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getLowestMineableMaterial" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getMalusFactor" class="codecontainer">
|
|
<div id="getMalusFactor" class="function">
|
|
<p>
|
|
<span class="keyword">function var, var</span> getMalusFactor() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getMalusFactor" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getMineableMaterial" class="codecontainer">
|
|
<div id="getMineableMaterial" class="function">
|
|
<p>
|
|
<span class="keyword">function Material</span> getMineableMaterial() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getMineableMaterial" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getMineableResources" class="codecontainer">
|
|
<div id="getMineableResources" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getMineableResources() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getMineableResources" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getMoneyLootAmount" class="codecontainer">
|
|
<div id="getMoneyLootAmount" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> getMoneyLootAmount() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getMoneyLootAmount" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getMovePlan" class="codecontainer">
|
|
<div id="getMovePlan" class="function">
|
|
<p>
|
|
<span class="keyword">function BlockPlan</span> getMovePlan() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getMovePlan" class="">
|
|
<p>
|
|
Returns the plan of the entity. This function will move the plan out of the entity, and
|
|
replace the
|
|
entity's plan with a single block. This operation is independent of the size of the plan,
|
|
use it
|
|
when you have to get large plans with lots of blocks. <span class="inheritedcode">Inherited
|
|
from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
The plan of the entity
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getNearestDistance" class="codecontainer">
|
|
<div id="getNearestDistance" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getNearestDistance(<span
|
|
class="type">Entity</span> <span class="parameter">other</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getNearestDistance" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getNumArmedTurrets" class="codecontainer">
|
|
<div id="getNumArmedTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getNumArmedTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getNumArmedTurrets" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getNumMiningTurrets" class="codecontainer">
|
|
<div id="getNumMiningTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getNumMiningTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getNumMiningTurrets" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getNumSalvagingTurrets" class="codecontainer">
|
|
<div id="getNumSalvagingTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getNumSalvagingTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getNumSalvagingTurrets" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getNumUnarmedTurrets" class="codecontainer">
|
|
<div id="getNumUnarmedTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getNumUnarmedTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getNumUnarmedTurrets" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getPilotIndices" class="codecontainer">
|
|
<div id="getPilotIndices" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getPilotIndices() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getPilotIndices" class="">
|
|
<p>
|
|
Returns Indices of piloting players <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
multiple return values: indices of players
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getPlanMoneyValue" class="codecontainer">
|
|
<div id="getPlanMoneyValue" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getPlanMoneyValue() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getPlanMoneyValue" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getPlanResourceValue" class="codecontainer">
|
|
<div id="getPlanResourceValue" class="function">
|
|
<p>
|
|
<span class="keyword">function double...</span> getPlanResourceValue() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getPlanResourceValue" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getResourceLootAmount" class="codecontainer">
|
|
<div id="getResourceLootAmount" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> getResourceLootAmount() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getResourceLootAmount" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getScripts" class="codecontainer">
|
|
<div id="getScripts" class="function">
|
|
<p>
|
|
<span class="keyword">function table<int, string></span> getScripts() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getScripts" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTitleArguments" class="codecontainer">
|
|
<div id="getTitleArguments" class="function">
|
|
<p>
|
|
<span class="keyword">function table<string, string></span> getTitleArguments() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTitleArguments" class="">
|
|
<p>
|
|
Retrieves the arguments to a title <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTitleFormat" class="codecontainer">
|
|
<div id="getTitleFormat" class="function">
|
|
<p>
|
|
<span class="keyword">function NamedFormat</span> getTitleFormat() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTitleFormat" class="">
|
|
<p>
|
|
Retrieves the title as NamedFormat <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTurret" class="codecontainer">
|
|
<div id="getTurret" class="function">
|
|
<p>
|
|
<span class="keyword">function Entity</span> getTurret(<span class="type">int</span> <span
|
|
class="parameter">index</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTurret" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTurretPositions" class="codecontainer">
|
|
<div id="getTurretPositions" class="function">
|
|
<p>
|
|
<span class="keyword">function Matrix, int...</span> getTurretPositions(<span
|
|
class="type">TurretTemplate</span> <span class="parameter">turret</span>, <span
|
|
class="type">int</span> <span class="parameter">number</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTurretPositions" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTurretPositionsLineOfSight" class="codecontainer">
|
|
<div id="getTurretPositionsLineOfSight" class="function">
|
|
<p>
|
|
<span class="keyword">function Matrix, int...</span> getTurretPositionsLineOfSight(<span
|
|
class="type">TurretTemplate</span> <span class="parameter">turret</span>, <span
|
|
class="type">int</span> <span class="parameter">number</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTurretPositionsLineOfSight" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTurrets" class="codecontainer">
|
|
<div id="getTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function Entity...</span> getTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTurrets" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTurretSize" class="codecontainer">
|
|
<div id="getTurretSize" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getTurretSize() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTurretSize" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTurretTemplateSize" class="codecontainer">
|
|
<div id="getTurretTemplateSize" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getTurretTemplateSize() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTurretTemplateSize" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTurretTurningSpeed" class="codecontainer">
|
|
<div id="getTurretTurningSpeed" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getTurretTurningSpeed() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTurretTurningSpeed" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getUndamagedPlanMoneyValue" class="codecontainer">
|
|
<div id="getUndamagedPlanMoneyValue" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getUndamagedPlanMoneyValue() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getUndamagedPlanMoneyValue" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getUndamagedPlanResourceValue" class="codecontainer">
|
|
<div id="getUndamagedPlanResourceValue" class="function">
|
|
<p>
|
|
<span class="keyword">function double...</span> getUndamagedPlanResourceValue() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getUndamagedPlanResourceValue" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getValue" class="codecontainer">
|
|
<div id="getValue" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getValue(<span class="type">string</span> <span
|
|
class="parameter">key</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getValue" class="">
|
|
<p>
|
|
Retrieves a custom value saved in the entity with the given key <span
|
|
class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">key</span>
|
|
A string that serves as the name of the value <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
The value if the key exists, otherwise nil
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getValues" class="codecontainer">
|
|
<div id="getValues" class="function">
|
|
<p>
|
|
<span class="keyword">function table<string, var></span> getValues() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getValues" class="">
|
|
<p>
|
|
Retrieves all key-value pairs of custom values of the entity <span
|
|
class="inheritedcode">Inherited
|
|
from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
A table containing all custom key-value pairs
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="hasComponent" class="codecontainer">
|
|
<div id="hasComponent" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> hasComponent(<span class="type">int</span> <span
|
|
class="parameter">type</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="hasComponent" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="hasScript" class="codecontainer">
|
|
<div id="hasScript" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> hasScript(<span class="type">string</span> <span
|
|
class="parameter">name</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="hasScript" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="heal" class="codecontainer">
|
|
<div id="heal" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> heal(<span class="type">float</span> <span
|
|
class="parameter">damage</span>, <span class="type">int</span> <span
|
|
class="parameter">index</span>, <span class="type">vec3</span> <span
|
|
class="parameter">location</span>, <span class="type">Uuid</span> <span
|
|
class="parameter">inflictorID</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="heal" class="">
|
|
<p>
|
|
Increases durability of the plan of the Entity <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">damage</span>
|
|
The amount of durability that will be restored <br />
|
|
<span class="parameter">index</span>
|
|
Index of the block that will be restored <br />
|
|
<span class="parameter">location</span>
|
|
vector containing the hit point, if unknown/unnecessary use empty vector <br />
|
|
<span class="parameter">inflictorID</span>
|
|
Index of the entity that heals <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="healShield" class="codecontainer">
|
|
<div id="healShield" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> healShield(<span class="type">double</span> <span
|
|
class="parameter">delta</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="healShield" class="">
|
|
<p>
|
|
Increases shield durability by delta <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">delta</span>
|
|
<br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="hyperspaceBlocked" class="codecontainer">
|
|
<div id="hyperspaceBlocked" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> hyperspaceBlocked() <br />
|
|
</p>
|
|
</div>
|
|
<div id="hyperspaceBlocked" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="inflictDamage" class="codecontainer">
|
|
<div id="inflictDamage" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> inflictDamage(<span class="type">float</span>
|
|
<span class="parameter">damage</span>, <span class="type">var</span> <span
|
|
class="parameter">damageSource</span>, <span class="type">var</span> <span
|
|
class="parameter">damageType</span>, <span class="type">int</span> <span
|
|
class="parameter">index</span>, <span class="type">vec3</span> <span
|
|
class="parameter">location</span>, <span class="type">Uuid</span> <span
|
|
class="parameter">inflictorId</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="inflictDamage" class="">
|
|
<p>
|
|
Inflicts damage to the plan of the Entity <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">damage</span>
|
|
The amount of damage that will be dealt <br />
|
|
<span class="parameter">damageSource</span>
|
|
The source of the damage. Can be Weaponry, Collision, Decay, Torpedo or Arbitrary. <br />
|
|
<span class="parameter">damageType</span>
|
|
Type of damage received. Damage can be of type Physical, Energy, Electric, Plasma,
|
|
AntiMatter or
|
|
Fragments <br />
|
|
<span class="parameter">index</span>
|
|
Index of the block that will receive the damage <br />
|
|
<span class="parameter">location</span>
|
|
vector containing the hit point, if unknown / unnecessary use empty vector <br />
|
|
<span class="parameter">inflictorId</span>
|
|
Index of the entity that caused the damage <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="invokeFunction" class="codecontainer">
|
|
<div id="invokeFunction" class="function">
|
|
<p>
|
|
<span class="keyword">function var...</span> invokeFunction(<span class="type">var</span>
|
|
<span class="parameter">scriptName</span>, <span class="type">string</span> <span
|
|
class="parameter">functionName</span>, <span class="type">var...</span> <span
|
|
class="parameter">arguments</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="invokeFunction" class="">
|
|
<p>
|
|
Invokes a function in a script of the entity. Use this function to invoke functions from one
|
|
script
|
|
in another script. The first return value of the function is an integer indicating whether
|
|
or not
|
|
the call was successful. When it was, this integer is followed by the return values of the
|
|
invoked
|
|
function. <span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">scriptName</span>
|
|
The name or index of the script containing the function <br />
|
|
<span class="parameter">functionName</span>
|
|
The name of the function that will be executed <br />
|
|
<span class="parameter">arguments</span>
|
|
An arbitrary list of arguments that will be given to the invoked function <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
Returns at least 1 value indicating if the call succeeded:<br /> 0 The call was
|
|
successful. In
|
|
this case, the return values of the script are returned in addition to the call result,
|
|
following the call result<br /> 1 The call failed because the entity with the specified
|
|
index
|
|
does not exist or has no Scripts component<br /> 2 The call failed because it came from
|
|
another
|
|
sector than the entity is in<br /> 3 The call failed because the given script was not
|
|
found in
|
|
the entity<br /> 4 The call failed because the given function was not found in the
|
|
script <br />
|
|
5 The call failed because the script's state has errors and is invalid <br />
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isCollectable" class="codecontainer">
|
|
<div id="isCollectable" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> isCollectable(<span class="type">Entity</span>
|
|
<span class="parameter">entity</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="isCollectable" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isInDockingArea" class="codecontainer">
|
|
<div id="isInDockingArea" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> isInDockingArea(<span class="type">Entity</span>
|
|
<span class="parameter">other</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="isInDockingArea" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isInsideShield" class="codecontainer">
|
|
<div id="isInsideShield" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> isInsideShield(<span class="type">vec3</span>
|
|
<span class="parameter">point</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="isInsideShield" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isJumpRouteValid" class="codecontainer">
|
|
<div id="isJumpRouteValid" class="function">
|
|
<p>
|
|
<span class="keyword">function bool, var</span> isJumpRouteValid(<span
|
|
class="type">int</span>
|
|
<span class="parameter">fromX</span>, <span class="type">int</span> <span
|
|
class="parameter">fromY</span>, <span class="type">int</span> <span
|
|
class="parameter">toX</span>, <span class="type">int</span> <span
|
|
class="parameter">toY</span>)
|
|
<br />
|
|
</p>
|
|
</div>
|
|
<div id="isJumpRouteValid" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isManned" class="codecontainer">
|
|
<div id="isManned" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> isManned() <br />
|
|
</p>
|
|
</div>
|
|
<div id="isManned" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isTurretAllowed" class="codecontainer">
|
|
<div id="isTurretAllowed" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> isTurretAllowed(<span
|
|
class="type">TurretTemplate</span>
|
|
<span class="parameter">ScriptTurretTemplate</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="isTurretAllowed" class="">
|
|
<p>
|
|
Tests if the maximum number of turrets of this kind is not reached <span
|
|
class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">ScriptTurretTemplate</span>
|
|
the template of the turret to be placed <br />
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="jumpPossible" class="codecontainer">
|
|
<div id="jumpPossible" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> jumpPossible(<span class="type">int</span> <span
|
|
class="parameter">x</span>, <span class="type">int</span> <span
|
|
class="parameter">y</span>)
|
|
<br />
|
|
</p>
|
|
</div>
|
|
<div id="jumpPossible" class="">
|
|
<p>
|
|
Tests if the entity can jump to the specified coordinates <span
|
|
class="inheritedcode">Inherited
|
|
from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">x</span>
|
|
The x-coordinates of the target sector <br />
|
|
<span class="parameter">y</span>
|
|
The y-coordinates of the target sector <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
Returns an error code:<br /> -1 The entity doesn't have a hyperspace drive.<br /> 0 The
|
|
entity
|
|
can jump.<br /> 1 The hyperspace drive needs to recharge.<br /> 2 The target sector is
|
|
too far
|
|
away.<br /> 3 The entity is facing the wrong direction.<br /> 4 The hyperspace drive is
|
|
being
|
|
jammed.<br />
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="moveBy" class="codecontainer">
|
|
<div id="moveBy" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> moveBy(<span class="type">vec3</span> <span
|
|
class="parameter">delta</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="moveBy" class="">
|
|
<p>
|
|
Teleports entity by vector <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="registerCallback" class="codecontainer">
|
|
<div id="registerCallback" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> registerCallback(<span class="type">string</span>
|
|
<span class="parameter">callbackName</span>, <span class="type">string</span> <span
|
|
class="parameter">functionName</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="registerCallback" class="">
|
|
<p>
|
|
Register a callback in the entity. The callback receiver has to be inside the same sector
|
|
for the
|
|
registration to succeed. The callback will be removed if either the entity or the receiver
|
|
leaves
|
|
the sector or gets destroyed. Double registration of callbacks doesn't work. When the same
|
|
callback
|
|
to the same callback of the same script instance is registered twice, it will still only be
|
|
called
|
|
once. <span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">callbackName</span>
|
|
The name of the callback <br />
|
|
<span class="parameter">functionName</span>
|
|
The name of the function that will be executed in the script when the callback happens
|
|
<br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
0 on success, 1 if the registration failed
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="registerDamage" class="codecontainer">
|
|
<div id="registerDamage" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> registerDamage(<span class="type">Uuid</span>
|
|
<span class="parameter">shooterId</span>, <span class="type">double</span> <span
|
|
class="parameter">damage</span>, <span class="type">DamageSource</span> <span
|
|
class="parameter">DamageSource</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="registerDamage" class="">
|
|
<p>
|
|
Registers artificial damage as if the entity was damaged by the shooter <span
|
|
class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">shooterId</span>
|
|
The id of the entity that inflicted the damage <br />
|
|
<span class="parameter">damage</span>
|
|
The amount of damage inflicted <br />
|
|
<span class="parameter">DamageSource</span>
|
|
The kind of source for the damage <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeBonus" class="codecontainer">
|
|
<div id="removeBonus" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeBonus(<span class="type">int</span> <span
|
|
class="parameter">key</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="removeBonus" class="">
|
|
<p>
|
|
Deletes bonus <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">key</span>
|
|
Location of the bonus <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeCargo" class="codecontainer">
|
|
<div id="removeCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeCargo(<span class="type">var</span> <span
|
|
class="parameter">good</span>, <span class="type">int</span> <span
|
|
class="parameter">amount</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="removeCargo" class="">
|
|
<p>
|
|
Removes cargo from the entity. When given a TradingGood, an exact check for that good will
|
|
be
|
|
performed. When given a string, only a name check will be performed, and which cargo will be
|
|
removed first is undefined if there are multiple goods with the same name. An example would
|
|
be
|
|
Energy Cells vs. Stolen Energy Cells. The 'name' property is the same, but the 'stolen'
|
|
property is
|
|
different. <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">good</span>
|
|
Either a TradingGood or a string with the name of a good. <br />
|
|
<span class="parameter">amount</span>
|
|
The amount of cargo that should be removed. If this is more than there is on the ship, all
|
|
specified cargo will be removed. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeCrew" class="codecontainer">
|
|
<div id="removeCrew" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeCrew(<span class="type">int</span> <span
|
|
class="parameter">number</span>, <span class="type">CrewMan</span> <span
|
|
class="parameter">crewman</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="removeCrew" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeScript" class="codecontainer">
|
|
<div id="removeScript" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeScript(<span class="type">var</span> <span
|
|
class="parameter">script</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="removeScript" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeScriptBonuses" class="codecontainer">
|
|
<div id="removeScriptBonuses" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeScriptBonuses() <br />
|
|
</p>
|
|
</div>
|
|
<div id="removeScriptBonuses" class="">
|
|
<p>
|
|
Deletes all bonuses added by the current script <span class="inheritedcode">Inherited from
|
|
<a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="resolveScriptPath" class="codecontainer">
|
|
<div id="resolveScriptPath" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> resolveScriptPath(<span class="type">string</span>
|
|
<span class="parameter">path</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="resolveScriptPath" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="sendCallback" class="codecontainer">
|
|
<div id="sendCallback" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> sendCallback() <br />
|
|
</p>
|
|
</div>
|
|
<div id="sendCallback" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setAccumulatingBlockHealth" class="codecontainer">
|
|
<div id="setAccumulatingBlockHealth" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setAccumulatingBlockHealth(<span
|
|
class="type">bool</span>
|
|
<span class="parameter">bool</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setAccumulatingBlockHealth" class="">
|
|
<p>
|
|
If AccumulatingBlockHealth is true, a block needs to take as much damage as would be
|
|
necessary to
|
|
destroy all its children before it itself is destroyed. If it is set to false, the entity's
|
|
blocks
|
|
will have only their own durability. Set it to false if you want your entity to easily break
|
|
apart,
|
|
e.g. for wreckages. <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">bool</span>
|
|
<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">int</span>
|
|
<span class="parameter">seat</span>, <span class="type">vec3</span> <span
|
|
class="parameter">in</span>)
|
|
<br />
|
|
</p>
|
|
</div>
|
|
<div id="setAimedPosition" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setAttachedBlockIndex" class="codecontainer">
|
|
<div id="setAttachedBlockIndex" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setAttachedBlockIndex(<span
|
|
class="type">int</span> <span class="parameter">in</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setAttachedBlockIndex" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setCaptain" class="codecontainer">
|
|
<div id="setCaptain" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setCaptain(<span class="type">Captain [or
|
|
nil]</span>
|
|
<span class="parameter">captain</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setCaptain" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setDamageTypeMultiplier" class="codecontainer">
|
|
<div id="setDamageTypeMultiplier" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setDamageTypeMultiplier(<span
|
|
class="type">DamageType</span> <span class="parameter">type</span>, <span
|
|
class="type">float</span> <span class="parameter">factor</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setDamageTypeMultiplier" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setDropsAttachedTurrets" class="codecontainer">
|
|
<div id="setDropsAttachedTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setDropsAttachedTurrets(<span
|
|
class="type">bool</span>
|
|
<span class="parameter">bool</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setDropsAttachedTurrets" class="">
|
|
<p>
|
|
Sets the entities' ability to drop its attached turrets. If set to true (default) the ship
|
|
has a
|
|
chance to drop a turret that's attached to it when it's destroyed. This is only enabled for
|
|
NPC
|
|
entities. <span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">bool</span>
|
|
value if the dropping is enabled <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setDropsLoot" class="codecontainer">
|
|
<div id="setDropsLoot" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setDropsLoot(<span class="type">bool</span> <span
|
|
class="parameter">bool</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setDropsLoot" class="">
|
|
<p>
|
|
Sets the entities' ability to drop normal loot. Affects dropping of money, resources, cargo,
|
|
turrets and upgrades. 'Loot' component is not affected by this. <span
|
|
class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">bool</span>
|
|
value if the entity should drop loot or not <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setMalusFactor" class="codecontainer">
|
|
<div id="setMalusFactor" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setMalusFactor(<span class="type">float</span>
|
|
<span class="parameter">in</span>, <span class="type">int</span> <span
|
|
class="parameter">reason</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setMalusFactor" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setManned" class="codecontainer">
|
|
<div id="setManned" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setManned(<span class="type">bool</span> <span
|
|
class="parameter">in</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setManned" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setMovePlan" class="codecontainer">
|
|
<div id="setMovePlan" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setMovePlan(<span class="type">BlockPlan</span>
|
|
<span class="parameter">plan</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setMovePlan" class="">
|
|
<p>
|
|
Set the new plan of the entity. The entity will get deleted if the plan is empty. This moves
|
|
all
|
|
the data out of the plan that is used as the first argument. The content of the plan given
|
|
as
|
|
argument is then undefined, but still valid. It might be empty, it might contain the
|
|
previous plan.
|
|
This operation is independent of the size of the plan, use it when you have to set large
|
|
plans with
|
|
lots of blocks. <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">plan</span>
|
|
The new BlockPlan of the entity <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setPlan" class="codecontainer">
|
|
<div id="setPlan" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setPlan(<span class="type">BlockPlan</span> <span
|
|
class="parameter">plan</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setPlan" class="">
|
|
<p>
|
|
Set the new plan of the entity. The entity will get deleted if the plan is empty. This
|
|
copies the
|
|
entire plan that is given as argument, keep that in mind when setting plans with large block
|
|
counts. <span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">plan</span>
|
|
The new BlockPlan of the entity <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setTitle" class="codecontainer">
|
|
<div id="setTitle" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setTitle(<span class="type">string</span> <span
|
|
class="parameter">title</span>, <span class="type">string_pair...</span> <span
|
|
class="parameter">arguments</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setTitle" class="">
|
|
<p>
|
|
Sets the title that can be used as title in menus <span class="inheritedcode">Inherited from
|
|
<a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">title</span>
|
|
a string that will be used as title, can be a format string for easier translation.</br>
|
|
<br />
|
|
<span class="parameter">arguments</span>
|
|
Set the string arguments (if format string is used) as vector of string_pair. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setTitleArguments" class="codecontainer">
|
|
<div id="setTitleArguments" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setTitleArguments(<span
|
|
class="type">string_pair...</span> <span class="parameter">arguments</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setTitleArguments" class="">
|
|
<p>
|
|
Sets the arguments to a title <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">arguments</span>
|
|
Set the string arguments as vector of string_pair. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setTurretSize" class="codecontainer">
|
|
<div id="setTurretSize" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setTurretSize(<span class="type">float</span>
|
|
<span class="parameter">in</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setTurretSize" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setTurretTurningSpeed" class="codecontainer">
|
|
<div id="setTurretTurningSpeed" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setTurretTurningSpeed(<span
|
|
class="type">float</span>
|
|
<span class="parameter">in</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setTurretTurningSpeed" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setValue" class="codecontainer">
|
|
<div id="setValue" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setValue(<span class="type">string</span> <span
|
|
class="parameter">key</span>, <span class="type">var</span> <span
|
|
class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setValue" class="">
|
|
<p>
|
|
Sets a custom value <span class="inheritedcode">Inherited from <a
|
|
href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">key</span>
|
|
A string that serves as the name of the value <br />
|
|
<span class="parameter">value</span>
|
|
The value to save. Must be bool, number, string or nil. If nil is given, the value will be
|
|
deleted.
|
|
<br />
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="singleFlyToLocationTick" class="codecontainer">
|
|
<div id="singleFlyToLocationTick" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> singleFlyToLocationTick(<span
|
|
class="type">vec3</span>
|
|
<span class="parameter">location</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="singleFlyToLocationTick" class="">
|
|
<p>
|
|
Tells the ship to fly to given location, directly and without pathfinding. <span
|
|
class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">location</span>
|
|
the location to fly to (in global coordinates) Paired with setting desiredVelocity to 0,
|
|
this can
|
|
be used to rotate the ship to a given direction. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="unregisterCallback" class="codecontainer">
|
|
<div id="unregisterCallback" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> unregisterCallback(<span
|
|
class="type">string</span> <span class="parameter">callbackName</span>, <span
|
|
class="type">string</span> <span class="parameter">functionName</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="unregisterCallback" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="updateProductionCatchingUp" class="codecontainer">
|
|
<div id="updateProductionCatchingUp" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> updateProductionCatchingUp(<span
|
|
class="type">float</span> <span class="parameter">float</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="updateProductionCatchingUp" class="">
|
|
<p>
|
|
Simulates production catching up. This is used when ships return from the background
|
|
simulation.
|
|
Updates fighter production, academy and cloning. <span class="inheritedcode">Inherited from
|
|
<a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">float</span>
|
|
timePassed The amount of time that should be simulated <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="waitUntilAsyncWorkFinished" class="codecontainer">
|
|
<div id="waitUntilAsyncWorkFinished" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> waitUntilAsyncWorkFinished(<span
|
|
class="type">var</span>
|
|
<span class="parameter">time</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="waitUntilAsyncWorkFinished" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Entity.html">Entity</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addAbsoluteBias" class="codecontainer">
|
|
<div id="addAbsoluteBias" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addAbsoluteBias(<span class="type">int</span>
|
|
<span class="parameter">type</span>, <span class="type">float</span> <span
|
|
class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addAbsoluteBias" class="">
|
|
<p>
|
|
Adds a flat bias for stat of type <b>type</b>. This bias will be added to stat after
|
|
multipliers
|
|
are considered.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
Type of Bonus, e.g. acceleration, higher level crew <br />
|
|
<span class="parameter">value</span>
|
|
Bias added to base stats. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
key that can be used to access the multiplier
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addBaseMultiplier" class="codecontainer">
|
|
<div id="addBaseMultiplier" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addBaseMultiplier(<span class="type">int</span>
|
|
<span class="parameter">type</span>, <span class="type">float</span> <span
|
|
class="parameter">factor</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addBaseMultiplier" class="">
|
|
<p>
|
|
Adds a multiplyer for stat of type <b>type</b>. This is to increase a stat, so a factor of
|
|
0.3 will
|
|
become 1.3.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
Type of Bonus, e.g. acceleration, higher level crew <br />
|
|
<span class="parameter">factor</span>
|
|
Factor that is used as Multiplier <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
key that can be used to access the multiplier
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addCargo" class="codecontainer">
|
|
<div id="addCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function unsigned int</span> addCargo(<span
|
|
class="type">TradingGood</span>
|
|
<span class="parameter">good</span>, <span class="type">int</span> <span
|
|
class="parameter">amount</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addCargo" class="">
|
|
<p>
|
|
Adds cargo to the entity. If the amount specified exceeds the maximum capacity of the cargo
|
|
bay, as
|
|
much cargo as still fits in will be added.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">good</span>
|
|
TradingGood that is to be added. <br />
|
|
<span class="parameter">amount</span>
|
|
The amount of cargo that should be added. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
How much was actually added (can be less than amount when cargo bay is full)
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addCrew" class="codecontainer">
|
|
<div id="addCrew" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addCrew(<span class="type">int</span> <span
|
|
class="parameter">number</span>, <span class="type">CrewMan</span> <span
|
|
class="parameter">crewman</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addCrew" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addKeyedAbsoluteBias" class="codecontainer">
|
|
<div id="addKeyedAbsoluteBias" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addKeyedAbsoluteBias(<span class="type">int</span>
|
|
<span class="parameter">type</span>, <span class="type">int</span> <span
|
|
class="parameter">key</span>,
|
|
<span class="type">float</span> <span class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addKeyedAbsoluteBias" class="">
|
|
<p>
|
|
Exchanges flat bias at <b>key</b> with new value
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
Bonus type <br />
|
|
<span class="parameter">key</span>
|
|
Location of the bonus that will be changed <br />
|
|
<span class="parameter">value</span>
|
|
New value <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
key that can be used to access the multiplier
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addKeyedBaseMultiplier" class="codecontainer">
|
|
<div id="addKeyedBaseMultiplier" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addKeyedBaseMultiplier(<span
|
|
class="type">int</span>
|
|
<span class="parameter">type</span>, <span class="type">int</span> <span
|
|
class="parameter">key</span>, <span class="type">float</span> <span
|
|
class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addKeyedBaseMultiplier" class="">
|
|
<p>
|
|
Exchanges multiplier at <b>key</b> with new value
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
Bonus type <br />
|
|
<span class="parameter">key</span>
|
|
Location of the bonus that will be changed <br />
|
|
<span class="parameter">value</span>
|
|
New value <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
key that can be used to access the multiplier
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addKeyedMultiplier" class="codecontainer">
|
|
<div id="addKeyedMultiplier" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addKeyedMultiplier(<span class="type">int</span>
|
|
<span class="parameter">type</span>, <span class="type">int</span> <span
|
|
class="parameter">key</span>,
|
|
<span class="type">float</span> <span class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addKeyedMultiplier" class="">
|
|
<p>
|
|
Exchanges multiplier at <b>key</b> with new value
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
Bonus type <br />
|
|
<span class="parameter">key</span>
|
|
Location of the bonus that will be changed <br />
|
|
<span class="parameter">value</span>
|
|
New value <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
key that can be used to access the multiplier
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addKeyedMultiplyableBias" class="codecontainer">
|
|
<div id="addKeyedMultiplyableBias" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addKeyedMultiplyableBias(<span
|
|
class="type">int</span>
|
|
<span class="parameter">type</span>, <span class="type">int</span> <span
|
|
class="parameter">key</span>, <span class="type">float</span> <span
|
|
class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addKeyedMultiplyableBias" class="">
|
|
<p>
|
|
Exchanges bias at <b>key</b> with new value
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
Bonus type <br />
|
|
<span class="parameter">key</span>
|
|
Location of the bonus that will be changed <br />
|
|
<span class="parameter">value</span>
|
|
New value <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
key that can be used to access the multiplier
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addMultiplier" class="codecontainer">
|
|
<div id="addMultiplier" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addMultiplier(<span class="type">int</span> <span
|
|
class="parameter">type</span>, <span class="type">float</span> <span
|
|
class="parameter">factor</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addMultiplier" class="">
|
|
<p>
|
|
Adds a multiplyer for stat of type <b>type</b>. The factor will be used unchanged.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
Type of Bonus, e.g. acceleration, higher level crew <br />
|
|
<span class="parameter">factor</span>
|
|
Factor that is used as Multiplier <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
key that can be used to access the multiplier
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addMultiplyableBias" class="codecontainer">
|
|
<div id="addMultiplyableBias" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addMultiplyableBias(<span class="type">int</span>
|
|
<span class="parameter">type</span>, <span class="type">float</span> <span
|
|
class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addMultiplyableBias" class="">
|
|
<p>
|
|
Adds a bias for stat of type <b>type</b>. This bias will be added to stat before multipliers
|
|
are
|
|
considered.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
Type of Bonus, e.g. acceleration, higher level crew <br />
|
|
<span class="parameter">value</span>
|
|
Bias added to base stats. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
key that can be used to access the multiplier
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addScript" class="codecontainer">
|
|
<div id="addScript" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addScript(<span class="type">string</span> <span
|
|
class="parameter">scriptPath</span>, <span class="type">var...</span> <span
|
|
class="parameter">arguments</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addScript" class="">
|
|
<p>
|
|
Adds a new script to an entity
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">scriptPath</span>
|
|
The path of the script that should be added <br />
|
|
<span class="parameter">arguments</span>
|
|
An arbitrary number of arguments that will be given to the 'initialize' function of the
|
|
added
|
|
script <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
0 on success, 1 if the entity could not be found
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addScriptOnce" class="codecontainer">
|
|
<div id="addScriptOnce" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addScriptOnce() <br />
|
|
</p>
|
|
</div>
|
|
<div id="addScriptOnce" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addTurret" class="codecontainer">
|
|
<div id="addTurret" class="function">
|
|
<p>
|
|
<span class="keyword">function Uuid</span> addTurret(<span
|
|
class="type">TurretTemplate</span> <span class="parameter">turret</span>, <span
|
|
class="type">Matrix</span> <span class="parameter">position</span>, <span
|
|
class="type">int</span> <span class="parameter">part</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addTurret" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="blockHyperspace" class="codecontainer">
|
|
<div id="blockHyperspace" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> blockHyperspace(<span class="type">float</span>
|
|
<span class="parameter">time</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="blockHyperspace" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="callbacksRegistered" class="codecontainer">
|
|
<div id="callbacksRegistered" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> callbacksRegistered(<span
|
|
class="type">string</span>
|
|
<span class="parameter">callbackName</span>, <span class="type">var</span> <span
|
|
class="parameter">functionName</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="callbacksRegistered" class="">
|
|
<p>
|
|
Check how many functions are registered to a callback from the current script VM.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">callbackName</span>
|
|
The name of the callback <br />
|
|
<span class="parameter">functionName</span>
|
|
The name of the function for which to check. If nil, will count all functions that are
|
|
registered
|
|
to this callback. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
The amount of functions registered to the callback
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="canAddCrew" class="codecontainer">
|
|
<div id="canAddCrew" class="function">
|
|
<p>
|
|
<span class="keyword">function var, var, table<int, string></span> canAddCrew(<span
|
|
class="type">int</span> <span class="parameter">number</span>, <span
|
|
class="type">int</span>
|
|
<span class="parameter">profession</span>, <span class="type">bool</span> <span
|
|
class="parameter">change</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="canAddCrew" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="changeCrew" class="codecontainer">
|
|
<div id="changeCrew" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> changeCrew(<span class="type">int</span> <span
|
|
class="parameter">number</span>, <span class="type">int</span> <span
|
|
class="parameter">profession</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="changeCrew" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="changeShield" class="codecontainer">
|
|
<div id="changeShield" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> changeShield(<span class="type">double</span>
|
|
<span class="parameter">delta</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="changeShield" class="">
|
|
<p>
|
|
Adds delta to shield durability
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">delta</span>
|
|
<br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="clearCargoBay" class="codecontainer">
|
|
<div id="clearCargoBay" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> clearCargoBay() <br />
|
|
</p>
|
|
</div>
|
|
<div id="clearCargoBay" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="clearValues" class="codecontainer">
|
|
<div id="clearValues" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> clearValues() <br />
|
|
</p>
|
|
</div>
|
|
<div id="clearValues" class="">
|
|
<p>
|
|
Removes all custom values of the object
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="damageShield" class="codecontainer">
|
|
<div id="damageShield" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> damageShield(<span class="type">double</span>
|
|
<span class="parameter">amount</span>, <span class="type">vec3</span> <span
|
|
class="parameter">location</span>, <span class="type">Uuid</span> <span
|
|
class="parameter">inflictorId</span>, <span class="type">var</span> <span
|
|
class="parameter">damageSource</span>, <span class="type">var</span> <span
|
|
class="parameter">damageType</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="damageShield" class="">
|
|
<p>
|
|
Damages shield by delta amount, location and inflictorId are not necessary, but can be added
|
|
if it
|
|
is needed, e.g. you want to do effects on hitpoint.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">delta</span>
|
|
<br />
|
|
<span class="parameter">location</span>
|
|
<br />
|
|
<span class="parameter">inflictorId</span>
|
|
<br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="destroy" class="codecontainer">
|
|
<div id="destroy" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> destroy(<span class="type">Uuid</span> <span
|
|
class="parameter">inflictorId</span>, <span class="type">var</span> <span
|
|
class="parameter">damageSource</span>, <span class="type">var</span> <span
|
|
class="parameter">damageType</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="destroy" class="">
|
|
<p>
|
|
Destroy entity by inflicting more damage than durability of entity
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">inflictorId</span>
|
|
Index of the entity that destroys the block <br />
|
|
<span class="parameter">damageSource</span>
|
|
Source of damage. Can be Weaponry, Collision, Decay, Torpedo or Arbitrary. * <br />
|
|
<span class="parameter">damageType</span>
|
|
Type of damage received. Damage can be of type Physical, Energy, Electric, Plasma,
|
|
AntiMatter or
|
|
Fragments. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="destroyBlock" class="codecontainer">
|
|
<div id="destroyBlock" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> destroyBlock(<span class="type">int</span> <span
|
|
class="parameter">index</span>, <span class="type">Uuid</span> <span
|
|
class="parameter">inflictorId</span>, <span class="type">var</span> <span
|
|
class="parameter">damageSource</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="destroyBlock" class="">
|
|
<p>
|
|
Destroy one block
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">index</span>
|
|
Index of the block that is destroyed <br />
|
|
<span class="parameter">inflictorId</span>
|
|
Index of the entity that destroys the block <br />
|
|
<span class="parameter">damageSource</span>
|
|
Source of damage. Can be Weaponry, Collision, Decay, Torpedo or Arbitrary. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="destroyCargo" class="codecontainer">
|
|
<div id="destroyCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> destroyCargo(<span class="type">float</span> <span
|
|
class="parameter">volume</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="destroyCargo" class="">
|
|
<p>
|
|
Destroys cargo. The destruction distribution is generally equal over all goods.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">volume</span>
|
|
The amount of volume that should be destroyed. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="disableFlightAssistFor" class="codecontainer">
|
|
<div id="disableFlightAssistFor" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> disableFlightAssistFor(<span
|
|
class="type">float</span>
|
|
<span class="parameter">time</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="disableFlightAssistFor" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="distortHyperspace" class="codecontainer">
|
|
<div id="distortHyperspace" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> distortHyperspace(<span class="type">float</span>
|
|
<span class="parameter">time</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="distortHyperspace" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="findCargos" class="codecontainer">
|
|
<div id="findCargos" class="function">
|
|
<p>
|
|
<span class="keyword">function table<TradingGood, int></span> findCargos(<span
|
|
class="type">string</span> <span class="parameter">name</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="findCargos" class="">
|
|
<p>
|
|
Finds all cargos with the given name.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
A string that will be matched with the 'name' property of the cargos. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
A map containing all matching goods, with the good as key and amount as value.
|
|
</p>
|
|
</div>
|
|
</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">seat</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getAimedPositionBySeat" class="">
|
|
</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>
|
|
</div>
|
|
</div>
|
|
<div id="getAllowedArbitraryTurrets" class="codecontainer">
|
|
<div id="getAllowedArbitraryTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getAllowedArbitraryTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getAllowedArbitraryTurrets" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getAllowedArmedTurrets" class="codecontainer">
|
|
<div id="getAllowedArmedTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getAllowedArmedTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getAllowedArmedTurrets" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getAllowedUnarmedTurrets" class="codecontainer">
|
|
<div id="getAllowedUnarmedTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getAllowedUnarmedTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getAllowedUnarmedTurrets" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getAttachedBlockIndex" class="codecontainer">
|
|
<div id="getAttachedBlockIndex" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getAttachedBlockIndex() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getAttachedBlockIndex" class="">
|
|
<p>
|
|
Returns the Index of the block that the turret is build on
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getBoostedValue" class="codecontainer">
|
|
<div id="getBoostedValue" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getBoostedValue(<span class="type">int</span>
|
|
<span class="parameter">type</span>, <span class="type">float</span> <span
|
|
class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getBoostedValue" class="">
|
|
<p>
|
|
Returns value with included bonus, in case a bonus exists. Returns Nil if no bonuses at all,
|
|
returns value if no bonuses for this stat exist.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">type</span>
|
|
type of bonus stat, e.g. acceleration, higher level crew <br />
|
|
<span class="parameter">value</span>
|
|
the value, that might be changed by bonuses <br />
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getBoundingBox" class="codecontainer">
|
|
<div id="getBoundingBox" class="function">
|
|
<p>
|
|
<span class="keyword">function Box</span> getBoundingBox() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getBoundingBox" class="">
|
|
<p>
|
|
Returns Bounding Box for entity, use this if you need exact Bounding Box, e.g. for collision
|
|
detection when entities are close to each other.
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getBoundingSphere" class="codecontainer">
|
|
<div id="getBoundingSphere" class="function">
|
|
<p>
|
|
<span class="keyword">function Sphere</span> getBoundingSphere() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getBoundingSphere" class="">
|
|
<p>
|
|
Returns Bounding Sphere for entity. Much faster than Bounding Box, but not as accurate. Use
|
|
this if
|
|
you need to check often.
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCaptain" class="codecontainer">
|
|
<div id="getCaptain" class="function">
|
|
<p>
|
|
<span class="keyword">function Captain</span> getCaptain() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCaptain" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCargo" class="codecontainer">
|
|
<div id="getCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function TradingGood, int...</span> getCargo(<span
|
|
class="type">unsigned
|
|
int</span> <span class="parameter">n</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCargo" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCargoAmount" class="codecontainer">
|
|
<div id="getCargoAmount" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> getCargoAmount(<span class="type">var</span> <span
|
|
class="parameter">name</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCargoAmount" class="">
|
|
<p>
|
|
Counts all goods of the given type. When given a string, it will match the 'name' property
|
|
of the
|
|
goods. When given a TradingGood it will match the exact good.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
Either a TradingGood or a string containing the name of a trading good. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
The number of goods
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCargos" class="codecontainer">
|
|
<div id="getCargos" class="function">
|
|
<p>
|
|
<span class="keyword">function table<TradingGood, int></span> getCargos() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCargos" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCrewMembers" class="codecontainer">
|
|
<div id="getCrewMembers" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getCrewMembers(<span class="type">int</span> <span
|
|
class="parameter">profession</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCrewMembers" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getDamageContributorPlayerFactions" class="codecontainer">
|
|
<div id="getDamageContributorPlayerFactions" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getDamageContributorPlayerFactions() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getDamageContributorPlayerFactions" class="">
|
|
<p>
|
|
Lists all players and alliances that contributed damage to the entity
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
Indices of all players and alliances that contributed damage to the entity
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getDamageContributorPlayers" class="codecontainer">
|
|
<div id="getDamageContributorPlayers" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getDamageContributorPlayers() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getDamageContributorPlayers" class="">
|
|
<p>
|
|
Lists all players that contributed damage to the entity
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
Indices of all players that contributed damage to the entity
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getDamageContributors" class="codecontainer">
|
|
<div id="getDamageContributors" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getDamageContributors() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getDamageContributors" class="">
|
|
<p>
|
|
Lists all factions that contributed damage to the entity
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
Indices of all factions that contributed damage to the entity
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getDockedGroupBoundingBox" class="codecontainer">
|
|
<div id="getDockedGroupBoundingBox" class="function">
|
|
<p>
|
|
<span class="keyword">function Box</span> getDockedGroupBoundingBox() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getDockedGroupBoundingBox" class="">
|
|
<p>
|
|
Returns Bounding Box for entity, but enlarged to also fit around all docked objects. Use
|
|
this if
|
|
you need exact Bounding Box, e.g. for collision detection when entities are close to each
|
|
other.
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getDockedGroupBoundingSphere" class="codecontainer">
|
|
<div id="getDockedGroupBoundingSphere" class="function">
|
|
<p>
|
|
<span class="keyword">function Sphere</span> getDockedGroupBoundingSphere() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getDockedGroupBoundingSphere" class="">
|
|
<p>
|
|
Returns Bounding Box for entity, but enlarged to also fit around all docked objects. Use
|
|
this if
|
|
you need exact Bounding Box, e.g. for collision detection when entities are close to each
|
|
other.
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getDockingPositions" class="codecontainer">
|
|
<div id="getDockingPositions" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getDockingPositions() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getDockingPositions" class="">
|
|
<p>
|
|
Lists all docking positions that the entity has
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
A table that contains a key-value pair (id, table) for each dock: <id, {position,
|
|
direction, id}>
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getFreeArbitraryTurrets" class="codecontainer">
|
|
<div id="getFreeArbitraryTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getFreeArbitraryTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getFreeArbitraryTurrets" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getFreeArmedTurrets" class="codecontainer">
|
|
<div id="getFreeArmedTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getFreeArmedTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getFreeArmedTurrets" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getFreeUnarmedTurrets" class="codecontainer">
|
|
<div id="getFreeUnarmedTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getFreeUnarmedTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getFreeUnarmedTurrets" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getFullPlanCopy" class="codecontainer">
|
|
<div id="getFullPlanCopy" class="function">
|
|
<p>
|
|
<span class="keyword">function BlockPlan</span> getFullPlanCopy() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getFullPlanCopy" class="">
|
|
<p>
|
|
Returns the plan of the entity. This copies the entire plan, keep that in mind when using
|
|
plans
|
|
with large block counts.
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
A copy of the plan of the entity
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getLowestMineableMaterial" class="codecontainer">
|
|
<div id="getLowestMineableMaterial" class="function">
|
|
<p>
|
|
<span class="keyword">function Material</span> getLowestMineableMaterial() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getLowestMineableMaterial" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getMalusFactor" class="codecontainer">
|
|
<div id="getMalusFactor" class="function">
|
|
<p>
|
|
<span class="keyword">function var, var</span> getMalusFactor() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getMalusFactor" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getMineableMaterial" class="codecontainer">
|
|
<div id="getMineableMaterial" class="function">
|
|
<p>
|
|
<span class="keyword">function Material</span> getMineableMaterial() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getMineableMaterial" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getMineableResources" class="codecontainer">
|
|
<div id="getMineableResources" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getMineableResources() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getMineableResources" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getMoneyLootAmount" class="codecontainer">
|
|
<div id="getMoneyLootAmount" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> getMoneyLootAmount() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getMoneyLootAmount" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getMovePlan" class="codecontainer">
|
|
<div id="getMovePlan" class="function">
|
|
<p>
|
|
<span class="keyword">function BlockPlan</span> getMovePlan() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getMovePlan" class="">
|
|
<p>
|
|
Returns the plan of the entity. This function will move the plan out of the entity, and
|
|
replace the
|
|
entity's plan with a single block. This operation is independent of the size of the plan,
|
|
use it
|
|
when you have to get large plans with lots of blocks.
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
The plan of the entity
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getNearestDistance" class="codecontainer">
|
|
<div id="getNearestDistance" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getNearestDistance(<span
|
|
class="type">Entity</span> <span class="parameter">other</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getNearestDistance" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getNumArmedTurrets" class="codecontainer">
|
|
<div id="getNumArmedTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getNumArmedTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getNumArmedTurrets" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getNumMiningTurrets" class="codecontainer">
|
|
<div id="getNumMiningTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getNumMiningTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getNumMiningTurrets" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getNumSalvagingTurrets" class="codecontainer">
|
|
<div id="getNumSalvagingTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getNumSalvagingTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getNumSalvagingTurrets" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getNumUnarmedTurrets" class="codecontainer">
|
|
<div id="getNumUnarmedTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getNumUnarmedTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getNumUnarmedTurrets" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getPilotIndices" class="codecontainer">
|
|
<div id="getPilotIndices" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getPilotIndices() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getPilotIndices" class="">
|
|
<p>
|
|
Returns Indices of piloting players
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
multiple return values: indices of players
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getPlanMoneyValue" class="codecontainer">
|
|
<div id="getPlanMoneyValue" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getPlanMoneyValue() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getPlanMoneyValue" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getPlanResourceValue" class="codecontainer">
|
|
<div id="getPlanResourceValue" class="function">
|
|
<p>
|
|
<span class="keyword">function double...</span> getPlanResourceValue() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getPlanResourceValue" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getResourceLootAmount" class="codecontainer">
|
|
<div id="getResourceLootAmount" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> getResourceLootAmount() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getResourceLootAmount" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getScripts" class="codecontainer">
|
|
<div id="getScripts" class="function">
|
|
<p>
|
|
<span class="keyword">function table<int, string></span> getScripts() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getScripts" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTitleArguments" class="codecontainer">
|
|
<div id="getTitleArguments" class="function">
|
|
<p>
|
|
<span class="keyword">function table<string, string></span> getTitleArguments() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTitleArguments" class="">
|
|
<p>
|
|
Retrieves the arguments to a title
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTitleFormat" class="codecontainer">
|
|
<div id="getTitleFormat" class="function">
|
|
<p>
|
|
<span class="keyword">function NamedFormat</span> getTitleFormat() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTitleFormat" class="">
|
|
<p>
|
|
Retrieves the title as NamedFormat
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTurret" class="codecontainer">
|
|
<div id="getTurret" class="function">
|
|
<p>
|
|
<span class="keyword">function Entity</span> getTurret(<span class="type">int</span> <span
|
|
class="parameter">index</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTurret" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTurretPositions" class="codecontainer">
|
|
<div id="getTurretPositions" class="function">
|
|
<p>
|
|
<span class="keyword">function Matrix, int...</span> getTurretPositions(<span
|
|
class="type">TurretTemplate</span> <span class="parameter">turret</span>, <span
|
|
class="type">int</span> <span class="parameter">number</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTurretPositions" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTurretPositionsLineOfSight" class="codecontainer">
|
|
<div id="getTurretPositionsLineOfSight" class="function">
|
|
<p>
|
|
<span class="keyword">function Matrix, int...</span> getTurretPositionsLineOfSight(<span
|
|
class="type">TurretTemplate</span> <span class="parameter">turret</span>, <span
|
|
class="type">int</span> <span class="parameter">number</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTurretPositionsLineOfSight" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTurrets" class="codecontainer">
|
|
<div id="getTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function Entity...</span> getTurrets() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTurrets" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTurretSize" class="codecontainer">
|
|
<div id="getTurretSize" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getTurretSize() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTurretSize" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTurretTemplateSize" class="codecontainer">
|
|
<div id="getTurretTemplateSize" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getTurretTemplateSize() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTurretTemplateSize" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTurretTurningSpeed" class="codecontainer">
|
|
<div id="getTurretTurningSpeed" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getTurretTurningSpeed() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getTurretTurningSpeed" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getUndamagedPlanMoneyValue" class="codecontainer">
|
|
<div id="getUndamagedPlanMoneyValue" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getUndamagedPlanMoneyValue() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getUndamagedPlanMoneyValue" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getUndamagedPlanResourceValue" class="codecontainer">
|
|
<div id="getUndamagedPlanResourceValue" class="function">
|
|
<p>
|
|
<span class="keyword">function double...</span> getUndamagedPlanResourceValue() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getUndamagedPlanResourceValue" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getValue" class="codecontainer">
|
|
<div id="getValue" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> getValue(<span class="type">string</span> <span
|
|
class="parameter">key</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getValue" class="">
|
|
<p>
|
|
Retrieves a custom value saved in the entity with the given key
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">key</span>
|
|
A string that serves as the name of the value <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
The value if the key exists, otherwise nil
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getValues" class="codecontainer">
|
|
<div id="getValues" class="function">
|
|
<p>
|
|
<span class="keyword">function table<string, var></span> getValues() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getValues" class="">
|
|
<p>
|
|
Retrieves all key-value pairs of custom values of the entity
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
A table containing all custom key-value pairs
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="hasComponent" class="codecontainer">
|
|
<div id="hasComponent" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> hasComponent(<span class="type">int</span> <span
|
|
class="parameter">type</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="hasComponent" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="hasScript" class="codecontainer">
|
|
<div id="hasScript" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> hasScript(<span class="type">string</span> <span
|
|
class="parameter">name</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="hasScript" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="heal" class="codecontainer">
|
|
<div id="heal" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> heal(<span class="type">float</span> <span
|
|
class="parameter">damage</span>, <span class="type">int</span> <span
|
|
class="parameter">index</span>, <span class="type">vec3</span> <span
|
|
class="parameter">location</span>, <span class="type">Uuid</span> <span
|
|
class="parameter">inflictorID</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="heal" class="">
|
|
<p>
|
|
Increases durability of the plan of the Entity
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">damage</span>
|
|
The amount of durability that will be restored <br />
|
|
<span class="parameter">index</span>
|
|
Index of the block that will be restored <br />
|
|
<span class="parameter">location</span>
|
|
vector containing the hit point, if unknown/unnecessary use empty vector <br />
|
|
<span class="parameter">inflictorID</span>
|
|
Index of the entity that heals <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="healShield" class="codecontainer">
|
|
<div id="healShield" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> healShield(<span class="type">double</span> <span
|
|
class="parameter">delta</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="healShield" class="">
|
|
<p>
|
|
Increases shield durability by delta
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">delta</span>
|
|
<br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="hyperspaceBlocked" class="codecontainer">
|
|
<div id="hyperspaceBlocked" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> hyperspaceBlocked() <br />
|
|
</p>
|
|
</div>
|
|
<div id="hyperspaceBlocked" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="inflictDamage" class="codecontainer">
|
|
<div id="inflictDamage" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> inflictDamage(<span class="type">float</span>
|
|
<span class="parameter">damage</span>, <span class="type">var</span> <span
|
|
class="parameter">damageSource</span>, <span class="type">var</span> <span
|
|
class="parameter">damageType</span>, <span class="type">int</span> <span
|
|
class="parameter">index</span>, <span class="type">vec3</span> <span
|
|
class="parameter">location</span>, <span class="type">Uuid</span> <span
|
|
class="parameter">inflictorId</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="inflictDamage" class="">
|
|
<p>
|
|
Inflicts damage to the plan of the Entity
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">damage</span>
|
|
The amount of damage that will be dealt <br />
|
|
<span class="parameter">damageSource</span>
|
|
The source of the damage. Can be Weaponry, Collision, Decay, Torpedo or Arbitrary. <br />
|
|
<span class="parameter">damageType</span>
|
|
Type of damage received. Damage can be of type Physical, Energy, Electric, Plasma,
|
|
AntiMatter or
|
|
Fragments <br />
|
|
<span class="parameter">index</span>
|
|
Index of the block that will receive the damage <br />
|
|
<span class="parameter">location</span>
|
|
vector containing the hit point, if unknown / unnecessary use empty vector <br />
|
|
<span class="parameter">inflictorId</span>
|
|
Index of the entity that caused the damage <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="invokeFunction" class="codecontainer">
|
|
<div id="invokeFunction" class="function">
|
|
<p>
|
|
<span class="keyword">function var...</span> invokeFunction(<span class="type">var</span>
|
|
<span class="parameter">scriptName</span>, <span class="type">string</span> <span
|
|
class="parameter">functionName</span>, <span class="type">var...</span> <span
|
|
class="parameter">arguments</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="invokeFunction" class="">
|
|
<p>
|
|
Invokes a function in a script of the entity. Use this function to invoke functions from one
|
|
script
|
|
in another script. The first return value of the function is an integer indicating whether
|
|
or not
|
|
the call was successful. When it was, this integer is followed by the return values of the
|
|
invoked
|
|
function.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">scriptName</span>
|
|
The name or index of the script containing the function <br />
|
|
<span class="parameter">functionName</span>
|
|
The name of the function that will be executed <br />
|
|
<span class="parameter">arguments</span>
|
|
An arbitrary list of arguments that will be given to the invoked function <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
Returns at least 1 value indicating if the call succeeded:<br /> 0 The call was
|
|
successful. In
|
|
this case, the return values of the script are returned in addition to the call result,
|
|
following the call result<br /> 1 The call failed because the entity with the specified
|
|
index
|
|
does not exist or has no Scripts component<br /> 2 The call failed because it came from
|
|
another
|
|
sector than the entity is in<br /> 3 The call failed because the given script was not
|
|
found in
|
|
the entity<br /> 4 The call failed because the given function was not found in the
|
|
script <br />
|
|
5 The call failed because the script's state has errors and is invalid <br />
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isCollectable" class="codecontainer">
|
|
<div id="isCollectable" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> isCollectable(<span class="type">Entity</span>
|
|
<span class="parameter">entity</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="isCollectable" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isInDockingArea" class="codecontainer">
|
|
<div id="isInDockingArea" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> isInDockingArea(<span class="type">Entity</span>
|
|
<span class="parameter">other</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="isInDockingArea" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isInsideShield" class="codecontainer">
|
|
<div id="isInsideShield" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> isInsideShield(<span class="type">vec3</span>
|
|
<span class="parameter">point</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="isInsideShield" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isJumpRouteValid" class="codecontainer">
|
|
<div id="isJumpRouteValid" class="function">
|
|
<p>
|
|
<span class="keyword">function bool, var</span> isJumpRouteValid(<span
|
|
class="type">int</span>
|
|
<span class="parameter">fromX</span>, <span class="type">int</span> <span
|
|
class="parameter">fromY</span>, <span class="type">int</span> <span
|
|
class="parameter">toX</span>, <span class="type">int</span> <span
|
|
class="parameter">toY</span>)
|
|
<br />
|
|
</p>
|
|
</div>
|
|
<div id="isJumpRouteValid" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isManned" class="codecontainer">
|
|
<div id="isManned" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> isManned() <br />
|
|
</p>
|
|
</div>
|
|
<div id="isManned" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isTurretAllowed" class="codecontainer">
|
|
<div id="isTurretAllowed" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> isTurretAllowed(<span
|
|
class="type">TurretTemplate</span>
|
|
<span class="parameter">ScriptTurretTemplate</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="isTurretAllowed" class="">
|
|
<p>
|
|
Tests if the maximum number of turrets of this kind is not reached
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">ScriptTurretTemplate</span>
|
|
the template of the turret to be placed <br />
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="jumpPossible" class="codecontainer">
|
|
<div id="jumpPossible" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> jumpPossible(<span class="type">int</span> <span
|
|
class="parameter">x</span>, <span class="type">int</span> <span
|
|
class="parameter">y</span>)
|
|
<br />
|
|
</p>
|
|
</div>
|
|
<div id="jumpPossible" class="">
|
|
<p>
|
|
Tests if the entity can jump to the specified coordinates
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">x</span>
|
|
The x-coordinates of the target sector <br />
|
|
<span class="parameter">y</span>
|
|
The y-coordinates of the target sector <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
Returns an error code:<br /> -1 The entity doesn't have a hyperspace drive.<br /> 0 The
|
|
entity
|
|
can jump.<br /> 1 The hyperspace drive needs to recharge.<br /> 2 The target sector is
|
|
too far
|
|
away.<br /> 3 The entity is facing the wrong direction.<br /> 4 The hyperspace drive is
|
|
being
|
|
jammed.<br />
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="moveBy" class="codecontainer">
|
|
<div id="moveBy" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> moveBy(<span class="type">vec3</span> <span
|
|
class="parameter">delta</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="moveBy" class="">
|
|
<p>
|
|
Teleports entity by vector
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="registerCallback" class="codecontainer">
|
|
<div id="registerCallback" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> registerCallback(<span class="type">string</span>
|
|
<span class="parameter">callbackName</span>, <span class="type">string</span> <span
|
|
class="parameter">functionName</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="registerCallback" class="">
|
|
<p>
|
|
Register a callback in the entity. The callback receiver has to be inside the same sector
|
|
for the
|
|
registration to succeed. The callback will be removed if either the entity or the receiver
|
|
leaves
|
|
the sector or gets destroyed. Double registration of callbacks doesn't work. When the same
|
|
callback
|
|
to the same callback of the same script instance is registered twice, it will still only be
|
|
called
|
|
once.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">callbackName</span>
|
|
The name of the callback <br />
|
|
<span class="parameter">functionName</span>
|
|
The name of the function that will be executed in the script when the callback happens
|
|
<br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
0 on success, 1 if the registration failed
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="registerDamage" class="codecontainer">
|
|
<div id="registerDamage" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> registerDamage(<span class="type">Uuid</span>
|
|
<span class="parameter">shooterId</span>, <span class="type">double</span> <span
|
|
class="parameter">damage</span>, <span class="type">DamageSource</span> <span
|
|
class="parameter">DamageSource</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="registerDamage" class="">
|
|
<p>
|
|
Registers artificial damage as if the entity was damaged by the shooter
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">shooterId</span>
|
|
The id of the entity that inflicted the damage <br />
|
|
<span class="parameter">damage</span>
|
|
The amount of damage inflicted <br />
|
|
<span class="parameter">DamageSource</span>
|
|
The kind of source for the damage <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeBonus" class="codecontainer">
|
|
<div id="removeBonus" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeBonus(<span class="type">int</span> <span
|
|
class="parameter">key</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="removeBonus" class="">
|
|
<p>
|
|
Deletes bonus
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">key</span>
|
|
Location of the bonus <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeCargo" class="codecontainer">
|
|
<div id="removeCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeCargo(<span class="type">var</span> <span
|
|
class="parameter">good</span>, <span class="type">int</span> <span
|
|
class="parameter">amount</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="removeCargo" class="">
|
|
<p>
|
|
Removes cargo from the entity. When given a TradingGood, an exact check for that good will
|
|
be
|
|
performed. When given a string, only a name check will be performed, and which cargo will be
|
|
removed first is undefined if there are multiple goods with the same name. An example would
|
|
be
|
|
Energy Cells vs. Stolen Energy Cells. The 'name' property is the same, but the 'stolen'
|
|
property is
|
|
different.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">good</span>
|
|
Either a TradingGood or a string with the name of a good. <br />
|
|
<span class="parameter">amount</span>
|
|
The amount of cargo that should be removed. If this is more than there is on the ship, all
|
|
specified cargo will be removed. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeCrew" class="codecontainer">
|
|
<div id="removeCrew" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeCrew(<span class="type">int</span> <span
|
|
class="parameter">number</span>, <span class="type">CrewMan</span> <span
|
|
class="parameter">crewman</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="removeCrew" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeScript" class="codecontainer">
|
|
<div id="removeScript" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeScript(<span class="type">var</span> <span
|
|
class="parameter">script</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="removeScript" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeScriptBonuses" class="codecontainer">
|
|
<div id="removeScriptBonuses" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeScriptBonuses() <br />
|
|
</p>
|
|
</div>
|
|
<div id="removeScriptBonuses" class="">
|
|
<p>
|
|
Deletes all bonuses added by the current script
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="resolveScriptPath" class="codecontainer">
|
|
<div id="resolveScriptPath" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> resolveScriptPath(<span class="type">string</span>
|
|
<span class="parameter">path</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="resolveScriptPath" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="sendCallback" class="codecontainer">
|
|
<div id="sendCallback" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> sendCallback() <br />
|
|
</p>
|
|
</div>
|
|
<div id="sendCallback" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setAccumulatingBlockHealth" class="codecontainer">
|
|
<div id="setAccumulatingBlockHealth" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setAccumulatingBlockHealth(<span
|
|
class="type">bool</span>
|
|
<span class="parameter">bool</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setAccumulatingBlockHealth" class="">
|
|
<p>
|
|
If AccumulatingBlockHealth is true, a block needs to take as much damage as would be
|
|
necessary to
|
|
destroy all its children before it itself is destroyed. If it is set to false, the entity's
|
|
blocks
|
|
will have only their own durability. Set it to false if you want your entity to easily break
|
|
apart,
|
|
e.g. for wreckages.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">bool</span>
|
|
<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">int</span>
|
|
<span class="parameter">seat</span>, <span class="type">vec3</span> <span
|
|
class="parameter">in</span>)
|
|
<br />
|
|
</p>
|
|
</div>
|
|
<div id="setAimedPosition" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setAttachedBlockIndex" class="codecontainer">
|
|
<div id="setAttachedBlockIndex" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setAttachedBlockIndex(<span
|
|
class="type">int</span> <span class="parameter">in</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setAttachedBlockIndex" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setCaptain" class="codecontainer">
|
|
<div id="setCaptain" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setCaptain(<span class="type">Captain [or
|
|
nil]</span>
|
|
<span class="parameter">captain</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setCaptain" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setDamageTypeMultiplier" class="codecontainer">
|
|
<div id="setDamageTypeMultiplier" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setDamageTypeMultiplier(<span
|
|
class="type">DamageType</span> <span class="parameter">type</span>, <span
|
|
class="type">float</span> <span class="parameter">factor</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setDamageTypeMultiplier" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setDropsAttachedTurrets" class="codecontainer">
|
|
<div id="setDropsAttachedTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setDropsAttachedTurrets(<span
|
|
class="type">bool</span>
|
|
<span class="parameter">bool</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setDropsAttachedTurrets" class="">
|
|
<p>
|
|
Sets the entities' ability to drop its attached turrets. If set to true (default) the ship
|
|
has a
|
|
chance to drop a turret that's attached to it when it's destroyed. This is only enabled for
|
|
NPC
|
|
entities.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">bool</span>
|
|
value if the dropping is enabled <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setDropsLoot" class="codecontainer">
|
|
<div id="setDropsLoot" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setDropsLoot(<span class="type">bool</span> <span
|
|
class="parameter">bool</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setDropsLoot" class="">
|
|
<p>
|
|
Sets the entities' ability to drop normal loot. Affects dropping of money, resources, cargo,
|
|
turrets and upgrades. 'Loot' component is not affected by this.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">bool</span>
|
|
value if the entity should drop loot or not <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setMalusFactor" class="codecontainer">
|
|
<div id="setMalusFactor" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setMalusFactor(<span class="type">float</span>
|
|
<span class="parameter">in</span>, <span class="type">int</span> <span
|
|
class="parameter">reason</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setMalusFactor" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setManned" class="codecontainer">
|
|
<div id="setManned" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setManned(<span class="type">bool</span> <span
|
|
class="parameter">in</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setManned" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setMovePlan" class="codecontainer">
|
|
<div id="setMovePlan" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setMovePlan(<span class="type">BlockPlan</span>
|
|
<span class="parameter">plan</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setMovePlan" class="">
|
|
<p>
|
|
Set the new plan of the entity. The entity will get deleted if the plan is empty. This moves
|
|
all
|
|
the data out of the plan that is used as the first argument. The content of the plan given
|
|
as
|
|
argument is then undefined, but still valid. It might be empty, it might contain the
|
|
previous plan.
|
|
This operation is independent of the size of the plan, use it when you have to set large
|
|
plans with
|
|
lots of blocks.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">plan</span>
|
|
The new BlockPlan of the entity <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setPlan" class="codecontainer">
|
|
<div id="setPlan" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setPlan(<span class="type">BlockPlan</span> <span
|
|
class="parameter">plan</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setPlan" class="">
|
|
<p>
|
|
Set the new plan of the entity. The entity will get deleted if the plan is empty. This
|
|
copies the
|
|
entire plan that is given as argument, keep that in mind when setting plans with large block
|
|
counts.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">plan</span>
|
|
The new BlockPlan of the entity <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setTitle" class="codecontainer">
|
|
<div id="setTitle" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setTitle(<span class="type">string</span> <span
|
|
class="parameter">title</span>, <span class="type">string_pair...</span> <span
|
|
class="parameter">arguments</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setTitle" class="">
|
|
<p>
|
|
Sets the title that can be used as title in menus
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">title</span>
|
|
a string that will be used as title, can be a format string for easier translation.</br>
|
|
<br />
|
|
<span class="parameter">arguments</span>
|
|
Set the string arguments (if format string is used) as vector of string_pair. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setTitleArguments" class="codecontainer">
|
|
<div id="setTitleArguments" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setTitleArguments(<span
|
|
class="type">string_pair...</span> <span class="parameter">arguments</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setTitleArguments" class="">
|
|
<p>
|
|
Sets the arguments to a title
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">arguments</span>
|
|
Set the string arguments as vector of string_pair. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setTurretSize" class="codecontainer">
|
|
<div id="setTurretSize" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setTurretSize(<span class="type">float</span>
|
|
<span class="parameter">in</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setTurretSize" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setTurretTurningSpeed" class="codecontainer">
|
|
<div id="setTurretTurningSpeed" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setTurretTurningSpeed(<span
|
|
class="type">float</span>
|
|
<span class="parameter">in</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setTurretTurningSpeed" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setValue" class="codecontainer">
|
|
<div id="setValue" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setValue(<span class="type">string</span> <span
|
|
class="parameter">key</span>, <span class="type">var</span> <span
|
|
class="parameter">value</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="setValue" class="">
|
|
<p>
|
|
Sets a custom value
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">key</span>
|
|
A string that serves as the name of the value <br />
|
|
<span class="parameter">value</span>
|
|
The value to save. Must be bool, number, string or nil. If nil is given, the value will be
|
|
deleted.
|
|
<br />
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="singleFlyToLocationTick" class="codecontainer">
|
|
<div id="singleFlyToLocationTick" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> singleFlyToLocationTick(<span
|
|
class="type">vec3</span>
|
|
<span class="parameter">location</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="singleFlyToLocationTick" class="">
|
|
<p>
|
|
Tells the ship to fly to given location, directly and without pathfinding.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">location</span>
|
|
the location to fly to (in global coordinates) Paired with setting desiredVelocity to 0,
|
|
this can
|
|
be used to rotate the ship to a given direction. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="unregisterCallback" class="codecontainer">
|
|
<div id="unregisterCallback" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> unregisterCallback(<span
|
|
class="type">string</span> <span class="parameter">callbackName</span>, <span
|
|
class="type">string</span> <span class="parameter">functionName</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="unregisterCallback" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="updateProductionCatchingUp" class="codecontainer">
|
|
<div id="updateProductionCatchingUp" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> updateProductionCatchingUp(<span
|
|
class="type">float</span> <span class="parameter">float</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="updateProductionCatchingUp" class="">
|
|
<p>
|
|
Simulates production catching up. This is used when ships return from the background
|
|
simulation.
|
|
Updates fighter production, academy and cloning.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">float</span>
|
|
timePassed The amount of time that should be simulated <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="waitUntilAsyncWorkFinished" class="codecontainer">
|
|
<div id="waitUntilAsyncWorkFinished" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> waitUntilAsyncWorkFinished(<span
|
|
class="type">var</span>
|
|
<span class="parameter">time</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="waitUntilAsyncWorkFinished" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isJumpRouteValid" class="codecontainer">
|
|
<div id="isJumpRouteValid" class="function">
|
|
<p>
|
|
<span class="keyword">function bool, var</span> isJumpRouteValid(<span
|
|
class="type">int</span>
|
|
<span class="parameter">fromX</span>, <span class="type">int</span> <span
|
|
class="parameter">fromY</span>, <span class="type">int</span> <span
|
|
class="parameter">toX</span>, <span class="type">int</span> <span
|
|
class="parameter">toY</span>)
|
|
<br />
|
|
</p>
|
|
</div>
|
|
<div id="isJumpRouteValid" class="">
|
|
<p>
|
|
Checks if a hyperspace route would be valid.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">fromX</span>
|
|
X coordinate of the origin <br />
|
|
<span class="parameter">fromY</span>
|
|
Y coordinate of the origin <br />
|
|
<span class="parameter">toX</span>
|
|
X coordinate of the destination <br />
|
|
<span class="parameter">toY</span>
|
|
Y coordinate of the destination <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
Returns a bool (true, false), and, if false, a string containing the reason why it's
|
|
invalid
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="block" class="codecontainer">
|
|
<div id="block" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> block(<span class="type">float</span> <span
|
|
class="parameter">time</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="block" class="">
|
|
<p>
|
|
Blocks the hyperspace engine for a certain time. While the hyperspace engine is blocked, it
|
|
can't
|
|
jump. For safety reasons, the hyperspace engine can only be blocked for a limited amount of
|
|
time.
|
|
You should only block it for a few seconds and then reblock it. Also sets the "clear space"
|
|
property to false.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">time</span>
|
|
The amount of time the engine will be blocked. Doesn't accumulate, overrides previous blocks
|
|
<br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="distort" class="codecontainer">
|
|
<div id="distort" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> distort(<span class="type">float</span> <span
|
|
class="parameter">time</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="distort" class="">
|
|
<p>
|
|
Distorts the hyperspace engine for a certain time. While the hyperspace engine is distorted,
|
|
it
|
|
takes 4x as long to recharge. For safety reasons, the hyperspace engine can only be
|
|
distorted for a
|
|
limited amount of time. You should only distort it for a few seconds and then redistort it.
|
|
Also
|
|
sets the "clear space" property to false.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">time</span>
|
|
The amount of time the engine will be distorted. Doesn't accumulate, overrides previous
|
|
distorts
|
|
<br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="exhaust" class="codecontainer">
|
|
<div id="exhaust" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> exhaust() <br />
|
|
</p>
|
|
</div>
|
|
<div id="exhaust" class="">
|
|
<p>
|
|
Exhausts the hyperspace engine as if when a jump happens.
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getJumpErrors" class="codecontainer">
|
|
<div id="getJumpErrors" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getJumpErrors(<span class="type">int</span>
|
|
<span class="parameter">x</span>, <span class="type">int</span> <span
|
|
class="parameter">y</span>)
|
|
<br />
|
|
</p>
|
|
</div>
|
|
<div id="getJumpErrors" class="">
|
|
<p>
|
|
Checks if a jump to a sector would be possible and returns all errors.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">x</span>
|
|
X coordinate of the destination <br />
|
|
<span class="parameter">y</span>
|
|
Y coordinate of the destination <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
a set of JumpError codes containing the reasons why the jump is not possible
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isJumpRouteValid" class="codecontainer">
|
|
<div id="isJumpRouteValid" class="function">
|
|
<p>
|
|
<span class="keyword">function bool, var</span> isJumpRouteValid(<span
|
|
class="type">int</span>
|
|
<span class="parameter">fromX</span>, <span class="type">int</span> <span
|
|
class="parameter">fromY</span>, <span class="type">int</span> <span
|
|
class="parameter">toX</span>, <span class="type">int</span> <span
|
|
class="parameter">toY</span>)
|
|
<br />
|
|
</p>
|
|
</div>
|
|
<div id="isJumpRouteValid" class="">
|
|
<p>
|
|
Checks if a hyperspace route would be valid.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">fromX</span>
|
|
X coordinate of the origin <br />
|
|
<span class="parameter">fromY</span>
|
|
Y coordinate of the origin <br />
|
|
<span class="parameter">toX</span>
|
|
X coordinate of the destination <br />
|
|
<span class="parameter">toY</span>
|
|
Y coordinate of the destination <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
Returns a bool (true, false), and, if false, a string containing the reason why it's
|
|
invalid
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="jump" class="codecontainer">
|
|
<div id="jump" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> jump(<span class="type">int</span> <span
|
|
class="parameter">x</span>, <span class="type">int</span> <span
|
|
class="parameter">y</span>)
|
|
<br />
|
|
</p>
|
|
</div>
|
|
<div id="jump" class="">
|
|
<p>
|
|
Initiates a hyperspace jump. This is what happens when the player presses space. This will
|
|
always
|
|
do the jump, no matter what.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">x</span>
|
|
X coordinate of the destination <br />
|
|
<span class="parameter">y</span>
|
|
Y coordinate of the destination <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="jumpPossible" class="codecontainer">
|
|
<div id="jumpPossible" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> jumpPossible(<span class="type">int</span> <span
|
|
class="parameter">x</span>, <span class="type">int</span> <span
|
|
class="parameter">y</span>)
|
|
<br />
|
|
</p>
|
|
</div>
|
|
<div id="jumpPossible" class="">
|
|
<p>
|
|
Checks if a jump to a sector would be possible.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">x</span>
|
|
X coordinate of the destination <br />
|
|
<span class="parameter">y</span>
|
|
Y coordinate of the destination <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
a JumpError code containing the reason why the jump is not possible
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="tryJump" class="codecontainer">
|
|
<div id="tryJump" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> tryJump(<span class="type">int</span> <span
|
|
class="parameter">x</span>, <span class="type">int</span> <span
|
|
class="parameter">y</span>)
|
|
<br />
|
|
</p>
|
|
</div>
|
|
<div id="tryJump" class="">
|
|
<p>
|
|
Tries to initiate a hyperspace jump. This is what happens when the player presses space. On
|
|
failure, this will return a JumpError code with the reason.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">x</span>
|
|
X coordinate of the destination <br />
|
|
<span class="parameter">y</span>
|
|
Y coordinate of the destination <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
a JumpError code containing the reason why the jump failed
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="findCargos" class="codecontainer">
|
|
<div id="findCargos" class="function">
|
|
<p>
|
|
<span class="keyword">function table<TradingGood, int></span> findCargos(<span
|
|
class="type">string</span> <span class="parameter">name</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="findCargos" class="">
|
|
<p>
|
|
Finds all cargos with the given name.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
A string that will be matched with the 'name' property of the cargos. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
A map containing all matching goods, with the good as key and amount as value.
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCargo" class="codecontainer">
|
|
<div id="getCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function TradingGood, int...</span> getCargo(<span
|
|
class="type">unsigned
|
|
int</span> <span class="parameter">n</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCargo" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCargos" class="codecontainer">
|
|
<div id="getCargos" class="function">
|
|
<p>
|
|
<span class="keyword">function table<TradingGood, int></span> getCargos() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCargos" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getNumCargos" class="codecontainer">
|
|
<div id="getNumCargos" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> getNumCargos(<span class="type">var</span> <span
|
|
class="parameter">name</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getNumCargos" class="">
|
|
<p>
|
|
Counts all goods of the given type. When given a string, it will match the 'name' property
|
|
of the
|
|
goods. When given a TradingGood it will match the exact good.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
Either a TradingGood or a string containing the name of a trading good. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
The number of goods
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getSummary" class="codecontainer">
|
|
<div id="getSummary" class="function">
|
|
<p>
|
|
<span class="keyword">function string</span> getSummary(<span class="type">var</span> <span
|
|
class="parameter">goods</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getSummary" class="">
|
|
</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="add" class="codecontainer">
|
|
<div id="add" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> add(<span class="type">CargoBay</span> <span
|
|
class="parameter">other</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="add" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addCargo" class="codecontainer">
|
|
<div id="addCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function unsigned int</span> addCargo(<span
|
|
class="type">TradingGood</span> <span class="parameter">good</span>, <span
|
|
class="type">int</span> <span class="parameter">amount</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="addCargo" class="">
|
|
<p>
|
|
Adds cargo to the entity. If the amount specified exceeds the maximum capacity of the cargo
|
|
bay, as much cargo as still fits in will be added.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">good</span>
|
|
TradingGood that is to be added. <br />
|
|
<span class="parameter">amount</span>
|
|
The amount of cargo that should be added. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
How much was actually added (can be less than amount when cargo bay is full)
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="clear" class="codecontainer">
|
|
<div id="clear" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> clear() <br />
|
|
</p>
|
|
</div>
|
|
<div id="clear" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="destroyCargo" class="codecontainer">
|
|
<div id="destroyCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> destroyCargo(<span class="type">float</span> <span
|
|
class="parameter">volume</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="destroyCargo" class="">
|
|
<p>
|
|
Destroys cargo. The destruction distribution is generally equal over all goods.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">volume</span>
|
|
The amount of volume that should be destroyed. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="findCargos" class="codecontainer">
|
|
<div id="findCargos" class="function">
|
|
<p>
|
|
<span class="keyword">function table<TradingGood, int></span> findCargos(<span
|
|
class="type">string</span> <span class="parameter">name</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="findCargos" class="">
|
|
<p>
|
|
Finds all cargos with the given name.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
A string that will be matched with the 'name' property of the cargos. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
A map containing all matching goods, with the good as key and amount as value.
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCargo" class="codecontainer">
|
|
<div id="getCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function TradingGood, int...</span> getCargo(<span
|
|
class="type">unsigned int</span> <span class="parameter">n</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCargo" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getCargos" class="codecontainer">
|
|
<div id="getCargos" class="function">
|
|
<p>
|
|
<span class="keyword">function table<TradingGood, int></span> getCargos() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getCargos" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getNumCargos" class="codecontainer">
|
|
<div id="getNumCargos" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> getNumCargos(<span class="type">var</span> <span
|
|
class="parameter">name</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getNumCargos" class="">
|
|
<p>
|
|
Counts all goods of the given type. When given a string, it will match the 'name' property
|
|
of the goods. When given a TradingGood it will match the exact good.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
Either a TradingGood or a string containing the name of a trading good. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
The number of goods
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getSummary" class="codecontainer">
|
|
<div id="getSummary" class="function">
|
|
<p>
|
|
<span class="keyword">function string</span> getSummary(<span class="type">var</span> <span
|
|
class="parameter">goods</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getSummary" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeCargo" class="codecontainer">
|
|
<div id="removeCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeCargo(<span class="type">var</span> <span
|
|
class="parameter">good</span>, <span class="type">int</span> <span
|
|
class="parameter">amount</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="removeCargo" class="">
|
|
<p>
|
|
Removes cargo from the entity. When given a TradingGood, an exact check for that good will
|
|
be performed. When given a string, only a name check will be performed, and which cargo will
|
|
be removed first is undefined if there are multiple goods with the same name. An example
|
|
would be Energy Cells vs. Stolen Energy Cells. The 'name' property is the same, but the
|
|
'stolen' property is different.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">good</span>
|
|
Either a TradingGood or a string with the name of a good. <br />
|
|
<span class="parameter">amount</span>
|
|
The amount of cargo that should be removed. If this is more than there is on the ship, all
|
|
specified cargo will be removed. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getBlocksByBox" class="codecontainer">
|
|
<div id="getBlocksByBox" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getBlocksByBox(<span class="type">Box</span>
|
|
<span class="parameter">box</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getBlocksByBox" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getBlocksByOrientedBox" class="codecontainer">
|
|
<div id="getBlocksByOrientedBox" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getBlocksByOrientedBox(<span
|
|
class="type">Box</span>
|
|
<span class="parameter">box</span>, <span class="type">Matrix</span> <span
|
|
class="parameter">boxOrientation</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getBlocksByOrientedBox" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getBlocksByRay" class="codecontainer">
|
|
<div id="getBlocksByRay" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getBlocksByRay(<span class="type">Ray</span>
|
|
<span class="parameter">ray</span>, <span class="type">float</span> <span
|
|
class="parameter">t0</span>,
|
|
<span class="type">float</span> <span class="parameter">t1</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getBlocksByRay" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getBlocksBySphere" class="codecontainer">
|
|
<div id="getBlocksBySphere" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getBlocksBySphere(<span
|
|
class="type">Sphere</span>
|
|
<span class="parameter">sphere</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="getBlocksBySphere" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="intersectRay" class="codecontainer">
|
|
<div id="intersectRay" class="function">
|
|
<p>
|
|
<span class="keyword">function var, vec3</span> intersectRay(<span class="type">Ray</span>
|
|
<span class="parameter">ray</span>, <span class="type">float</span> <span
|
|
class="parameter">t0</span>,
|
|
<span class="type">float</span> <span class="parameter">t1</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="intersectRay" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="intersectsBox" class="codecontainer">
|
|
<div id="intersectsBox" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> intersectsBox(<span class="type">Box</span> <span
|
|
class="parameter">box</span>, <span class="type">var</span> <span
|
|
class="parameter">exceptionIndex</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="intersectsBox" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="intersectsSphere" class="codecontainer">
|
|
<div id="intersectsSphere" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> intersectsSphere(<span class="type">Sphere</span>
|
|
<span class="parameter">sphere</span>, <span class="type">var</span> <span
|
|
class="parameter">exceptionIndex</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="intersectsSphere" class="">
|
|
</p>
|
|
</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 id="dock" class="codecontainer">
|
|
<div id="dock" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> dock(<span class="type">Entity</span> <span
|
|
class="parameter">dockee</span>, <span class="type">var</span> <span
|
|
class="parameter">dockIndex</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="dock" class="">
|
|
<p>
|
|
Docks an Entity (dockee) to this Entity (parent), if the given dock is free. Note: This
|
|
function
|
|
doesn't dock the entity immediately, but during the upcoming update tick. If during the same
|
|
tick
|
|
another parent wants to dock the same dockee, the result which of the parents will actually
|
|
dock
|
|
the dockee is random. The dockee must be in position to be docked, otherwise this won't
|
|
work.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">dockee</span>
|
|
The entity that is to be docked <br />
|
|
<span class="parameter">dockIndex</span>
|
|
The index of the dock that is to be used. Use nil to use the first free dock. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
true if the given dock is free (or a free dock was found), false otherwise.
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="forceDock" class="codecontainer">
|
|
<div id="forceDock" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> forceDock(<span class="type">Entity</span> <span
|
|
class="parameter">dockee</span>, <span class="type">var</span> <span
|
|
class="parameter">dockIndex</span>, <span class="type">var</span> <span
|
|
class="parameter">blockIndex</span>, <span class="type">var</span> <span
|
|
class="parameter">look</span>, <span class="type">var</span> <span
|
|
class="parameter">up</span>)
|
|
<br />
|
|
</p>
|
|
</div>
|
|
<div id="forceDock" class="">
|
|
<p>
|
|
Docks an Entity (dockee) to this Entity (parent), if the given dock is free. Note: This
|
|
function
|
|
doesn't dock the entity immediately, but during the upcoming update tick. If during the same
|
|
tick
|
|
another parent wants to dock the same dockee, the result which of the parents will actually
|
|
dock
|
|
the dockee is random.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">dockee</span>
|
|
The entity that is to be docked <br />
|
|
<span class="parameter">dockIndex</span>
|
|
The index of the dock that is to be used. Use nil to use the first free dock. <br />
|
|
<span class="parameter">blockIndex</span>
|
|
The index of the block on the other ship that is to be docked. If nil, uses the outermost
|
|
block on
|
|
the side that will be docked. <br />
|
|
<span class="parameter">look</span>
|
|
The look direction of the object to dock. If nil, will use the parent's direction. This
|
|
direction
|
|
must be in local space of the parent object. You can either use a vec3, an ivec3, or a
|
|
string
|
|
indicating the direction, such as "x" or "-y". <br />
|
|
<span class="parameter">up</span>
|
|
The up direction of the object to dock. If nil, will use the parent's direction. This
|
|
direction
|
|
must be in local space of the parent object. You can either use a vec3, an ivec3, or a
|
|
string
|
|
indicating the direction, such as "x" or "-y". <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
true if the given dock is free (or a free dock was found), false otherwise.
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getDockedEntities" class="codecontainer">
|
|
<div id="getDockedEntities" class="function">
|
|
<p>
|
|
<span class="keyword">function Uuid...</span> getDockedEntities() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getDockedEntities" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getDocks" class="codecontainer">
|
|
<div id="getDocks" class="function">
|
|
<p>
|
|
<span class="keyword">function table_t</span> getDocks() <br />
|
|
</p>
|
|
</div>
|
|
<div id="getDocks" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="isDocked" class="codecontainer">
|
|
<div id="isDocked" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> isDocked(<span class="type">var</span> <span
|
|
class="parameter">entity</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="isDocked" class="">
|
|
<p>
|
|
Checks if another entity is physically docked.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entity</span>
|
|
The entity to check. Can be a Uuid, (uuid-)string or Entity. <br />
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
true if physically docked, false otherwise.
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="undock" class="codecontainer">
|
|
<div id="undock" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> undock(<span class="type">Entity</span> <span
|
|
class="parameter">dockee</span>) <br />
|
|
</p>
|
|
</div>
|
|
<div id="undock" class="">
|
|
<p>
|
|
Undocks an Entity (dockee) from this Entity (parent), if docked. Note: This function doesn't
|
|
undock
|
|
the entity immediately, but during the upcoming update tick.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">dockee</span>
|
|
The entity that is to be undocked <br />
|
|
</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#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.2 e97532556063</p>
|
|
</div>
|
|
<div class="footer">
|
|
<p align="center">Work in Progress.</p>
|
|
<p align="center">Copyright © 2024 Boxelware GmbH. All rights reserved.</p>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
|
|
</html> |