2125 lines
74 KiB
HTML
2125 lines
74 KiB
HTML
<html>
|
|
<head>
|
|
<title> ReadOnlyEntity</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="ReadOnlyEntity.html">ReadOnlyEntity</a>
|
|
<a class="function" href="#ReadOnlyEntity">ReadOnlyEntity</a>
|
|
</td>
|
|
</tr>
|
|
<tr><td><br/></td></tr>
|
|
<tr><td><span class="docheader">Properties</span></td></tr>
|
|
<tr><td>
|
|
<a href="#aiOwned">aiOwned</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#allianceOwned">allianceOwned</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#canPassRifts">canPassRifts</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#controlActions">controlActions</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#crew">crew</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#crewSize">crewSize</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#damageMultiplier">damageMultiplier</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#desiredVelocity">desiredVelocity</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#dockable">dockable</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#dockingParent">dockingParent</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#durability">durability</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#excludedPlayer">excludedPlayer</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#exclusionTime">exclusionTime</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#factionIndex">factionIndex</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#fighterCargoPickup">fighterCargoPickup</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#firePower">firePower</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#freeCargoSpace">freeCargoSpace</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#hasPilot">hasPilot</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#hyperspaceCooldown">hyperspaceCooldown</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#hyperspaceJumpReach">hyperspaceJumpReach</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#id">id</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#idealCrew">idealCrew</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#index">index</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#invincible">invincible</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isAnomaly">isAnomaly</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isArmedTurret">isArmedTurret</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isAsteroid">isAsteroid</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isContainer">isContainer</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isDrone">isDrone</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isFighter">isFighter</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isFlyable">isFlyable</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isLoot">isLoot</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isObviouslyMineable">isObviouslyMineable</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isOther">isOther</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isShieldActive">isShieldActive</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isShip">isShip</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isStation">isStation</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isTurning">isTurning</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isTurret">isTurret</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isUnarmedTurret">isUnarmedTurret</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isUnknown">isUnknown</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isWormHole">isWormHole</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#isWreckage">isWreckage</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#look">look</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#mass">mass</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#maxCargoSpace">maxCargoSpace</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#maxCrewSize">maxCrewSize</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#maxDurability">maxDurability</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#minCrew">minCrew</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#mothership">mothership</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#name">name</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#numCargos">numCargos</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#numDefenseWeapons">numDefenseWeapons</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#numDefenseWeaponsCurrentAttack">numDefenseWeaponsCurrentAttack</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#numDockingPositions">numDockingPositions</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#numTurrets">numTurrets</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#occupiedCargoSpace">occupiedCargoSpace</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#orientation">orientation</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#playerOrAllianceOwned">playerOrAllianceOwned</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#playerOwned">playerOwned</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#position">position</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#radius">radius</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#reservationTime">reservationTime</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#reservedPlayer">reservedPlayer</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#right">right</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#selectedObject">selectedObject</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#shieldDurability">shieldDurability</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#shieldMaxDurability">shieldMaxDurability</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#shieldMeshIntensity">shieldMeshIntensity</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#size">size</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#timeAlive">timeAlive</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#title">title</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#translatedTitle">translatedTitle</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#translation">translation</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#translationf">translationf</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#transporterRange">transporterRange</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#type">type</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#typename">typename</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#up">up</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#volume">volume</a>
|
|
</td></tr>
|
|
<tr><td><br/></td></tr>
|
|
<tr><td><span class="docheader">Member Functions</span></td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#canAddCrew">canAddCrew</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#findCargos">findCargos</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getAimedPositionBySeat">getAimedPositionBySeat</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getAimedPositions">getAimedPositions</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getAllowedArbitraryTurrets">getAllowedArbitraryTurrets</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getAllowedArmedTurrets">getAllowedArmedTurrets</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getAllowedUnarmedTurrets">getAllowedUnarmedTurrets</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getAttachedBlockIndex">getAttachedBlockIndex</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getBoostedValue">getBoostedValue</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getBoundingBox">getBoundingBox</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getBoundingSphere">getBoundingSphere</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getCaptain">getCaptain</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getCargo">getCargo</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getCargoAmount">getCargoAmount</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getCargos">getCargos</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getCrewMembers">getCrewMembers</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getDamageContributorPlayerFactions">getDamageContributorPlayerFactions</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getDamageContributorPlayers">getDamageContributorPlayers</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getDamageContributors">getDamageContributors</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getDockedGroupBoundingBox">getDockedGroupBoundingBox</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getDockedGroupBoundingSphere">getDockedGroupBoundingSphere</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getDockingPositions">getDockingPositions</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getFreeArbitraryTurrets">getFreeArbitraryTurrets</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getFreeArmedTurrets">getFreeArmedTurrets</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getFreeUnarmedTurrets">getFreeUnarmedTurrets</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getFullPlanCopy">getFullPlanCopy</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getLowestMineableMaterial">getLowestMineableMaterial</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getMalusFactor">getMalusFactor</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getMineableMaterial">getMineableMaterial</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getMineableResources">getMineableResources</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getMoneyLootAmount">getMoneyLootAmount</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getNearestDistance">getNearestDistance</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getNumArmedTurrets">getNumArmedTurrets</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getNumMiningTurrets">getNumMiningTurrets</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getNumSalvagingTurrets">getNumSalvagingTurrets</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getNumUnarmedTurrets">getNumUnarmedTurrets</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getPilotIndices">getPilotIndices</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getPlanMoneyValue">getPlanMoneyValue</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getPlanResourceValue">getPlanResourceValue</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getResourceLootAmount">getResourceLootAmount</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getScripts">getScripts</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getTitleArguments">getTitleArguments</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getTitleFormat">getTitleFormat</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getTurret">getTurret</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getTurrets">getTurrets</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getTurretSize">getTurretSize</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getTurretTemplateSize">getTurretTemplateSize</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getTurretTurningSpeed">getTurretTurningSpeed</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getUndamagedPlanMoneyValue">getUndamagedPlanMoneyValue</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getUndamagedPlanResourceValue">getUndamagedPlanResourceValue</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getValue">getValue</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getValues">getValues</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#hasComponent">hasComponent</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#hasScript">hasScript</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#hyperspaceBlocked">hyperspaceBlocked</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#isCollectable">isCollectable</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#isInDockingArea">isInDockingArea</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#isInsideShield">isInsideShield</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#isJumpRouteValid">isJumpRouteValid</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#isManned">isManned</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#isTurretAllowed">isTurretAllowed</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#jumpPossible">jumpPossible</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#resolveScriptPath">resolveScriptPath</a>
|
|
</td></tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="floatright">
|
|
<h1>ReadOnlyEntity</h1>
|
|
<div id="ReadOnlyEntity" class="codecontainer">
|
|
<div id="ReadOnlyEntity" class="function">
|
|
<p>
|
|
<span class="keyword">function </span> ReadOnlyEntity(<span class="type">var</span> <span class="parameter">id</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="ReadOnlyEntity" class="">
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">id</span>
|
|
The id of the entity, must be an id of an existing entity <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
A new instance of ReadOnlyEntity
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="Properties" class="codecontainer">
|
|
<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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><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">
|
|
</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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><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="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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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"><span><b>[read-only]</b></span></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>
|
|
<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="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="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="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="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="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="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>
|
|
</div>
|
|
<div class="sitemap">
|
|
<div class="flexheader"> <div class="headerlisting">
|
|
<span class="docheader">Overview</span>
|
|
<br> <a href="index.html">Home</a>
|
|
<a href="Functions.html">Functions</a>
|
|
<a href="Search.html">Search</a>
|
|
</div> <div class="flexheaderwhitespace"></div>
|
|
<form action="Search.html" method="get"> Search:<input name="search" class="headersearchinput" type="search"> </form></div><div class="headerlisting">
|
|
<span class="docheader">Callbacks</span>
|
|
<br><a href="Callbacks.html"> Callbacks</a>
|
|
<a href="Alliance [Client] Callbacks.html">Alliance [Client] Callbacks</a>
|
|
<a href="Alliance [Server] Callbacks.html">Alliance [Server] Callbacks</a>
|
|
<a href="Alliance [Server] Callbacks.html">Alliance [Server] Callbacks</a>
|
|
<a href="Entity Callbacks.html">Entity Callbacks</a>
|
|
<a href="Galaxy Callbacks.html">Galaxy Callbacks</a>
|
|
<a href="Player Callbacks.html">Player Callbacks</a>
|
|
<a href="Player [Client] Callbacks.html">Player [Client] Callbacks</a>
|
|
<a href="Sector Callbacks.html">Sector Callbacks</a>
|
|
<a href="Server Callbacks.html">Server Callbacks</a>
|
|
</div><div class="headerlisting">
|
|
<span class="docheader">Predefined Functions & Example Scripts</span>
|
|
<br><a href="CommandFunctions.html">Command</a>
|
|
<a href="EntityFunctions.html">Entity</a>
|
|
<a href="FactionDatabaseFunctions.html">FactionDatabase</a>
|
|
<a href="PlanGeneratorFunctions.html">PlanGenerator</a>
|
|
<a href="PlayerFunctions.html">Player</a>
|
|
<a href="SectorFunctions.html">Sector</a>
|
|
<a href="ServerFunctions.html">Server</a>
|
|
<a href="UsableInventoryItemFunctions.html">UsableInventoryItem</a>
|
|
</div><div class="headerlisting">
|
|
<span class="docheader">Common Components</span>
|
|
<br><a href="Boarding.html">Boarding</a>
|
|
<a href="BspTree.html">BspTree</a>
|
|
<a href="CargoBay.html">CargoBay</a>
|
|
<a href="CargoLoot.html">CargoLoot</a>
|
|
<a href="ControlUnit.html">ControlUnit</a>
|
|
<a href="CrewComponent.html">CrewComponent</a>
|
|
<a href="DeletionTimer.html">DeletionTimer</a>
|
|
<a href="DirectFlightPhysics.html">DirectFlightPhysics</a>
|
|
<a href="DockingClamps.html">DockingClamps</a>
|
|
<a href="DockingParent.html">DockingParent</a>
|
|
<a href="DockingPositions.html">DockingPositions</a>
|
|
<a href="Durability.html">Durability</a>
|
|
<a href="EnergySystem.html">EnergySystem</a>
|
|
<a href="Engine.html">Engine</a>
|
|
<a href="FighterAI.html">FighterAI</a>
|
|
<a href="Hangar.html">Hangar</a>
|
|
<a href="HyperspaceEngine.html">HyperspaceEngine</a>
|
|
<a href="InteractionText.html">InteractionText</a>
|
|
<a href="InventoryItemLoot.html">InventoryItemLoot</a>
|
|
<a href="Owner.html">Owner</a>
|
|
<a href="Physics.html">Physics</a>
|
|
<a href="Plan.html">Plan</a>
|
|
<a href="ReadOnlyBoarding.html">ReadOnlyBoarding</a>
|
|
<a href="ReadOnlyBspTree.html">ReadOnlyBspTree</a>
|
|
<a href="ReadOnlyCargoBay.html">ReadOnlyCargoBay</a>
|
|
<a href="ReadOnlyControlUnit.html">ReadOnlyControlUnit</a>
|
|
<a href="ReadOnlyCrew.html">ReadOnlyCrew</a>
|
|
<a href="ReadOnlyDeletionTimer.html">ReadOnlyDeletionTimer</a>
|
|
<a href="ReadOnlyEnergySystem.html">ReadOnlyEnergySystem</a>
|
|
<a href="ReadOnlyEngine.html">ReadOnlyEngine</a>
|
|
<a href="ReadOnlyFighterAI.html">ReadOnlyFighterAI</a>
|
|
<a href="ReadOnlyHangar.html">ReadOnlyHangar</a>
|
|
<a href="ReadOnlyHyperspaceEngine.html">ReadOnlyHyperspaceEngine</a>
|
|
<a href="ReadOnlyInteractionText.html">ReadOnlyInteractionText</a>
|
|
<a href="ReadOnlyOwner.html">ReadOnlyOwner</a>
|
|
<a href="ReadOnlyPhysics.html">ReadOnlyPhysics</a>
|
|
<a href="ReadOnlyPlan.html">ReadOnlyPlan</a>
|
|
<a href="ReadOnlyShipAI.html">ReadOnlyShipAI</a>
|
|
<a href="ReadOnlyShipSystem.html">ReadOnlyShipSystem</a>
|
|
<a href="ReadOnlyTorpedoAI [Server] [Client] [Server] [Client].html">ReadOnlyTorpedoAI [Server] [Client] [Server] [Client]</a>
|
|
<a href="ReadOnlyTorpedoAI [Server] [Client] [Server] [Client].html">ReadOnlyTorpedoAI [Server] [Client] [Server] [Client]</a>
|
|
<a href="ReadOnlyTorpedoLauncher.html">ReadOnlyTorpedoLauncher</a>
|
|
<a href="ReadOnlyTurretBases.html">ReadOnlyTurretBases</a>
|
|
<a href="ReadOnlyVelocity.html">ReadOnlyVelocity</a>
|
|
<a href="ReadOnlyWeapons.html">ReadOnlyWeapons</a>
|
|
<a href="ReadOnlyWormHole.html">ReadOnlyWormHole</a>
|
|
<a href="Shield.html">Shield</a>
|
|
<a href="ShipAI.html">ShipAI</a>
|
|
<a href="ShipSystem.html">ShipSystem</a>
|
|
<a href="StructuralIntegrity.html">StructuralIntegrity</a>
|
|
<a href="SystemUpgradeLoot.html">SystemUpgradeLoot</a>
|
|
<a href="Thrusters.html">Thrusters</a>
|
|
<a href="Torpedo.html">Torpedo</a>
|
|
<a href="TorpedoAI.html">TorpedoAI</a>
|
|
<a href="TorpedoLauncher.html">TorpedoLauncher</a>
|
|
<a href="Turret.html">Turret</a>
|
|
<a href="TurretAI.html">TurretAI</a>
|
|
<a href="TurretBases.html">TurretBases</a>
|
|
<a href="Velocity.html">Velocity</a>
|
|
<a href="Weapons.html">Weapons</a>
|
|
<a href="WormHole.html">WormHole</a>
|
|
</div><div class="headerlisting">
|
|
<span class="docheader">Common Objects</span>
|
|
<br><a href="AllianceMember.html">AllianceMember</a>
|
|
<a href="AllianceRank.html">AllianceRank</a>
|
|
<a href="BlockPlan.html">BlockPlan</a>
|
|
<a href="BlockPlanBlock.html">BlockPlanBlock</a>
|
|
<a href="BlockStatistics.html">BlockStatistics</a>
|
|
<a href="Box.html">Box</a>
|
|
<a href="Captain.html">Captain</a>
|
|
<a href="Color.html">Color</a>
|
|
<a href="ControlUnitSeat.html">ControlUnitSeat</a>
|
|
<a href="CraftDesign.html">CraftDesign</a>
|
|
<a href="CraftStatsOverview.html">CraftStatsOverview</a>
|
|
<a href="Crew.html">Crew</a>
|
|
<a href="CrewMan.html">CrewMan</a>
|
|
<a href="CrewProfession.html">CrewProfession</a>
|
|
<a href="DebugInfo.html">DebugInfo</a>
|
|
<a href="dvec2.html">dvec2</a>
|
|
<a href="dvec3.html">dvec3</a>
|
|
<a href="dvec4.html">dvec4</a>
|
|
<a href="Entity.html">Entity</a>
|
|
<a href="EntityDescriptor.html">EntityDescriptor</a>
|
|
<a href="FighterTemplate.html">FighterTemplate</a>
|
|
<a href="Format.html">Format</a>
|
|
<a href="GameSettings.html">GameSettings</a>
|
|
<a href="Group.html">Group</a>
|
|
<a href="HighResolutionTimer.html">HighResolutionTimer</a>
|
|
<a href="Inventory.html">Inventory</a>
|
|
<a href="InventoryTurret.html">InventoryTurret</a>
|
|
<a href="ivec2.html">ivec2</a>
|
|
<a href="ivec3.html">ivec3</a>
|
|
<a href="ivec4.html">ivec4</a>
|
|
<a href="Language.html">Language</a>
|
|
<a href="Mail.html">Mail</a>
|
|
<a href="Material.html">Material</a>
|
|
<a href="Matrix.html">Matrix</a>
|
|
<a href="ModManager.html">ModManager</a>
|
|
<a href="NamedFormat.html">NamedFormat</a>
|
|
<a href="PlanBspTree.html">PlanBspTree</a>
|
|
<a href="PlanetSpecifics.html">PlanetSpecifics</a>
|
|
<a href="PlanGenerationStage.html">PlanGenerationStage</a>
|
|
<a href="PlanPart.html">PlanPart</a>
|
|
<a href="PlanStyle.html">PlanStyle</a>
|
|
<a href="PlayerId.html">PlayerId</a>
|
|
<a href="PluralForm.html">PluralForm</a>
|
|
<a href="Profiler.html">Profiler</a>
|
|
<a href="QuadTree.html">QuadTree</a>
|
|
<a href="Random.html">Random</a>
|
|
<a href="Rarity.html">Rarity</a>
|
|
<a href="Ray.html">Ray</a>
|
|
<a href="ReadOnlyEntity.html">ReadOnlyEntity</a>
|
|
<a href="Rect.html">Rect</a>
|
|
<a href="Relation.html">Relation</a>
|
|
<a href="Scenario.html">Scenario</a>
|
|
<a href="SectorView.html">SectorView</a>
|
|
<a href="Seed.html">Seed</a>
|
|
<a href="Sphere.html">Sphere</a>
|
|
<a href="Squad.html">Squad</a>
|
|
<a href="SystemUpgradeTemplate.html">SystemUpgradeTemplate</a>
|
|
<a href="Timer.html">Timer</a>
|
|
<a href="Tooltip.html">Tooltip</a>
|
|
<a href="TooltipLine.html">TooltipLine</a>
|
|
<a href="TorpedoShaft.html">TorpedoShaft</a>
|
|
<a href="TorpedoTemplate.html">TorpedoTemplate</a>
|
|
<a href="TradingGood.html">TradingGood</a>
|
|
<a href="TurretDesign.html">TurretDesign</a>
|
|
<a href="TurretDesignPart.html">TurretDesignPart</a>
|
|
<a href="TurretTemplate.html">TurretTemplate</a>
|
|
<a href="UsableInventoryItem.html">UsableInventoryItem</a>
|
|
<a href="Uuid.html">Uuid</a>
|
|
<a href="VanillaInventoryItem.html">VanillaInventoryItem</a>
|
|
<a href="vec2.html">vec2</a>
|
|
<a href="vec3.html">vec3</a>
|
|
<a href="vec4.html">vec4</a>
|
|
<a href="Version.html">Version</a>
|
|
<a href="Weapon.html">Weapon</a>
|
|
</div><div class="headerlisting">
|
|
<span class="docheader">Client Components</span>
|
|
<br><a href="EntityIcon.html">EntityIcon</a>
|
|
<a href="EntityTooltip.html">EntityTooltip</a>
|
|
<a href="PlanMesh.html">PlanMesh</a>
|
|
<a href="ReadOnlyIcon.html">ReadOnlyIcon</a>
|
|
<a href="ReadOnlyPlanMesh.html">ReadOnlyPlanMesh</a>
|
|
<a href="ReadOnlyScriptUI.html">ReadOnlyScriptUI</a>
|
|
<a href="ReadOnlyTooltip.html">ReadOnlyTooltip</a>
|
|
<a href="ScriptUI.html">ScriptUI</a>
|
|
</div><div class="headerlisting">
|
|
<span class="docheader">Client Objects</span>
|
|
<br><a href="Achievements.html">Achievements</a>
|
|
<a href="Alliance [Client].html">Alliance [Client]</a>
|
|
<a href="CameraKeyFrame.html">CameraKeyFrame</a>
|
|
<a href="CaptainSelectionItem.html">CaptainSelectionItem</a>
|
|
<a href="Client.html">Client</a>
|
|
<a href="ClientSettings.html">ClientSettings</a>
|
|
<a href="ColorSelectionItem.html">ColorSelectionItem</a>
|
|
<a href="CraftDesignSelectionItem.html">CraftDesignSelectionItem</a>
|
|
<a href="Faction [Client].html">Faction [Client]</a>
|
|
<a href="Galaxy [Client].html">Galaxy [Client]</a>
|
|
<a href="GalaxyMap.html">GalaxyMap</a>
|
|
<a href="GameInput.html">GameInput</a>
|
|
<a href="GlowFX.html">GlowFX</a>
|
|
<a href="IconSelectionItem.html">IconSelectionItem</a>
|
|
<a href="InputWindow.html">InputWindow</a>
|
|
<a href="InventoryReferenceSelectionItem.html">InventoryReferenceSelectionItem</a>
|
|
<a href="InventorySelectionItem.html">InventorySelectionItem</a>
|
|
<a href="Keyboard.html">Keyboard</a>
|
|
<a href="LaserFX.html">LaserFX</a>
|
|
<a href="Mouse.html">Mouse</a>
|
|
<a href="Music.html">Music</a>
|
|
<a href="PixelIconSelectionItem.html">PixelIconSelectionItem</a>
|
|
<a href="Planet.html">Planet</a>
|
|
<a href="Player [Client].html">Player [Client]</a>
|
|
<a href="PlayerWindow.html">PlayerWindow</a>
|
|
<a href="RefractionFX.html">RefractionFX</a>
|
|
<a href="Sector [Client].html">Sector [Client]</a>
|
|
<a href="SelectionItem.html">SelectionItem</a>
|
|
<a href="ShipDatabaseEntry [Client].html">ShipDatabaseEntry [Client]</a>
|
|
<a href="SoundSource.html">SoundSource</a>
|
|
<a href="StrategyState.html">StrategyState</a>
|
|
<a href="TargetIndicator.html">TargetIndicator</a>
|
|
<a href="TooltipRenderer.html">TooltipRenderer</a>
|
|
<a href="TurretDesignSelectionItem.html">TurretDesignSelectionItem</a>
|
|
</div><div class="headerlisting">
|
|
<span class="docheader">Client UI Objects</span>
|
|
<br><a href="AllianceEmblem.html">AllianceEmblem</a>
|
|
<a href="AllianceTab.html">AllianceTab</a>
|
|
<a href="ArrowLine.html">ArrowLine</a>
|
|
<a href="Button [Client] [Client].html">Button [Client] [Client]</a>
|
|
<a href="Button [Client] [Client].html">Button [Client] [Client]</a>
|
|
<a href="CaptainIcon.html">CaptainIcon</a>
|
|
<a href="CaptainProfile.html">CaptainProfile</a>
|
|
<a href="CheckBox.html">CheckBox</a>
|
|
<a href="ComboBox.html">ComboBox</a>
|
|
<a href="ContextMenu.html">ContextMenu</a>
|
|
<a href="CraftPortrait.html">CraftPortrait</a>
|
|
<a href="CrewBar.html">CrewBar</a>
|
|
<a href="Frame.html">Frame</a>
|
|
<a href="Hud.html">Hud</a>
|
|
<a href="InventorySelection.html">InventorySelection</a>
|
|
<a href="Label.html">Label</a>
|
|
<a href="Line.html">Line</a>
|
|
<a href="ListBox.html">ListBox</a>
|
|
<a href="ListBoxEx.html">ListBoxEx</a>
|
|
<a href="MapArrowLine.html">MapArrowLine</a>
|
|
<a href="MapIcon.html">MapIcon</a>
|
|
<a href="MultiLineTextBox.html">MultiLineTextBox</a>
|
|
<a href="NumbersBar.html">NumbersBar</a>
|
|
<a href="Picture.html">Picture</a>
|
|
<a href="PlanDisplayer.html">PlanDisplayer</a>
|
|
<a href="ProgressBar.html">ProgressBar</a>
|
|
<a href="SavedDesignsSelection.html">SavedDesignsSelection</a>
|
|
<a href="ScrollFrame.html">ScrollFrame</a>
|
|
<a href="Selection.html">Selection</a>
|
|
<a href="ShipWindow.html">ShipWindow</a>
|
|
<a href="Slider.html">Slider</a>
|
|
<a href="StatisticsBar.html">StatisticsBar</a>
|
|
<a href="Tab.html">Tab</a>
|
|
<a href="TabbedWindow.html">TabbedWindow</a>
|
|
<a href="TextBox.html">TextBox</a>
|
|
<a href="TextField.html">TextField</a>
|
|
<a href="TooltipDisplayer.html">TooltipDisplayer</a>
|
|
<a href="Tree.html">Tree</a>
|
|
<a href="UIArbitraryHorizontalSplitter.html">UIArbitraryHorizontalSplitter</a>
|
|
<a href="UIArbitraryVerticalSplitter.html">UIArbitraryVerticalSplitter</a>
|
|
<a href="UIContainer.html">UIContainer</a>
|
|
<a href="UIElement.html">UIElement</a>
|
|
<a href="UIGridSplitter.html">UIGridSplitter</a>
|
|
<a href="UIHorizontalLister.html">UIHorizontalLister</a>
|
|
<a href="UIHorizontalMultiSplitter.html">UIHorizontalMultiSplitter</a>
|
|
<a href="UIHorizontalSplitter.html">UIHorizontalSplitter</a>
|
|
<a href="UIOrganizer.html">UIOrganizer</a>
|
|
<a href="UIRect.html">UIRect</a>
|
|
<a href="UIRenderer.html">UIRenderer</a>
|
|
<a href="UIVerticalLister.html">UIVerticalLister</a>
|
|
<a href="UIVerticalMultiSplitter.html">UIVerticalMultiSplitter</a>
|
|
<a href="UIVerticalSplitter.html">UIVerticalSplitter</a>
|
|
<a href="ValueComboBox.html">ValueComboBox</a>
|
|
<a href="Window.html">Window</a>
|
|
</div><div class="headerlisting">
|
|
<span class="docheader">Server Components</span>
|
|
<br><a href="EntityTransferrer.html">EntityTransferrer</a>
|
|
<a href="FighterController.html">FighterController</a>
|
|
<a href="Loot.html">Loot</a>
|
|
<a href="ReadOnlyEntityTransferrer.html">ReadOnlyEntityTransferrer</a>
|
|
<a href="ReadOnlyFighterController.html">ReadOnlyFighterController</a>
|
|
<a href="ReadOnlyLoot.html">ReadOnlyLoot</a>
|
|
<a href="ReadOnlyTurretController.html">ReadOnlyTurretController</a>
|
|
<a href="ReadOnlyWreckageCreator.html">ReadOnlyWreckageCreator</a>
|
|
<a href="TurretController.html">TurretController</a>
|
|
<a href="WreckageCreator.html">WreckageCreator</a>
|
|
</div><div class="headerlisting">
|
|
<span class="docheader">Server Objects</span>
|
|
<br><a href="Alliance [Server].html">Alliance [Server]</a>
|
|
<a href="Faction [Server].html">Faction [Server]</a>
|
|
<a href="Galaxy [Server].html">Galaxy [Server]</a>
|
|
<a href="Player [Server].html">Player [Server]</a>
|
|
<a href="ReadOnlySector.html">ReadOnlySector</a>
|
|
<a href="Sector [Server].html">Sector [Server]</a>
|
|
<a href="Server.html">Server</a>
|
|
<a href="ShipDatabaseEntry [Server].html">ShipDatabaseEntry [Server]</a>
|
|
</div><div class="lastheaderlisting">
|
|
<span class="docheader">Enums</span>
|
|
<br><a href="Enums.html#AIState">AIState</a>
|
|
<a href="Enums.html#AlliancePrivilege">AlliancePrivilege</a>
|
|
<a href="Enums.html#BeamShape">BeamShape</a>
|
|
<a href="Enums.html#BlockShading">BlockShading</a>
|
|
<a href="Enums.html#BlockStructure">BlockStructure</a>
|
|
<a href="Enums.html#BlockType">BlockType</a>
|
|
<a href="Enums.html#BlockType2">BlockType2</a>
|
|
<a href="Enums.html#BoxType">BoxType</a>
|
|
<a href="Enums.html#BuildError">BuildError</a>
|
|
<a href="Enums.html#CaptainGenderId">CaptainGenderId</a>
|
|
<a href="Enums.html#ChatChannel">ChatChannel</a>
|
|
<a href="Enums.html#ChatMessageType">ChatMessageType</a>
|
|
<a href="Enums.html#ComponentType">ComponentType</a>
|
|
<a href="Enums.html#ControlAction">ControlAction</a>
|
|
<a href="Enums.html#ControlActionBit">ControlActionBit</a>
|
|
<a href="Enums.html#ControlStyle">ControlStyle</a>
|
|
<a href="Enums.html#CoolingType">CoolingType</a>
|
|
<a href="Enums.html#CraftStatsOverviewStat">CraftStatsOverviewStat</a>
|
|
<a href="Enums.html#CrewProfessionType">CrewProfessionType</a>
|
|
<a href="Enums.html#CrewRank">CrewRank</a>
|
|
<a href="Enums.html#DamageSource">DamageSource</a>
|
|
<a href="Enums.html#DamageType">DamageType</a>
|
|
<a href="Enums.html#DeletionType">DeletionType</a>
|
|
<a href="Enums.html#Difficulty">Difficulty</a>
|
|
<a href="Enums.html#EntityArrivalType">EntityArrivalType</a>
|
|
<a href="Enums.html#EntityType">EntityType</a>
|
|
<a href="Enums.html#FighterOrders">FighterOrders</a>
|
|
<a href="Enums.html#FighterStartError">FighterStartError</a>
|
|
<a href="Enums.html#FighterType">FighterType</a>
|
|
<a href="Enums.html#FontType">FontType</a>
|
|
<a href="Enums.html#ImpactParticles">ImpactParticles</a>
|
|
<a href="Enums.html#InventoryItemType">InventoryItemType</a>
|
|
<a href="Enums.html#JumpError">JumpError</a>
|
|
<a href="Enums.html#KeyboardKey">KeyboardKey</a>
|
|
<a href="Enums.html#ListBoxEntryType">ListBoxEntryType</a>
|
|
<a href="Enums.html#MalusReason">MalusReason</a>
|
|
<a href="Enums.html#MaterialType">MaterialType</a>
|
|
<a href="Enums.html#MoonType">MoonType</a>
|
|
<a href="Enums.html#MouseButton">MouseButton</a>
|
|
<a href="Enums.html#PlanetType">PlanetType</a>
|
|
<a href="Enums.html#PlanTypeFilter">PlanTypeFilter</a>
|
|
<a href="Enums.html#PlayerStateType">PlayerStateType</a>
|
|
<a href="Enums.html#ProjectileShape">ProjectileShape</a>
|
|
<a href="Enums.html#RarityType">RarityType</a>
|
|
<a href="Enums.html#RelationStatus">RelationStatus</a>
|
|
<a href="Enums.html#SavedDesignType">SavedDesignType</a>
|
|
<a href="Enums.html#ScenarioType">ScenarioType</a>
|
|
<a href="Enums.html#SectorChangeType">SectorChangeType</a>
|
|
<a href="Enums.html#ShipAvailability">ShipAvailability</a>
|
|
<a href="Enums.html#SoundType">SoundType</a>
|
|
<a href="Enums.html#StatsBonuses">StatsBonuses</a>
|
|
<a href="Enums.html#TargetIndicatorVisuals">TargetIndicatorVisuals</a>
|
|
<a href="Enums.html#TransformationFeature">TransformationFeature</a>
|
|
<a href="Enums.html#TurretAutoFireMode">TurretAutoFireMode</a>
|
|
<a href="Enums.html#TurretSlotType">TurretSlotType</a>
|
|
<a href="Enums.html#WeaponAppearance">WeaponAppearance</a>
|
|
<a href="Enums.html#WeaponCategory">WeaponCategory</a>
|
|
</div></div>
|
|
<div class="disclaimer">
|
|
<p>This is the official documentation for the scripting API of Avorion. This documentation is automatically generated and <strong>not</strong> necessarily complete. Depending on the context in which functions exist, some documentation such as descriptions, return values or variable names or types may be missing.</p>
|
|
<p>Work in Progress. Documentation of Avorion Version: 2.5.8 a0d3f0b5b065</p>
|
|
</div>
|
|
<div class="footer">
|
|
<p align="center">Work in Progress.</p>
|
|
<p align="center">Copyright © 2025 Boxelware GmbH. All rights reserved.</p>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|