1681 lines
53 KiB
HTML
1681 lines
53 KiB
HTML
<html>
|
|
<head>
|
|
<title> Avorion Script Callbacks - Player [Client] </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 href="#onAllianceChanged">onAllianceChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onAllianceInvitationReceived">onAllianceInvitationReceived</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onChatRestrictionTimeChanged">onChatRestrictionTimeChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onConfirmSectorArrival">onConfirmSectorArrival</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onGalaxyMapUpdate">onGalaxyMapUpdate</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onGroupChanged">onGroupChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onGroupLeaderChanged">onGroupLeaderChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onGroupPlayerCraftChanged">onGroupPlayerCraftChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onGroupPlayerSectorChanged">onGroupPlayerSectorChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onHideGalaxyMap">onHideGalaxyMap</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onHomeSectorChanged">onHomeSectorChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onHyperspaceRestrictionTimeChanged">onHyperspaceRestrictionTimeChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onItemAdded">onItemAdded</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onItemChanged">onItemChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onItemPropertiesChanged">onItemPropertiesChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onItemRemoved">onItemRemoved</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onKnownSectorAdded">onKnownSectorAdded</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onKnownSectorRemoved">onKnownSectorRemoved</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onKnownSectorUpdated">onKnownSectorUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onMailAdded">onMailAdded</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onMailCleared">onMailCleared</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onMailRead">onMailRead</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onMailRemoved">onMailRemoved</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onMailUpdated">onMailUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onMapRenderAfterLayers">onMapRenderAfterLayers</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onMapRenderAfterTooltips">onMapRenderAfterTooltips</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onMapRenderAfterUI">onMapRenderAfterUI</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onMapRenderBeforeLayers">onMapRenderBeforeLayers</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onNameChanged">onNameChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onPlayerEnteredGroup">onPlayerEnteredGroup</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onPlayerLeftGroup">onPlayerLeftGroup</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onPostRenderHud">onPostRenderHud</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onPostRenderIndicators">onPostRenderIndicators</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onPreRenderHud">onPreRenderHud</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onReconstructionSectorChanged">onReconstructionSectorChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onRelationChanged">onRelationChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onRelationLevelChanged">onRelationLevelChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onRelationStatusChanged">onRelationStatusChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onResourcesChanged">onResourcesChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onSectorChanged">onSectorChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onSelectMapCoordinates">onSelectMapCoordinates</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipAvailabilityUpdated">onShipAvailabilityUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipCargoUpdated">onShipCargoUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipChanged">onShipChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipCrewUpdated">onShipCrewUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipHyperspacePropertiesUpdated">onShipHyperspacePropertiesUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipIconUpdated">onShipIconUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipInfoAdded">onShipInfoAdded</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipInfoRemoved">onShipInfoRemoved</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipInfoUpdated">onShipInfoUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipNameUpdated">onShipNameUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipOrderInfoUpdated">onShipOrderInfoUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipPayDayUpdated">onShipPayDayUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipPlanUpdated">onShipPlanUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipPositionUpdated">onShipPositionUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipReconstructionValueUpdated">onShipReconstructionValueUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipStatusMessageUpdated">onShipStatusMessageUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipTitleUpdated">onShipTitleUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShipTypeUpdated">onShipTypeUpdated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShowGalaxyMap">onShowGalaxyMap</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onStartDialog">onStartDialog</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onStateChanged">onStateChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onStateFormChanged">onStateFormChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onTraitChanged">onTraitChanged</a>
|
|
</td></tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="floatright" id="Player [Client] ">
|
|
<h1>Player [Client] Callbacks</h1>
|
|
<p>
|
|
Note: Callbacks have to be buffered in certain situations and won't happen immediately. When unregistering a callback <b>during</b> a callback, all callbacks that were buffered during the last frame may still be sent, even though they were unregistered.
|
|
</p>
|
|
<div id="onAllianceChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onAllianceChanged(allianceIndex) <br/>
|
|
</p>
|
|
<div id="onAllianceChanged" class="code">
|
|
<p>
|
|
Executed whenever the player's alliance changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">allianceIndex</span>
|
|
The faction index of the alliance <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onAllianceInvitationReceived" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onAllianceInvitationReceived(allianceIndex) <br/>
|
|
</p>
|
|
<div id="onAllianceInvitationReceived" class="code">
|
|
<p>
|
|
Executed whenever the player receives an invitation from an alliance
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">allianceIndex</span>
|
|
The faction index of the alliance <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onChatRestrictionTimeChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onChatRestrictionTimeChanged(time) <br/>
|
|
</p>
|
|
<div id="onChatRestrictionTimeChanged" class="code">
|
|
<p>
|
|
Executed whenever a player's chat restriction time is changed. This usually only happens when administrators need to stop a player from using chat.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">time</span>
|
|
The time that player is muted <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onConfirmSectorArrival" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onConfirmSectorArrival(x, y) <br/>
|
|
</p>
|
|
<div id="onConfirmSectorArrival" class="code">
|
|
<p>
|
|
Called whenever a loading screen is no longer visible and the player now sees the new sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">x</span>
|
|
X coordinate of the new sector <br/>
|
|
<span class="parameter">y</span>
|
|
Y coordinate of the new sector <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onGalaxyMapUpdate" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onGalaxyMapUpdate(timeStep) <br/>
|
|
</p>
|
|
<div id="onGalaxyMapUpdate" class="code">
|
|
<p>
|
|
Executed whenever the map is visible and updated by a game tick.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">timeStep</span>
|
|
The time step since the last update <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onGroupChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onGroupChanged(groupIndex) <br/>
|
|
</p>
|
|
<div id="onGroupChanged" class="code">
|
|
<p>
|
|
Executed whenever the player's group index changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">groupIndex</span>
|
|
The index of the group the player is in <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onGroupLeaderChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onGroupLeaderChanged(playerIndex) <br/>
|
|
</p>
|
|
<div id="onGroupLeaderChanged" class="code">
|
|
<p>
|
|
Executed whenever the leader of the player's group changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">playerIndex</span>
|
|
The index of the new leader player <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onGroupPlayerCraftChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onGroupPlayerCraftChanged(playerIndex, id) <br/>
|
|
</p>
|
|
<div id="onGroupPlayerCraftChanged" class="code">
|
|
<p>
|
|
Executed whenever another player of the player's group changes crafts
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">playerIndex</span>
|
|
The index of the other player <br/>
|
|
<span class="parameter">id</span>
|
|
The id of the new craft <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onGroupPlayerSectorChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onGroupPlayerSectorChanged(playerIndex, x, y) <br/>
|
|
</p>
|
|
<div id="onGroupPlayerSectorChanged" class="code">
|
|
<p>
|
|
Executed whenever another player of the player's group changes sectors
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">playerIndex</span>
|
|
The index of the other player <br/>
|
|
<span class="parameter">x</span>
|
|
The x coordinate of the new sector <br/>
|
|
<span class="parameter">y</span>
|
|
The y coordinate of the new sector <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onHideGalaxyMap" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onHideGalaxyMap() <br/>
|
|
</p>
|
|
<div id="onHideGalaxyMap" class="code">
|
|
<p>
|
|
Executed whenever the player closes the map.
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onHomeSectorChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onHomeSectorChanged(x, y) <br/>
|
|
</p>
|
|
<div id="onHomeSectorChanged" class="code">
|
|
<p>
|
|
Called whenever the home sector of the player changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">x</span>
|
|
The x coordinate of the new home sector <br/>
|
|
<span class="parameter">y</span>
|
|
The y coordinate of the new home sector <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onHyperspaceRestrictionTimeChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onHyperspaceRestrictionTimeChanged(time) <br/>
|
|
</p>
|
|
<div id="onHyperspaceRestrictionTimeChanged" class="code">
|
|
<p>
|
|
Executed whenever a player's hyperspace restriction time is changed. This usually only happens when administrators need to trap a player in a specific sector.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">time</span>
|
|
The time that player is trapped <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onItemAdded" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onItemAdded(item, index, amount, amountBefore, tagsChanged) <br/>
|
|
</p>
|
|
<div id="onItemAdded" class="code">
|
|
<p>
|
|
Called whenever an item in the player inventory is added
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">item</span>
|
|
The inventory item <br/>
|
|
<span class="parameter">index</span>
|
|
Index of the inventory item <br/>
|
|
<span class="parameter">amount</span>
|
|
Amount of items in the slot <br/>
|
|
<span class="parameter">amountBefore</span>
|
|
Amount of items in the slot before the change <br/>
|
|
<span class="parameter">tagsChanged</span>
|
|
Boolean indicating if the tags of the item changed <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onItemChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onItemChanged(item, index, amount, amountBefore) <br/>
|
|
</p>
|
|
<div id="onItemChanged" class="code">
|
|
<p>
|
|
Called whenever an item in the player inventory changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">item</span>
|
|
The inventory item <br/>
|
|
<span class="parameter">index</span>
|
|
Index of the inventory item <br/>
|
|
<span class="parameter">amount</span>
|
|
Amount of items in the slot <br/>
|
|
<span class="parameter">amountBefore</span>
|
|
Amount of items in the slot before the change <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onItemPropertiesChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onItemPropertiesChanged(item, index, amount) <br/>
|
|
</p>
|
|
<div id="onItemPropertiesChanged" class="code">
|
|
<p>
|
|
Called whenever an item in the player inventory changes properties
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">item</span>
|
|
The inventory item <br/>
|
|
<span class="parameter">index</span>
|
|
Index of the inventory item <br/>
|
|
<span class="parameter">amount</span>
|
|
Amount of items in the slot <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onItemRemoved" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onItemRemoved(item, index, amount, amountBefore) <br/>
|
|
</p>
|
|
<div id="onItemRemoved" class="code">
|
|
<p>
|
|
Called whenever an item in the player inventory is removed
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">item</span>
|
|
The inventory item <br/>
|
|
<span class="parameter">index</span>
|
|
Index of the inventory item <br/>
|
|
<span class="parameter">amount</span>
|
|
Amount of items in the slot <br/>
|
|
<span class="parameter">amountBefore</span>
|
|
Amount of items in the slot before the change <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onKnownSectorAdded" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onKnownSectorAdded(x, y) <br/>
|
|
</p>
|
|
<div id="onKnownSectorAdded" class="code">
|
|
<p>
|
|
Called whenever a new tracked sector is added to the player database
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">x</span>
|
|
The x coordinate of the sector <br/>
|
|
<span class="parameter">y</span>
|
|
The y coordinate of the sector <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onKnownSectorRemoved" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onKnownSectorRemoved(x, y) <br/>
|
|
</p>
|
|
<div id="onKnownSectorRemoved" class="code">
|
|
<p>
|
|
Called whenever a tracked sector was removed from the player database
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">x</span>
|
|
The x coordinate of the sector <br/>
|
|
<span class="parameter">y</span>
|
|
The y coordinate of the sector <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onKnownSectorUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onKnownSectorUpdated(x, y) <br/>
|
|
</p>
|
|
<div id="onKnownSectorUpdated" class="code">
|
|
<p>
|
|
Called whenever a tracked sector is updated in the player database
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">x</span>
|
|
The x coordinate of the sector <br/>
|
|
<span class="parameter">y</span>
|
|
The y coordinate of the sector <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onMailAdded" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onMailAdded(mail, id) <br/>
|
|
</p>
|
|
<div id="onMailAdded" class="code">
|
|
<p>
|
|
Executed whenever the player receives a mail
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">mail</span>
|
|
The mail the player received <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onMailCleared" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onMailCleared(mailIndex, id) <br/>
|
|
</p>
|
|
<div id="onMailCleared" class="code">
|
|
<p>
|
|
Executed whenever a mail was cleared
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">mailIndex</span>
|
|
The index of the cleared mail <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onMailRead" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onMailRead(mailIndex, id) <br/>
|
|
</p>
|
|
<div id="onMailRead" class="code">
|
|
<p>
|
|
Executed whenever a mail was read
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">mailIndex</span>
|
|
The index of the read mail <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onMailRemoved" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onMailRemoved(mailIndex, id) <br/>
|
|
</p>
|
|
<div id="onMailRemoved" class="code">
|
|
<p>
|
|
Executed whenever a mail was removed from the player's mailbox
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">mailIndex</span>
|
|
The index of the removed mail <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onMailUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onMailUpdated(mail, mailIndex) <br/>
|
|
</p>
|
|
<div id="onMailUpdated" class="code">
|
|
<p>
|
|
Executed whenever a mail was updated
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">mail</span>
|
|
The mail <br/>
|
|
<span class="parameter">mailIndex</span>
|
|
The index of the read mail <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onMapRenderAfterLayers" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onMapRenderAfterLayers() <br/>
|
|
</p>
|
|
<div id="onMapRenderAfterLayers" class="code">
|
|
<p>
|
|
Executed whenever the map is rendered, after its layers were rendered
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onMapRenderAfterTooltips" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onMapRenderAfterTooltips() <br/>
|
|
</p>
|
|
<div id="onMapRenderAfterTooltips" class="code">
|
|
<p>
|
|
Executed whenever the map is rendered, after its tooltips were rendered
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onMapRenderAfterUI" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onMapRenderAfterUI() <br/>
|
|
</p>
|
|
<div id="onMapRenderAfterUI" class="code">
|
|
<p>
|
|
Executed whenever the map is rendered, after its UI was rendered
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onMapRenderBeforeLayers" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onMapRenderBeforeLayers() <br/>
|
|
</p>
|
|
<div id="onMapRenderBeforeLayers" class="code">
|
|
<p>
|
|
Executed whenever the map is rendered, before its layers are rendered
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onNameChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onNameChanged(newName) <br/>
|
|
</p>
|
|
<div id="onNameChanged" class="code">
|
|
<p>
|
|
Called whenever the name of the player changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">newName</span>
|
|
The new name of the player <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onPlayerEnteredGroup" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onPlayerEnteredGroup(playerIndex) <br/>
|
|
</p>
|
|
<div id="onPlayerEnteredGroup" class="code">
|
|
<p>
|
|
Executed whenever another player enters the player's group
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">playerIndex</span>
|
|
The index of the player who entered <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onPlayerLeftGroup" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onPlayerLeftGroup(playerIndex) <br/>
|
|
</p>
|
|
<div id="onPlayerLeftGroup" class="code">
|
|
<p>
|
|
Executed whenever another player from the player's group leaves the group
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">playerIndex</span>
|
|
The index of the player who left <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onPostRenderHud" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onPostRenderHud(state) <br/>
|
|
</p>
|
|
<div id="onPostRenderHud" class="code">
|
|
<p>
|
|
Executed every frame during rendering after rendering the HUD. All render calls that should overlay the HUD should be done here.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">state</span>
|
|
The PlayerStateType of the client player (ie. flying, building, etc.) <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onPostRenderIndicators" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onPostRenderIndicators(state) <br/>
|
|
</p>
|
|
<div id="onPostRenderIndicators" class="code">
|
|
<p>
|
|
Executed every frame during rendering after rendering the targeters. All render calls that draw target indicators should be done here.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">state</span>
|
|
The PlayerStateType of the client player (ie. flying, building, etc.) <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onPreRenderHud" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onPreRenderHud(state) <br/>
|
|
</p>
|
|
<div id="onPreRenderHud" class="code">
|
|
<p>
|
|
Executed every frame during rendering before rendering the HUD. All render calls that are not supposed to overlay the HUD should be done here.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">state</span>
|
|
The PlayerStateType of the client player (ie. flying, building, etc.) <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onReconstructionSectorChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onReconstructionSectorChanged(x, y) <br/>
|
|
</p>
|
|
<div id="onReconstructionSectorChanged" class="code">
|
|
<p>
|
|
Executed whenever the player's respawn sector changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">x</span>
|
|
The x coordinate of the new sector <br/>
|
|
<span class="parameter">y</span>
|
|
The y coordinate of the new sector <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onRelationChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onRelationChanged(index, level, levelBefore, notify) <br/>
|
|
</p>
|
|
<div id="onRelationChanged" class="code">
|
|
<p>
|
|
Called whenever relations of the player to another faction change
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">index</span>
|
|
The index of the other faction <br/>
|
|
<span class="parameter">level</span>
|
|
The level of the relation <br/>
|
|
<span class="parameter">levelBefore</span>
|
|
The level of the relation before the change <br/>
|
|
<span class="parameter">notify</span>
|
|
A boolean indicating whether or not the player should be notified about the change <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onRelationLevelChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onRelationLevelChanged(index, level, levelBefore, notify) <br/>
|
|
</p>
|
|
<div id="onRelationLevelChanged" class="code">
|
|
<p>
|
|
Called whenever relation levels of the player to another faction change
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">index</span>
|
|
The index of the other faction <br/>
|
|
<span class="parameter">level</span>
|
|
The level of the relation <br/>
|
|
<span class="parameter">levelBefore</span>
|
|
The level of the relation before the change <br/>
|
|
<span class="parameter">notify</span>
|
|
A boolean indicating whether or not the player should be notified about the change <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onRelationStatusChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onRelationStatusChanged(index, status, statusBefore, notify) <br/>
|
|
</p>
|
|
<div id="onRelationStatusChanged" class="code">
|
|
<p>
|
|
Called whenever the relation status of the player to another faction change (relation status is not yet implemented so this callback will most likely not fire until relation status is in)
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">index</span>
|
|
The index of the other faction <br/>
|
|
<span class="parameter">status</span>
|
|
The status of the relations <br/>
|
|
<span class="parameter">statusBefore</span>
|
|
The status of the relation before the change <br/>
|
|
<span class="parameter">notify</span>
|
|
A boolean indicating whether or not the player should be notified about the change <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onResourcesChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onResourcesChanged(money, resources, infinite, notify) <br/>
|
|
</p>
|
|
<div id="onResourcesChanged" class="code">
|
|
<p>
|
|
Called whenever the amount of money or resources of the player changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">money</span>
|
|
The amount of money the player owns <br/>
|
|
<span class="parameter">resources</span>
|
|
The amount of resources the player owns, as table <br/>
|
|
<span class="parameter">infinite</span>
|
|
True if the player has infinite resources, false otherwise <br/>
|
|
<span class="parameter">notify</span>
|
|
A boolean indicating whether or not the player should be visually notified in some way that the resources changed <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onSectorChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onSectorChanged(x, y) <br/>
|
|
</p>
|
|
<div id="onSectorChanged" class="code">
|
|
<p>
|
|
Executed whenever the player changes the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">x</span>
|
|
The x coordinate of the new sector <br/>
|
|
<span class="parameter">y</span>
|
|
The y coordinate of the new sector <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onSelectMapCoordinates" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onSelectMapCoordinates(x, y) <br/>
|
|
</p>
|
|
<div id="onSelectMapCoordinates" class="code">
|
|
<p>
|
|
Executed whenever a coordinate on the map is selected.
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipAvailabilityUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipAvailabilityUpdated(name, availability) <br/>
|
|
</p>
|
|
<div id="onShipAvailabilityUpdated" class="code">
|
|
<p>
|
|
Called whenever a ShipInfo changes availability status (ie. goes into background simulation)
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the ship <br/>
|
|
<span class="parameter">availability</span>
|
|
The new availability status of the ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipCargoUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipCargoUpdated(name) <br/>
|
|
</p>
|
|
<div id="onShipCargoUpdated" class="code">
|
|
<p>
|
|
Called whenever the cargo of a ShipInfo changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipChanged(playerIndex, craftId, previousId) <br/>
|
|
</p>
|
|
<div id="onShipChanged" class="code">
|
|
<p>
|
|
Executed whenever the player changes the ship they're currently flying
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">playerIndex</span>
|
|
Index of the player <br/>
|
|
<span class="parameter">craftId</span>
|
|
The id of the new craft <br/>
|
|
<span class="parameter">previousId</span>
|
|
The id of the previous craft <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipCrewUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipCrewUpdated(name) <br/>
|
|
</p>
|
|
<div id="onShipCrewUpdated" class="code">
|
|
<p>
|
|
Called whenever the crew of a ShipInfo changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipHyperspacePropertiesUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipHyperspacePropertiesUpdated(name, reach, canPassRifts) <br/>
|
|
</p>
|
|
<div id="onShipHyperspacePropertiesUpdated" class="code">
|
|
<p>
|
|
Called whenever the hyperspace reach of a ShipInfo changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the ship <br/>
|
|
<span class="parameter">reach</span>
|
|
The new reach of the ship <br/>
|
|
<span class="parameter">canPassRifts</span>
|
|
A boolean indicating whether the ship can jump across rifts <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipIconUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipIconUpdated(name, icon) <br/>
|
|
</p>
|
|
<div id="onShipIconUpdated" class="code">
|
|
<p>
|
|
Called whenever the icon of a ShipInfo changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the ship <br/>
|
|
<span class="parameter">icon</span>
|
|
The new icon of the ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipInfoAdded" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipInfoAdded(name) <br/>
|
|
</p>
|
|
<div id="onShipInfoAdded" class="code">
|
|
<p>
|
|
Called whenever a ShipInfo is added to the player
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the new ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipInfoRemoved" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipInfoRemoved(name) <br/>
|
|
</p>
|
|
<div id="onShipInfoRemoved" class="code">
|
|
<p>
|
|
Called whenever a ShipInfo is removed from the player
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipInfoUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipInfoUpdated(name) <br/>
|
|
</p>
|
|
<div id="onShipInfoUpdated" class="code">
|
|
<p>
|
|
Called whenever a ShipInfo is updated in some way
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipNameUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipNameUpdated(name, newName) <br/>
|
|
</p>
|
|
<div id="onShipNameUpdated" class="code">
|
|
<p>
|
|
Called whenever the name of a ShipInfo changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the ship <br/>
|
|
<span class="parameter">newName</span>
|
|
The new name of the ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipOrderInfoUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipOrderInfoUpdated(name, orderInfo) <br/>
|
|
</p>
|
|
<div id="onShipOrderInfoUpdated" class="code">
|
|
<p>
|
|
Called whenever the order info of a ShipInfo changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the ship <br/>
|
|
<span class="parameter">orderInfo</span>
|
|
The order info of the ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipPayDayUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipPayDayUpdated(name, time) <br/>
|
|
</p>
|
|
<div id="onShipPayDayUpdated" class="code">
|
|
<p>
|
|
Called whenever the payday of a ShipInfo changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the ship <br/>
|
|
<span class="parameter">time</span>
|
|
The payday of the ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipPlanUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipPlanUpdated(name) <br/>
|
|
</p>
|
|
<div id="onShipPlanUpdated" class="code">
|
|
<p>
|
|
Called whenever the plan of a ShipInfo changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipPositionUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipPositionUpdated(name, x, y) <br/>
|
|
</p>
|
|
<div id="onShipPositionUpdated" class="code">
|
|
<p>
|
|
Called whenever a ShipInfo changes sectors
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the ship <br/>
|
|
<span class="parameter">x</span>
|
|
The new x coordinate of the ship <br/>
|
|
<span class="parameter">y</span>
|
|
The new y coordinate of the ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipReconstructionValueUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipReconstructionValueUpdated(name, value) <br/>
|
|
</p>
|
|
<div id="onShipReconstructionValueUpdated" class="code">
|
|
<p>
|
|
Called whenever the reconstruction value of a ShipInfo changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the ship <br/>
|
|
<span class="parameter">value</span>
|
|
The value of the ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipStatusMessageUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipStatusMessageUpdated(name, status, arguments) <br/>
|
|
</p>
|
|
<div id="onShipStatusMessageUpdated" class="code">
|
|
<p>
|
|
Called whenever the status info of a ShipInfo changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the ship <br/>
|
|
<span class="parameter">status</span>
|
|
The status info text of the ship <br/>
|
|
<span class="parameter">arguments</span>
|
|
A table holding the arguments of the status <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipTitleUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipTitleUpdated(name) <br/>
|
|
</p>
|
|
<div id="onShipTitleUpdated" class="code">
|
|
<p>
|
|
Called whenever the title of a ShipInfo changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShipTypeUpdated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShipTypeUpdated(name, type) <br/>
|
|
</p>
|
|
<div id="onShipTypeUpdated" class="code">
|
|
<p>
|
|
Called whenever the entity type of a ShipInfo changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">name</span>
|
|
The name of the ship <br/>
|
|
<span class="parameter">type</span>
|
|
The new entity type of the ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShowGalaxyMap" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShowGalaxyMap() <br/>
|
|
</p>
|
|
<div id="onShowGalaxyMap" class="code">
|
|
<p>
|
|
Executed whenever the player opens the map.
|
|
</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onStartDialog" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onStartDialog(objectIndex) <br/>
|
|
</p>
|
|
<div id="onStartDialog" class="code">
|
|
<p>
|
|
Executed when a dialog is started.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The index of the entity the dialog is started with <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onStateChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onStateChanged(newState, oldState) <br/>
|
|
</p>
|
|
<div id="onStateChanged" class="code">
|
|
<p>
|
|
Executed when the state of the player changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">newState</span>
|
|
The new state of the player <br/>
|
|
<span class="parameter">oldState</span>
|
|
The old state of the player <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onStateFormChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onStateFormChanged(newForm) <br/>
|
|
</p>
|
|
<div id="onStateFormChanged" class="code">
|
|
<p>
|
|
Called whenever the state form of the player changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">newForm</span>
|
|
The new state form of the player <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onTraitChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onTraitChanged(trait, value) <br/>
|
|
</p>
|
|
<div id="onTraitChanged" class="code">
|
|
<p>
|
|
Called whenever a "personality" trait of the player changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">trait</span>
|
|
The name of the trait that was changed <br/>
|
|
<span class="parameter">value</span>
|
|
The value of the new trait, from -1 to 1 <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>
|