2574 lines
84 KiB
HTML
2574 lines
84 KiB
HTML
<html>
|
|
<head>
|
|
<title> Alliance [Server]</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="Alliance [Server].html">Alliance [Server]</a>
|
|
<a class="function" href="#Alliance">Alliance</a>
|
|
</td>
|
|
</tr>
|
|
<tr><td><br/></td></tr>
|
|
<tr><td><span class="docheader">Properties</span></td></tr>
|
|
<tr><td>
|
|
<a href="#leader">leader</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#maxNumShips">maxNumShips</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#maxNumStations">maxNumStations</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#numCrafts">numCrafts</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#numShips">numShips</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#numStations">numStations</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#alwaysAtWar">alwaysAtWar</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#baseName">baseName</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#fullLogId">fullLogId</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#homeSectorUnknown">homeSectorUnknown</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#index">index</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#infiniteResources">infiniteResources</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#initialRelations">initialRelations</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#initialRelationsToPlayer">initialRelationsToPlayer</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#isAIFaction">isAIFaction</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#isAlliance">isAlliance</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#isPlayer">isPlayer</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#money">money</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#name">name</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#stateForm">stateForm</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#staticRelationsToAI">staticRelationsToAI</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#staticRelationsToAll">staticRelationsToAll</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#staticRelationsToPlayers">staticRelationsToPlayers</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="inheritedproperty" href="#unformattedName">unformattedName</a>
|
|
</td></tr>
|
|
<tr><td><br/></td></tr>
|
|
<tr><td><span class="docheader">Member Functions</span></td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#addKnownSector">addKnownSector</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#addRank">addRank</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#addRankPrivilege">addRankPrivilege</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#addScript">addScript</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#addScriptOnce">addScriptOnce</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#callbacksRegistered">callbacksRegistered</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#contains">contains</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#createCraftFromShipInfo">createCraftFromShipInfo</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getKnownSector">getKnownSector</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getKnownSectorCoordinates">getKnownSectorCoordinates</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getKnownSectors">getKnownSectors</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getKnownSectorsOfFaction">getKnownSectorsOfFaction</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getKnownSectorsWithFaction">getKnownSectorsWithFaction</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getMemberLocation">getMemberLocation</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getMemberRank">getMemberRank</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getMembers">getMembers</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getNamesOfShipsInSector">getNamesOfShipsInSector</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getNewMemberRank">getNewMemberRank</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getOnlineMembers">getOnlineMembers</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getRank">getRank</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getScripts">getScripts</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipAvailability">getShipAvailability</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipBoundingBox">getShipBoundingBox</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipCanPassRifts">getShipCanPassRifts</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipCargo">getShipCargo</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipCargos">getShipCargos</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipCrew">getShipCrew</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipDestroyed">getShipDestroyed</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipHyperspaceReach">getShipHyperspaceReach</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipIcon">getShipIcon</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipNames">getShipNames</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipOrderInfo">getShipOrderInfo</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipPayment">getShipPayment</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipPaymentTime">getShipPaymentTime</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipPlan">getShipPlan</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipPosition">getShipPosition</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipReconstructionValue">getShipReconstructionValue</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipStatus">getShipStatus</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipSystems">getShipSystems</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipTurretDesigns">getShipTurretDesigns</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#getShipType">getShipType</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#hasPrivilege">hasPrivilege</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#hasScript">hasScript</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#invokeFunction">invokeFunction</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#knowsSector">knowsSector</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#moveRank">moveRank</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#ownsShip">ownsShip</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#rankExists">rankExists</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#registerCallback">registerCallback</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#removeDestroyedShipInfo">removeDestroyedShipInfo</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#removeKnownSector">removeKnownSector</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#removeRank">removeRank</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#removeRankPrivilege">removeRankPrivilege</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#removeScript">removeScript</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#resolveScriptPath">resolveScriptPath</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#restoreCraft">restoreCraft</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#restoreTurrets">restoreTurrets</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#sendCallback">sendCallback</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#sendChatMessage">sendChatMessage</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#setMemberRank">setMemberRank</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#setNewMemberRank">setNewMemberRank</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#setShipAvailability">setShipAvailability</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#setShipDestroyed">setShipDestroyed</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#setShipIcon">setShipIcon</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#setShipOrderInfo">setShipOrderInfo</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#setShipReconstructionValue">setShipReconstructionValue</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#unregisterCallback">unregisterCallback</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#updateKnownSector">updateKnownSector</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a class="code" href="#updateKnownSectorPreserveNote">updateKnownSectorPreserveNote</a>
|
|
</td></tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#addPlanStyle">addPlanStyle</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#canPay">canPay</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#canPayMoney">canPayMoney</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#canPayResource">canPayResource</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#clearValues">clearValues</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#getAllRelations">getAllRelations</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#getHomeSectorCoordinates">getHomeSectorCoordinates</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#getInventory">getInventory</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#getLanguage">getLanguage</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#getPlanStyle">getPlanStyle</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#getPlanStyleNames">getPlanStyleNames</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#getRelation">getRelation</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#getRelations">getRelations</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#getRelationStatus">getRelationStatus</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#getResources">getResources</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#getTrait">getTrait</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#getTraits">getTraits</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#getValue">getValue</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#getValues">getValues</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#hasStaticRelationsToFaction">hasStaticRelationsToFaction</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#knowsFaction">knowsFaction</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#pay">pay</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#payResource">payResource</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#payWithoutNotify">payWithoutNotify</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#receive">receive</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#receiveResource">receiveResource</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#receiveWithoutNotify">receiveWithoutNotify</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#sendCallback">sendCallback</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#sendChatMessage">sendChatMessage</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#setHomeSectorCoordinates">setHomeSectorCoordinates</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#setLanguage">setLanguage</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#setResources">setResources</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#setStaticRelationsToFaction">setStaticRelationsToFaction</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#setTrait">setTrait</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a class="inheritedcode" href="#setValue">setValue</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="floatright">
|
|
<h1>Alliance [Server] : <a href="Faction [Server].html">Faction [Server]</a></h1>
|
|
<p>
|
|
<span class="warning">This object is only available on the server.</span>
|
|
</p>
|
|
<div id="Alliance" class="codecontainer">
|
|
<div id="Alliance" class="function">
|
|
<p>
|
|
<span class="keyword">function </span> Alliance(<span class="type">var</span> <span class="parameter">index</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="Alliance" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
A new instance of Alliance
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="Properties" class="codecontainer">
|
|
<div id="leader">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span class="property">leader</span></td><td align="right"></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="maxNumShips">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span class="property">maxNumShips</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="maxNumStations">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span class="property">maxNumStations</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="numCrafts">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">unsigned int </span> <span class="property">numCrafts</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="numShips">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span class="property">numShips</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="numStations">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span class="property">numStations</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="alwaysAtWar">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">alwaysAtWar</span></td><td align="right"></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="baseName">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">string </span> <span class="property">baseName</span></td><td align="right"></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="fullLogId">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">string </span> <span class="property">fullLogId</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="homeSectorUnknown">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">homeSectorUnknown</span></td><td align="right"></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">int </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="infiniteResources">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">infiniteResources</span></td><td align="right"></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="initialRelations">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span class="property">initialRelations</span></td><td align="right"></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Note: AIFactions only
|
|
</div>
|
|
</div>
|
|
<div id="initialRelationsToPlayer">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span class="property">initialRelationsToPlayer</span></td><td align="right"></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
Note: AIFactions only
|
|
</div>
|
|
</div>
|
|
<div id="isAIFaction">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">isAIFaction</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="isAlliance">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">isAlliance</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="isPlayer">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">isPlayer</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="money">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">int </span> <span class="property">money</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"><span><b>[read-only]</b></span></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="stateForm">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">string </span> <span class="property">stateForm</span></td><td align="right"></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="staticRelationsToAI">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">staticRelationsToAI</span></td><td align="right"></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="staticRelationsToAll">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">staticRelationsToAll</span></td><td align="right"></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="staticRelationsToPlayers">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">staticRelationsToPlayers</span></td><td align="right"></td></tr></table>
|
|
<div style="padding-left:20px; padding-bottom:10px">
|
|
</div>
|
|
</div>
|
|
<div id="unformattedName">
|
|
<table style="width:100%;"><tr>
|
|
<td><span class="keyword">property</span> <span class="type">Format </span> <span class="property">unformattedName</span></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="addKnownSector" class="codecontainer">
|
|
<div id="addKnownSector" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addKnownSector(<span class="type">SectorView</span> <span class="parameter">view</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="addKnownSector" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addRank" class="codecontainer">
|
|
<div id="addRank" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addRank(<span class="type">string</span> <span class="parameter">name</span>, <span class="type">string</span> <span class="parameter">lowerName</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="addRank" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addRankPrivilege" class="codecontainer">
|
|
<div id="addRankPrivilege" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addRankPrivilege(<span class="type">string</span> <span class="parameter">rank</span>, <span class="type">int</span> <span class="parameter">privilege</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="addRankPrivilege" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addScript" class="codecontainer">
|
|
<div id="addScript" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addScript() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="addScript" class="">
|
|
</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="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="contains" class="codecontainer">
|
|
<div id="contains" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> contains(<span class="type">int</span> <span class="parameter">playerIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="contains" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="createCraftFromShipInfo" class="codecontainer">
|
|
<div id="createCraftFromShipInfo" class="function">
|
|
<p>
|
|
<span class="keyword">function Entity</span> createCraftFromShipInfo(<span class="type">string</span> <span class="parameter">name</span>, <span class="type">Matrix</span> <span class="parameter">position</span>, <span class="type">var</span> <span class="parameter">faction</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="createCraftFromShipInfo" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getKnownSector" class="codecontainer">
|
|
<div id="getKnownSector" class="function">
|
|
<p>
|
|
<span class="keyword">function SectorView</span> getKnownSector(<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="getKnownSector" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getKnownSectorCoordinates" class="codecontainer">
|
|
<div id="getKnownSectorCoordinates" class="function">
|
|
<p>
|
|
<span class="keyword">function ivec2...</span> getKnownSectorCoordinates() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getKnownSectorCoordinates" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getKnownSectors" class="codecontainer">
|
|
<div id="getKnownSectors" class="function">
|
|
<p>
|
|
<span class="keyword">function SectorView...</span> getKnownSectors() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getKnownSectors" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getKnownSectorsOfFaction" class="codecontainer">
|
|
<div id="getKnownSectorsOfFaction" class="function">
|
|
<p>
|
|
<span class="keyword">function SectorView...</span> getKnownSectorsOfFaction(<span class="type">int</span> <span class="parameter">factionIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getKnownSectorsOfFaction" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getKnownSectorsWithFaction" class="codecontainer">
|
|
<div id="getKnownSectorsWithFaction" class="function">
|
|
<p>
|
|
<span class="keyword">function SectorView...</span> getKnownSectorsWithFaction(<span class="type">int</span> <span class="parameter">factionIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getKnownSectorsWithFaction" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getMemberLocation" class="codecontainer">
|
|
<div id="getMemberLocation" class="function">
|
|
<p>
|
|
<span class="keyword">function int, int</span> getMemberLocation(<span class="type">int</span> <span class="parameter">playerIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getMemberLocation" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getMemberRank" class="codecontainer">
|
|
<div id="getMemberRank" class="function">
|
|
<p>
|
|
<span class="keyword">function AllianceRank</span> getMemberRank(<span class="type">int</span> <span class="parameter">playerIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getMemberRank" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getMembers" class="codecontainer">
|
|
<div id="getMembers" class="function">
|
|
<p>
|
|
<span class="keyword">function table<int, Member></span> getMembers() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getMembers" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getNamesOfShipsInSector" class="codecontainer">
|
|
<div id="getNamesOfShipsInSector" class="function">
|
|
<p>
|
|
<span class="keyword">function string...</span> getNamesOfShipsInSector(<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="getNamesOfShipsInSector" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getNewMemberRank" class="codecontainer">
|
|
<div id="getNewMemberRank" class="function">
|
|
<p>
|
|
<span class="keyword">function string</span> getNewMemberRank() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getNewMemberRank" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getOnlineMembers" class="codecontainer">
|
|
<div id="getOnlineMembers" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getOnlineMembers() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getOnlineMembers" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getRank" class="codecontainer">
|
|
<div id="getRank" class="function">
|
|
<p>
|
|
<span class="keyword">function AllianceRank</span> getRank(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getRank" 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="getShipAvailability" class="codecontainer">
|
|
<div id="getShipAvailability" class="function">
|
|
<p>
|
|
<span class="keyword">function ShipAvailability</span> getShipAvailability(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipAvailability" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipBoundingBox" class="codecontainer">
|
|
<div id="getShipBoundingBox" class="function">
|
|
<p>
|
|
<span class="keyword">function Box</span> getShipBoundingBox(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipBoundingBox" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipCanPassRifts" class="codecontainer">
|
|
<div id="getShipCanPassRifts" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> getShipCanPassRifts(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipCanPassRifts" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipCargo" class="codecontainer">
|
|
<div id="getShipCargo" class="function">
|
|
<p>
|
|
<span class="keyword">function CargoBay</span> getShipCargo(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipCargo" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipCargos" class="codecontainer">
|
|
<div id="getShipCargos" class="function">
|
|
<p>
|
|
<span class="keyword">function table<TradingGood, int></span> getShipCargos(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipCargos" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipCrew" class="codecontainer">
|
|
<div id="getShipCrew" class="function">
|
|
<p>
|
|
<span class="keyword">function Crew</span> getShipCrew(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipCrew" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipDestroyed" class="codecontainer">
|
|
<div id="getShipDestroyed" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> getShipDestroyed(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipDestroyed" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipHyperspaceReach" class="codecontainer">
|
|
<div id="getShipHyperspaceReach" class="function">
|
|
<p>
|
|
<span class="keyword">function float</span> getShipHyperspaceReach(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipHyperspaceReach" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipIcon" class="codecontainer">
|
|
<div id="getShipIcon" class="function">
|
|
<p>
|
|
<span class="keyword">function string</span> getShipIcon(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipIcon" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipNames" class="codecontainer">
|
|
<div id="getShipNames" class="function">
|
|
<p>
|
|
<span class="keyword">function string...</span> getShipNames() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipNames" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipOrderInfo" class="codecontainer">
|
|
<div id="getShipOrderInfo" class="function">
|
|
<p>
|
|
<span class="keyword">function string</span> getShipOrderInfo(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipOrderInfo" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipPayment" class="codecontainer">
|
|
<div id="getShipPayment" class="function">
|
|
<p>
|
|
<span class="keyword">function float</span> getShipPayment(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipPayment" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipPaymentTime" class="codecontainer">
|
|
<div id="getShipPaymentTime" class="function">
|
|
<p>
|
|
<span class="keyword">function float</span> getShipPaymentTime(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipPaymentTime" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipPlan" class="codecontainer">
|
|
<div id="getShipPlan" class="function">
|
|
<p>
|
|
<span class="keyword">function BlockPlan</span> getShipPlan(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipPlan" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipPosition" class="codecontainer">
|
|
<div id="getShipPosition" class="function">
|
|
<p>
|
|
<span class="keyword">function Coordinates</span> getShipPosition(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipPosition" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipReconstructionValue" class="codecontainer">
|
|
<div id="getShipReconstructionValue" class="function">
|
|
<p>
|
|
<span class="keyword">function double</span> getShipReconstructionValue(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipReconstructionValue" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipStatus" class="codecontainer">
|
|
<div id="getShipStatus" class="function">
|
|
<p>
|
|
<span class="keyword">function string</span> getShipStatus(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipStatus" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipSystems" class="codecontainer">
|
|
<div id="getShipSystems" class="function">
|
|
<p>
|
|
<span class="keyword">function ShipInfoUpgrade...</span> getShipSystems(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipSystems" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipTurretDesigns" class="codecontainer">
|
|
<div id="getShipTurretDesigns" class="function">
|
|
<p>
|
|
<span class="keyword">function table<int, TurretDesign></span> getShipTurretDesigns(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipTurretDesigns" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getShipType" class="codecontainer">
|
|
<div id="getShipType" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> getShipType(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getShipType" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="hasPrivilege" class="codecontainer">
|
|
<div id="hasPrivilege" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> hasPrivilege(<span class="type">int</span> <span class="parameter">playerIndex</span>, <span class="type">int</span> <span class="parameter">privilege</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="hasPrivilege" 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="invokeFunction" class="codecontainer">
|
|
<div id="invokeFunction" class="function">
|
|
<p>
|
|
<span class="keyword">function var...</span> invokeFunction() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="invokeFunction" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="knowsSector" class="codecontainer">
|
|
<div id="knowsSector" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> knowsSector(<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="knowsSector" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="moveRank" class="codecontainer">
|
|
<div id="moveRank" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> moveRank(<span class="type">string</span> <span class="parameter">name</span>, <span class="type">string</span> <span class="parameter">lowerName</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="moveRank" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="ownsShip" class="codecontainer">
|
|
<div id="ownsShip" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> ownsShip(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="ownsShip" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="rankExists" class="codecontainer">
|
|
<div id="rankExists" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> rankExists(<span class="type">string</span> <span class="parameter">rank</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="rankExists" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="registerCallback" class="codecontainer">
|
|
<div id="registerCallback" class="function">
|
|
<p>
|
|
<span class="keyword">function var</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 player. The callback will be removed when the sector is changed or the receiver, if it's an entity, is 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>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeDestroyedShipInfo" class="codecontainer">
|
|
<div id="removeDestroyedShipInfo" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeDestroyedShipInfo(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="removeDestroyedShipInfo" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeKnownSector" class="codecontainer">
|
|
<div id="removeKnownSector" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeKnownSector(<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="removeKnownSector" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeRank" class="codecontainer">
|
|
<div id="removeRank" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeRank(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="removeRank" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="removeRankPrivilege" class="codecontainer">
|
|
<div id="removeRankPrivilege" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> removeRankPrivilege(<span class="type">string</span> <span class="parameter">rankName</span>, <span class="type">int</span> <span class="parameter">privilege</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="removeRankPrivilege" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</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="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="restoreCraft" class="codecontainer">
|
|
<div id="restoreCraft" class="function">
|
|
<p>
|
|
<span class="keyword">function Entity</span> restoreCraft(<span class="type">string</span> <span class="parameter">name</span>, <span class="type">Matrix</span> <span class="parameter">position</span>, <span class="type">bool</span> <span class="parameter">withMalus</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="restoreCraft" class="">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="restoreTurrets" class="codecontainer">
|
|
<div id="restoreTurrets" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> restoreTurrets(<span class="type">Entity</span> <span class="parameter">scriptCraft</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="restoreTurrets" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="sendCallback" class="codecontainer">
|
|
<div id="sendCallback" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> sendCallback() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="sendCallback" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="sendChatMessage" class="codecontainer">
|
|
<div id="sendChatMessage" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> sendChatMessage(<span class="type">var</span> <span class="parameter">sender</span>, <span class="type">int</span> <span class="parameter">messageType</span>, <span class="type">string</span> <span class="parameter">message</span>, <span class="type">PluralForm...</span> <span class="parameter">args</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="sendChatMessage" class="">
|
|
<p>
|
|
Send a chat message to the player. Supports sending of format arguments so that the message can be translated on the client.
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">sender</span>
|
|
The sender that will be displayed for the chat message <br/>
|
|
<span class="parameter">messageType</span>
|
|
The type of chat message, 0 = Normal, 1 = Error, 2 = Warning, 3 = Info <br/>
|
|
<span class="parameter">message</span>
|
|
The message that will be sent <br/>
|
|
<span class="parameter">args</span>
|
|
The format arguments that will be sent <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setMemberRank" class="codecontainer">
|
|
<div id="setMemberRank" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setMemberRank(<span class="type">int</span> <span class="parameter">playerIndex</span>, <span class="type">string</span> <span class="parameter">rank</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setMemberRank" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setNewMemberRank" class="codecontainer">
|
|
<div id="setNewMemberRank" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setNewMemberRank(<span class="type">string</span> <span class="parameter">rank</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setNewMemberRank" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setShipAvailability" class="codecontainer">
|
|
<div id="setShipAvailability" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setShipAvailability(<span class="type">string</span> <span class="parameter">name</span>, <span class="type">ShipAvailability</span> <span class="parameter">availability</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setShipAvailability" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setShipDestroyed" class="codecontainer">
|
|
<div id="setShipDestroyed" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setShipDestroyed(<span class="type">string</span> <span class="parameter">name</span>, <span class="type">bool</span> <span class="parameter">value</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setShipDestroyed" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setShipIcon" class="codecontainer">
|
|
<div id="setShipIcon" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setShipIcon(<span class="type">string</span> <span class="parameter">name</span>, <span class="type">string</span> <span class="parameter">icon</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setShipIcon" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setShipOrderInfo" class="codecontainer">
|
|
<div id="setShipOrderInfo" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setShipOrderInfo(<span class="type">string</span> <span class="parameter">name</span>, <span class="type">var</span> <span class="parameter">value</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setShipOrderInfo" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setShipReconstructionValue" class="codecontainer">
|
|
<div id="setShipReconstructionValue" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setShipReconstructionValue(<span class="type">string</span> <span class="parameter">name</span>, <span class="type">double</span> <span class="parameter">value</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setShipReconstructionValue" class="">
|
|
<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 var</span> unregisterCallback(<span class="type">string</span> <span class="parameter"></span>, <span class="type">string</span> <span class="parameter"></span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="unregisterCallback" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="updateKnownSector" class="codecontainer">
|
|
<div id="updateKnownSector" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> updateKnownSector(<span class="type">SectorView</span> <span class="parameter">view</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="updateKnownSector" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="updateKnownSectorPreserveNote" class="codecontainer">
|
|
<div id="updateKnownSectorPreserveNote" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> updateKnownSectorPreserveNote(<span class="type">SectorView</span> <span class="parameter">view</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="updateKnownSectorPreserveNote" class="">
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="addPlanStyle" class="codecontainer">
|
|
<div id="addPlanStyle" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> addPlanStyle(<span class="type">string</span> <span class="parameter">name</span>, <span class="type">PlanStyle</span> <span class="parameter">style</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="addPlanStyle" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="canPay" class="codecontainer">
|
|
<div id="canPay" class="function">
|
|
<p>
|
|
<span class="keyword">function bool, string, table<int, string></span> canPay() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="canPay" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="canPayMoney" class="codecontainer">
|
|
<div id="canPayMoney" class="function">
|
|
<p>
|
|
<span class="keyword">function bool, string, table<int, string></span> canPayMoney(<span class="type">int</span> <span class="parameter">money</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="canPayMoney" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="canPayResource" class="codecontainer">
|
|
<div id="canPayResource" class="function">
|
|
<p>
|
|
<span class="keyword">function bool, string, table<int, string></span> canPayResource(<span class="type">Material</span> <span class="parameter">material</span>, <span class="type">int</span> <span class="parameter">amount</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="canPayResource" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
</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="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getAllRelations" class="codecontainer">
|
|
<div id="getAllRelations" class="function">
|
|
<p>
|
|
<span class="keyword">function Relation...</span> getAllRelations() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getAllRelations" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getHomeSectorCoordinates" class="codecontainer">
|
|
<div id="getHomeSectorCoordinates" class="function">
|
|
<p>
|
|
<span class="keyword">function int, int</span> getHomeSectorCoordinates() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getHomeSectorCoordinates" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getInventory" class="codecontainer">
|
|
<div id="getInventory" class="function">
|
|
<p>
|
|
<span class="keyword">function Inventory</span> getInventory() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getInventory" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getLanguage" class="codecontainer">
|
|
<div id="getLanguage" class="function">
|
|
<p>
|
|
<span class="keyword">function Language</span> getLanguage() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getLanguage" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getPlanStyle" class="codecontainer">
|
|
<div id="getPlanStyle" class="function">
|
|
<p>
|
|
<span class="keyword">function PlanStyle</span> getPlanStyle(<span class="type">string</span> <span class="parameter">name</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getPlanStyle" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getPlanStyleNames" class="codecontainer">
|
|
<div id="getPlanStyleNames" class="function">
|
|
<p>
|
|
<span class="keyword">function string...</span> getPlanStyleNames() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getPlanStyleNames" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getRelation" class="codecontainer">
|
|
<div id="getRelation" class="function">
|
|
<p>
|
|
<span class="keyword">function Relation</span> getRelation(<span class="type">int</span> <span class="parameter">otherFactionIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getRelation" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getRelations" class="codecontainer">
|
|
<div id="getRelations" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> getRelations(<span class="type">int</span> <span class="parameter">factionIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getRelations" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getRelationStatus" class="codecontainer">
|
|
<div id="getRelationStatus" class="function">
|
|
<p>
|
|
<span class="keyword">function int</span> getRelationStatus(<span class="type">int</span> <span class="parameter">factionIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getRelationStatus" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getResources" class="codecontainer">
|
|
<div id="getResources" class="function">
|
|
<p>
|
|
<span class="keyword">function int...</span> getResources() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getResources" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTrait" class="codecontainer">
|
|
<div id="getTrait" class="function">
|
|
<p>
|
|
<span class="keyword">function float</span> getTrait(<span class="type">string</span> <span class="parameter">trait</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getTrait" class="">
|
|
<p>
|
|
Retrieves a trait value associated with a key <span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">trait</span>
|
|
The name of the trait <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
The trait value associated with the key
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="getTraits" class="codecontainer">
|
|
<div id="getTraits" class="function">
|
|
<p>
|
|
<span class="keyword">function table<string, float></span> getTraits() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="getTraits" class="">
|
|
<p>
|
|
Retrieves all key-value trait pairs of the faction <span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</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="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="Faction [Server].html">Faction [Server]</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 <span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</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="hasStaticRelationsToFaction" class="codecontainer">
|
|
<div id="hasStaticRelationsToFaction" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> hasStaticRelationsToFaction(<span class="type">int</span> <span class="parameter">factionIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="hasStaticRelationsToFaction" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="knowsFaction" class="codecontainer">
|
|
<div id="knowsFaction" class="function">
|
|
<p>
|
|
<span class="keyword">function bool</span> knowsFaction(<span class="type">int</span> <span class="parameter">factionIndex</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="knowsFaction" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="pay" class="codecontainer">
|
|
<div id="pay" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> pay(<span class="type">string or Format [optional]</span> <span class="parameter">description</span>, <span class="type">int</span> <span class="parameter">money</span>, <span class="type">int...</span> <span class="parameter">resources</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="pay" class="">
|
|
<p>
|
|
Makes the faction pay a certain amount of money and resources. If the faction can't pay, the respective money and resources will be set to 0. This function accepts an optional string for Format as first argument, as an economy notification describing the transaction that will be sent to the player, in case the faction is a player. <br/>To ease handling of transaction descriptions, the format description (if set) will receive all the remaining arguments given to the pay() function as format arguments, in the same order as they are given to the function. Dots for easier reading will be inserted as well. Examples:<br/><br/> faction:pay("Paid %1% Credits and %2% iron.", 50000, 250) <br/> -> "Paid 50.000 Credits and 250 iron."<br/><br/> faction:pay(Format("%1% paid %2% Credits and %3% iron.", "Excelsior"), 50, 25000) <br/> -> "Excelsior paid 50 Credits and 25.000 iron."<br/><br/> <span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">description</span>
|
|
[optional] A description for the transaction. Can either be a string or a Format. If this variable is set, money and resources will be appended to the end of the list of arguments passed to the description format string. <br/>
|
|
<span class="parameter">money</span>
|
|
Money that will be removed from the faction <br/>
|
|
<span class="parameter">resources</span>
|
|
A list of resources, starting with iron, that will be removed from the faction <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="payResource" class="codecontainer">
|
|
<div id="payResource" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> payResource(<span class="type">string or Format</span> <span class="parameter">description</span>, <span class="type">Material</span> <span class="parameter">material</span>, <span class="type">int</span> <span class="parameter">amount</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="payResource" class="">
|
|
<p>
|
|
Makes the faction pay a certain amount of resources. If the faction can't pay, the respective resource will be set to 0. This function accepts a string for Format as first argument, as an economy notification describing the transaction that will be sent to the player, in case the faction is a player. <span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">description</span>
|
|
A description for the transaction. Can either be a string or a Format. <br/>
|
|
<span class="parameter">material</span>
|
|
The kind of material that will be removed from the faction <br/>
|
|
<span class="parameter">amount</span>
|
|
Amount that will be removed from the faction <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="payWithoutNotify" class="codecontainer">
|
|
<div id="payWithoutNotify" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> payWithoutNotify(<span class="type">string or Format</span> <span class="parameter">description</span>, <span class="type">int</span> <span class="parameter">money</span>, <span class="type">int...</span> <span class="parameter">args</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="payWithoutNotify" class="">
|
|
<p>
|
|
Similar behavior to pay(), except there will not be a notification popping up in case the faction is a player, and the description for the transaction in this function isn't optional. <span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">description</span>
|
|
A description for the transaction. Can either be a string or a Format. Money and resources will be appended to the end of the list of arguments passed to the description format string. <br/>
|
|
<span class="parameter">money</span>
|
|
Money that will be removed from the faction <br/>
|
|
<span class="parameter">args</span>
|
|
A list of resources, starting with iron, that will be removed from the faction <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="receive" class="codecontainer">
|
|
<div id="receive" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> receive(<span class="type">string or Format [optional]</span> <span class="parameter">description</span>, <span class="type">int</span> <span class="parameter">money</span>, <span class="type">int...</span> <span class="parameter">resources</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="receive" class="">
|
|
<p>
|
|
Makes the faction receive a certain amount of money and resources. This function accepts an optional string for Format as first argument, as an economy notification describing the transaction that will be sent to the player, in case the faction is a player. <br/>To ease handling of transaction descriptions, the format description (if set) will receive all the remaining arguments given to the receive() function as format arguments, in the same order as they are given to the function. Dots for easier reading will be inserted as well. Examples:<br/><br/> faction:receive("Got %1% Credits and %2% iron.", 50000, 250) <br/> -> "Got 50.000 Credits and 250 iron."<br/><br/> faction:receive(Format("%1% received %2% Credits and %3% iron.", "Excelsior"), 50, 25000) <br/> -> "Excelsior received 50 Credits and 25.000 iron."<br/><br/> <span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">description</span>
|
|
[optional] A description for the transaction. Can either be a string or a Format. If this variable is set, money and resources will be appended to the end of the list of arguments passed to the description format string. <br/>
|
|
<span class="parameter">money</span>
|
|
Money that will be given to the faction <br/>
|
|
<span class="parameter">resources</span>
|
|
A list of resources, starting with iron, that will be given to the faction <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="receiveResource" class="codecontainer">
|
|
<div id="receiveResource" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> receiveResource(<span class="type">string or Format</span> <span class="parameter">description</span>, <span class="type">Material</span> <span class="parameter">material</span>, <span class="type">int</span> <span class="parameter">amount</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="receiveResource" class="">
|
|
<p>
|
|
Makes the faction receive a certain amount of resources. This function accepts a string for Format as first argument, as an economy notification describing the transaction that will be sent to the player, in case the faction is a player. <span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">description</span>
|
|
A description for the transaction. Can either be a string or a Format. <br/>
|
|
<span class="parameter">material</span>
|
|
The kind of material that will be given to the faction <br/>
|
|
<span class="parameter">amount</span>
|
|
Amount that will be given to the faction <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="receiveWithoutNotify" class="codecontainer">
|
|
<div id="receiveWithoutNotify" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> receiveWithoutNotify(<span class="type">string or Format</span> <span class="parameter">description</span>, <span class="type">int</span> <span class="parameter">money</span>, <span class="type">int...</span> <span class="parameter">args</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="receiveWithoutNotify" class="">
|
|
<p>
|
|
Similar behavior to receive(), except there will not be a notification popping up in case the faction is a player, and the description for the transaction in this function isn't optional. <span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">description</span>
|
|
A description for the transaction. Can either be a string or a Format. Money and resources will be appended to the end of the list of arguments passed to the description format string. <br/>
|
|
<span class="parameter">money</span>
|
|
Money that will be given to the faction <br/>
|
|
<span class="parameter">args</span>
|
|
A list of resources, starting with iron, that will be given to the faction <br/>
|
|
</div>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="sendCallback" class="codecontainer">
|
|
<div id="sendCallback" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> sendCallback() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="sendCallback" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="sendChatMessage" class="codecontainer">
|
|
<div id="sendChatMessage" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> sendChatMessage() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="sendChatMessage" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setHomeSectorCoordinates" class="codecontainer">
|
|
<div id="setHomeSectorCoordinates" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setHomeSectorCoordinates(<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="setHomeSectorCoordinates" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setLanguage" class="codecontainer">
|
|
<div id="setLanguage" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setLanguage(<span class="type">Language</span> <span class="parameter">language</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setLanguage" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setResources" class="codecontainer">
|
|
<div id="setResources" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setResources() <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setResources" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setStaticRelationsToFaction" class="codecontainer">
|
|
<div id="setStaticRelationsToFaction" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setStaticRelationsToFaction(<span class="type">int</span> <span class="parameter">factionIndex</span>, <span class="type">bool</span> <span class="parameter">in</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setStaticRelationsToFaction" class="">
|
|
<p>
|
|
<span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Returns</span></p>
|
|
<div class="indented">
|
|
<p>
|
|
nothing
|
|
</p>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="setTrait" class="codecontainer">
|
|
<div id="setTrait" class="function">
|
|
<p>
|
|
<span class="keyword">function var</span> setTrait(<span class="type">string</span> <span class="parameter">trait</span>, <span class="type">float</span> <span class="parameter">value</span>) <br/>
|
|
</p>
|
|
</div>
|
|
<div id="setTrait" class="">
|
|
<p>
|
|
Sets a trait value associated with a key <span class="inheritedcode">Inherited from <a href="Faction [Server].html">Faction [Server]</a></span>
|
|
|
|
</p>
|
|
<p><span class="docheader">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">trait</span>
|
|
The name of the trait <br/>
|
|
<span class="parameter">value</span>
|
|
The value of the trait, should be between -1 and 1 <br/>
|
|
</div>
|
|
<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="Faction [Server].html">Faction [Server]</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>
|
|
</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>
|