2105 lines
68 KiB
HTML
2105 lines
68 KiB
HTML
<html>
|
|
<head>
|
|
<title> Avorion Script Callbacks - Sector </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="#onAIStateChanged">onAIStateChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onAllScriptValuesChanged">onAllScriptValuesChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onBlockChanged">onBlockChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onBlockDamaged">onBlockDamaged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onBlockDestroyed">onBlockDestroyed</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onBlockHealed">onBlockHealed</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onBlockPlanChanged">onBlockPlanChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onBlocksAdded">onBlocksAdded</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onBlocksRemove">onBlocksRemove</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onBlocksRemoved">onBlocksRemoved</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onBoardersDefeated">onBoardersDefeated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onBoardersLand">onBoardersLand</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onBoardingFight">onBoardingFight</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onBoardingSuccessful">onBoardingSuccessful</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onCargoChanged">onCargoChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onCargoLootCollected">onCargoLootCollected</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onCollision">onCollision</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onCraftSeatEntered">onCraftSeatEntered</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onCraftSeatLeft">onCraftSeatLeft</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onCrewChanged">onCrewChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onCrewChanged">onCrewChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onCrewLootCollected">onCrewLootCollected</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onDamaged">onDamaged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onDestroyed">onDestroyed</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onDockedByEntity">onDockedByEntity</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onEntityCreated">onEntityCreated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onEntityDocked">onEntityDocked</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onEntityEntered">onEntityEntered</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onEntityJump">onEntityJump</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onEntityRemoved">onEntityRemoved</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onEntityUndocked">onEntityUndocked</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onFighterAdded">onFighterAdded</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onFighterLanded">onFighterLanded</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onFighterRemove">onFighterRemove</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onFighterRemoved">onFighterRemoved</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onFighterStarted">onFighterStarted</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onHealed">onHealed</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onHullHit">onHullHit</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onInventoryItemLootCollected">onInventoryItemLootCollected</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onLootCollected">onLootCollected</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onMaterialLootCollected">onMaterialLootCollected</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onMoneyLootCollected">onMoneyLootCollected</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onPlanModifiedByBuilding">onPlanModifiedByBuilding</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onPlayerEntered">onPlayerEntered</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onPlayerLeft">onPlayerLeft</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onRestoredFromDisk">onRestoredFromDisk</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onScriptAdded">onScriptAdded</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onScriptRemoved">onScriptRemoved</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onScriptValueChanged">onScriptValueChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onSectorGenerated">onSectorGenerated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onSetForDeletion">onSetForDeletion</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShieldActivate">onShieldActivate</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShieldDamaged">onShieldDamaged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShieldDeactivate">onShieldDeactivate</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShieldHealed">onShieldHealed</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShieldHit">onShieldHit</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShotCreated">onShotCreated</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShotFired">onShotFired</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onShotHit">onShotHit</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onSquadAdded">onSquadAdded</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onSquadOrdersChanged">onSquadOrdersChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onSquadRemove">onSquadRemove</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onSquadRemoved">onSquadRemoved</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onStartFiring">onStartFiring</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onStopFiring">onStopFiring</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onSystemsChanged">onSystemsChanged</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onSystemUpgradeLootCollected">onSystemUpgradeLootCollected</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onTorpedoHit">onTorpedoHit</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onTorpedoHullHit">onTorpedoHullHit</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onTorpedoLaunched">onTorpedoLaunched</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onTorpedoShieldHit">onTorpedoShieldHit</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onTurretAdded">onTurretAdded</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onTurretDestroyed">onTurretDestroyed</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onTurretLootCollected">onTurretLootCollected</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onTurretRemoved">onTurretRemoved</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onTurretRemovedByPlayer">onTurretRemovedByPlayer</a>
|
|
</td></tr>
|
|
<tr><td>
|
|
<a href="#onUndockedFromEntity">onUndockedFromEntity</a>
|
|
</td></tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="floatright" id="Sector ">
|
|
<h1>Sector 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="onAIStateChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onAIStateChanged(entityId, state) <br/>
|
|
</p>
|
|
<div id="onAIStateChanged" class="code">
|
|
<p>
|
|
Executed whenever the AI state of an entity changes
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">state</span>
|
|
The id of the new state <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onAllScriptValuesChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onAllScriptValuesChanged(entityId) <br/>
|
|
</p>
|
|
<div id="onAllScriptValuesChanged" class="code">
|
|
<p>
|
|
Executed whenever all scripts values of an entity in the sector have been changed at once
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onBlockChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onBlockChanged(objectIndex, blockIndex, changeFlags) <br/>
|
|
</p>
|
|
<div id="onBlockChanged" class="code">
|
|
<p>
|
|
Executed whenever a plan of an entity is changed in the sector.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">blockIndex</span>
|
|
The index of the block <br/>
|
|
<span class="parameter">changeFlags</span>
|
|
The flags of the block changes <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onBlockDamaged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onBlockDamaged(objectIndex, blockIndex, inflictorId, damage, damageType) <br/>
|
|
</p>
|
|
<div id="onBlockDamaged" class="code">
|
|
<p>
|
|
Executed whenever a block object is damaged in the sector. This callback is executed after the damage is dealt to the block. Don't remove the block in this callback, this will lead to a crash.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The index of the damaged object <br/>
|
|
<span class="parameter">blockIndex</span>
|
|
The index of the damaged block <br/>
|
|
<span class="parameter">inflictorId</span>
|
|
The id of the entity that inflicted the damage <br/>
|
|
<span class="parameter">damage</span>
|
|
The damage that was inflicted to the entity <br/>
|
|
<span class="parameter">damageType</span>
|
|
The type of damage <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onBlockDestroyed" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onBlockDestroyed(objectIndex, index, block, lastDamageInflictor, damageSource) <br/>
|
|
</p>
|
|
<div id="onBlockDestroyed" class="code">
|
|
<p>
|
|
Executed whenever a block of a block object got destroyed This callback is executed *after* the block was destroyed
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">index</span>
|
|
Index of the block <br/>
|
|
<span class="parameter">block</span>
|
|
The block (as removed from the plan) <br/>
|
|
<span class="parameter">lastDamageInflictor</span>
|
|
The index of the last entity that inflicted damage to the destroyed block <br/>
|
|
<span class="parameter">damageSource</span>
|
|
The source of damage <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onBlockHealed" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onBlockHealed(objectIndex, blockIndex, damage) <br/>
|
|
</p>
|
|
<div id="onBlockHealed" class="code">
|
|
<p>
|
|
Executed whenever a block of an object is healed in the sector. Don't remove the block in this callback, this will lead to a crash.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The index of the healed object <br/>
|
|
<span class="parameter">blockIndex</span>
|
|
The index of the healed block <br/>
|
|
<span class="parameter">damage</span>
|
|
The damage the entity was healed for <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onBlockPlanChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onBlockPlanChanged(objectIndex, allBlocksChanged) <br/>
|
|
</p>
|
|
<div id="onBlockPlanChanged" class="code">
|
|
<p>
|
|
Executed whenever a plan of an entity is changed in the sector.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">allBlocksChanged</span>
|
|
A boolean that indicates whether all the blocks in the block plan have potentially changed <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onBlocksAdded" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onBlocksAdded(objectIndex, wasRepaired, blockIndices) <br/>
|
|
</p>
|
|
<div id="onBlocksAdded" class="code">
|
|
<p>
|
|
Executed whenever new blocks are added to the entity. This callback is executed after the block was added.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">wasRepaired</span>
|
|
true if the callback was fired because of a repair operation, false otherwise <br/>
|
|
<span class="parameter">blockIndices</span>
|
|
The indices of the added blocks, as variable arguments list <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onBlocksRemove" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onBlocksRemove(objectIndex, blockIndices) <br/>
|
|
</p>
|
|
<div id="onBlocksRemove" class="code">
|
|
<p>
|
|
Executed whenever a block will be removed from the plan by building (instead of combat). This callback is executed <strong>before</strong> the block is removed. <strong>IMPORTANT!</strong> This only fires on blocks that the player directly chose to be removed. Blocks that get removed because they don't have a connection to the root block any more get signalled after removal by 'onBlocksRemoved'.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">blockIndices</span>
|
|
The indices of the removed blocks, as variable arguments list <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onBlocksRemoved" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onBlocksRemoved(objectIndex, blockIndices) <br/>
|
|
</p>
|
|
<div id="onBlocksRemoved" class="code">
|
|
<p>
|
|
Executed whenever a block is removed from the plan by building (instead of combat). This callback is executed <strong>after</strong> the block is removed.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">blockIndices</span>
|
|
The indices of the removed blocks, as variable arguments list <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onBoardersDefeated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onBoardersDefeated(entityId, attackingFaction) <br/>
|
|
</p>
|
|
<div id="onBoardersDefeated" class="code">
|
|
<p>
|
|
Executed whenever all boarders were defeated
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">attackingFaction</span>
|
|
The index of the attacking faction <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onBoardersLand" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onBoardersLand(entityId, attackingFaction, firstLanding) <br/>
|
|
</p>
|
|
<div id="onBoardersLand" class="code">
|
|
<p>
|
|
Executed when boarders land on an entity
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">attackingFaction</span>
|
|
The index of the attacking faction <br/>
|
|
<span class="parameter">firstLanding</span>
|
|
True if these are the first boarders, false otherwise <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onBoardingFight" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onBoardingFight(entityId, attackingFaction) <br/>
|
|
</p>
|
|
<div id="onBoardingFight" class="code">
|
|
<p>
|
|
Executed on every round of fighting with boarders
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">attackingFaction</span>
|
|
The index of the attacking faction <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onBoardingSuccessful" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onBoardingSuccessful(entityId, oldFactionIndex, newFactionIndex) <br/>
|
|
</p>
|
|
<div id="onBoardingSuccessful" class="code">
|
|
<p>
|
|
Executed whenever an entity was boarded successfully
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">oldFactionIndex</span>
|
|
The index of the faction that owned the entity before boarding <br/>
|
|
<span class="parameter">newFactionIndex</span>
|
|
The index of the attacking faction that now owns the entity <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onCargoChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onCargoChanged(objectIndex, delta, good) <br/>
|
|
</p>
|
|
<div id="onCargoChanged" class="code">
|
|
<p>
|
|
Executed whenever the cargo of an entity in the sector changes. This callback is executed *after* the cargo was changed on the entity.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">delta</span>
|
|
The amount of cargo that changed <br/>
|
|
<span class="parameter">good</span>
|
|
The good that changed <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onCargoLootCollected" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onCargoLootCollected(collector, lootIndex, amount, good, owner) <br/>
|
|
</p>
|
|
<div id="onCargoLootCollected" class="code">
|
|
<p>
|
|
Executed whenever trading good loot gets collected by a player
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">collector</span>
|
|
The id of the entity that collected loot <br/>
|
|
<span class="parameter">lootIndex</span>
|
|
The index of the collected loot <br/>
|
|
<span class="parameter">amount</span>
|
|
The amount of goods that were collected <br/>
|
|
<span class="parameter">good</span>
|
|
The good that was inside the loot entity <br/>
|
|
<span class="parameter">owner</span>
|
|
The original owner of the cargo <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onCollision" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onCollision(objectIndexA, objectIndexB, damageA, damageB, steererA, steererB) <br/>
|
|
</p>
|
|
<div id="onCollision" class="code">
|
|
<p>
|
|
Executed whenever two block objects collided in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndexA</span>
|
|
The index of the one colliding object <br/>
|
|
<span class="parameter">objectIndexB</span>
|
|
The index of the other colliding object <br/>
|
|
<span class="parameter">damageA</span>
|
|
The damage that is inflicted to object A <br/>
|
|
<span class="parameter">damageB</span>
|
|
The damage that is inflicted to object B <br/>
|
|
<span class="parameter">steererA</span>
|
|
The steerer ID of objectA. When an object is docked, not the object itself but the steerer is the one responsible for collisions <br/>
|
|
<span class="parameter">steererB</span>
|
|
The steerer ID of objectB. When an object is docked, not the object itself but the steerer is the one responsible for collisions <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onCraftSeatEntered" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onCraftSeatEntered(entityId, seat, playerIndex, firstPlayer) <br/>
|
|
</p>
|
|
<div id="onCraftSeatEntered" class="code">
|
|
<p>
|
|
Executed whenever a player enters a craft
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">seat</span>
|
|
The seat index <br/>
|
|
<span class="parameter">playerIndex</span>
|
|
The index of the player that entered the seat <br/>
|
|
<span class="parameter">firstPlayer</span>
|
|
A bool indicating whether the craft's seats were empty before <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onCraftSeatLeft" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onCraftSeatLeft(entityId, seat, playerIndex, playersRemaining) <br/>
|
|
</p>
|
|
<div id="onCraftSeatLeft" class="code">
|
|
<p>
|
|
Executed whenever a player leaves a craft
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">seat</span>
|
|
The seat index that was previously occupied <br/>
|
|
<span class="parameter">playerIndex</span>
|
|
The index of the player that left the seat <br/>
|
|
<span class="parameter">playersRemaining</span>
|
|
A bool indicating whether there are still players on the craft <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onCrewChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onCrewChanged(index) <br/>
|
|
</p>
|
|
<div id="onCrewChanged" class="code">
|
|
<p>
|
|
Executed whenever the crew of a entity in the sector changes. This callback is executed *after* the crew was changed on the entity.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">index</span>
|
|
The id of the entity <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onCrewChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onCrewChanged(index, delta, profession) <br/>
|
|
</p>
|
|
<div id="onCrewChanged" class="code">
|
|
<p>
|
|
Executed whenever the crew of an entity in the sector changes. This callback is executed *after* the crew was changed on the entity.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">index</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">delta</span>
|
|
The amount of crewmen that changed <br/>
|
|
<span class="parameter">profession</span>
|
|
The profession of the crew that changed <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onCrewLootCollected" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onCrewLootCollected(collector, lootIndex) <br/>
|
|
</p>
|
|
<div id="onCrewLootCollected" class="code">
|
|
<p>
|
|
Executed whenever trading good loot gets collected by a player
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">collector</span>
|
|
The id of the entity that collected loot <br/>
|
|
<span class="parameter">lootIndex</span>
|
|
The index of the collected loot <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onDamaged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onDamaged(objectIndex, amount, inflictor, damageSource, damageType) <br/>
|
|
</p>
|
|
<div id="onDamaged" class="code">
|
|
<p>
|
|
Executed whenever an entity is damaged in the sector.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The index of the damaged object <br/>
|
|
<span class="parameter">amount</span>
|
|
The amount of damage that was dealt <br/>
|
|
<span class="parameter">inflictor</span>
|
|
The id of the entity that dealt the damage <br/>
|
|
<span class="parameter">damageSource</span>
|
|
The source of damage <br/>
|
|
<span class="parameter">damageType</span>
|
|
The type of damage <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onDestroyed" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onDestroyed(index, lastDamageInflictor) <br/>
|
|
</p>
|
|
<div id="onDestroyed" class="code">
|
|
<p>
|
|
Executed whenever an entity with durability was destroyed in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">index</span>
|
|
The id of the entity that was destroyed <br/>
|
|
<span class="parameter">lastDamageInflictor</span>
|
|
The index of the last entity that inflicted damage to the destroyed entity <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onDockedByEntity" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onDockedByEntity(dockeeId, dockerId) <br/>
|
|
</p>
|
|
<div id="onDockedByEntity" class="code">
|
|
<p>
|
|
Executed whenever an entity was docked to another entity
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">dockeeId</span>
|
|
The id of the entity that was docked (child) <br/>
|
|
<span class="parameter">dockerId</span>
|
|
The id of the docking entity (parent) <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onEntityCreated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onEntityCreated(entityId) <br/>
|
|
</p>
|
|
<div id="onEntityCreated" class="code">
|
|
<p>
|
|
Executed whenever a new entity is created in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The index of the new entity <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onEntityDocked" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onEntityDocked(dockerId, dockeeId) <br/>
|
|
</p>
|
|
<div id="onEntityDocked" class="code">
|
|
<p>
|
|
Executed whenever an entity docks to another entity
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">dockerId</span>
|
|
The id of the docking entity (parent) <br/>
|
|
<span class="parameter">dockeeId</span>
|
|
The id of the entity that was docked (child) <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onEntityEntered" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onEntityEntered(shipIndex) <br/>
|
|
</p>
|
|
<div id="onEntityEntered" class="code">
|
|
<p>
|
|
Executed whenever a entity enters the sector.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">shipIndex</span>
|
|
The index of the entity that entered the sector <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onEntityJump" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onEntityJump(shipId, x, y, sectorChangeType) <br/>
|
|
</p>
|
|
<div id="onEntityJump" class="code">
|
|
<p>
|
|
Executed whenever a entity jumps into another sector.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">shipId</span>
|
|
The id of the entity that will jump out of the sector <br/>
|
|
<span class="parameter">x</span>
|
|
The x coordinate of the target sector <br/>
|
|
<span class="parameter">y</span>
|
|
The y coordinate of the target sector <br/>
|
|
<span class="parameter">sectorChangeType</span>
|
|
SectorChangeType enum what kind of sector change it is <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onEntityRemoved" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onEntityRemoved(entityId) <br/>
|
|
</p>
|
|
<div id="onEntityRemoved" class="code">
|
|
<p>
|
|
Executed whenever an entity was removed from the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The index of the entity that was removed <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onEntityUndocked" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onEntityUndocked(dockerId, dockeeId) <br/>
|
|
</p>
|
|
<div id="onEntityUndocked" class="code">
|
|
<p>
|
|
Executed whenever an entity undocks from another entity
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">dockerId</span>
|
|
The id of the docking entity (parent) <br/>
|
|
<span class="parameter">dockeeId</span>
|
|
The id of the entity that was docked (child) <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onFighterAdded" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onFighterAdded(entityId, squadIndex, fighterIndex, landed) <br/>
|
|
</p>
|
|
<div id="onFighterAdded" class="code">
|
|
<p>
|
|
Executed whenever a fighter is added to an entity in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">squadIndex</span>
|
|
The index of the squad <br/>
|
|
<span class="parameter">fighterIndex</span>
|
|
The index of the fighter in the squad <br/>
|
|
<span class="parameter">landed</span>
|
|
A boolean whether the fighter landed or got added otherwise <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onFighterLanded" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onFighterLanded(entityId, squadIndex, fighterId) <br/>
|
|
</p>
|
|
<div id="onFighterLanded" class="code">
|
|
<p>
|
|
Executed whenever a fighter lands in a hangar in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity the fighter landed on <br/>
|
|
<span class="parameter">squadIndex</span>
|
|
The index of the squad <br/>
|
|
<span class="parameter">fighterId</span>
|
|
The id of the fighter that landed <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onFighterRemove" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onFighterRemove(entityId, squadIndex, fighterIndex, started) <br/>
|
|
</p>
|
|
<div id="onFighterRemove" class="code">
|
|
<p>
|
|
Executed whenever a fighter is removed from an entity in the sector, before it gets removed
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">squadIndex</span>
|
|
The index of the squad <br/>
|
|
<span class="parameter">fighterIndex</span>
|
|
The index of the fighter in the squad <br/>
|
|
<span class="parameter">started</span>
|
|
A boolean whether the fighter started or got removed otherwise <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onFighterRemoved" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onFighterRemoved(entityId, squadIndex, fighterIndex, started) <br/>
|
|
</p>
|
|
<div id="onFighterRemoved" class="code">
|
|
<p>
|
|
Executed whenever a fighter is removed from an entity in the sector, after it got removed
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">squadIndex</span>
|
|
The index of the squad <br/>
|
|
<span class="parameter">fighterIndex</span>
|
|
The index of the fighter in the squad <br/>
|
|
<span class="parameter">started</span>
|
|
A boolean whether the fighter started or got removed otherwise <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onFighterStarted" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onFighterStarted(entityId, squadIndex, fighterId) <br/>
|
|
</p>
|
|
<div id="onFighterStarted" class="code">
|
|
<p>
|
|
Executed whenever a fighter starts from a hangar in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity the fighter started from <br/>
|
|
<span class="parameter">squadIndex</span>
|
|
The index of the squad <br/>
|
|
<span class="parameter">fighterId</span>
|
|
The id of the fighter that started <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onHealed" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onHealed(objectIndex, amount, inflictor) <br/>
|
|
</p>
|
|
<div id="onHealed" class="code">
|
|
<p>
|
|
Executed whenever an entity is healed in the sector.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The index of the damaged entity <br/>
|
|
<span class="parameter">amount</span>
|
|
The amount of damage that was healed <br/>
|
|
<span class="parameter">inflictor</span>
|
|
The id of the entity that dealt the damage <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onHullHit" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onHullHit(objectIndex, blockIndex, shooterIndex, damage, location) <br/>
|
|
</p>
|
|
<div id="onHullHit" class="code">
|
|
<p>
|
|
Executed whenever a block object is hit by a shot in the sector. Don't delete the block that is hit by the shot, this will lead to a crash.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The index of the object that got shot at <br/>
|
|
<span class="parameter">blockIndex</span>
|
|
The index of the block that was hit by the shot <br/>
|
|
<span class="parameter">shooterIndex</span>
|
|
The index of the craft that fired the shot <br/>
|
|
<span class="parameter">damage</span>
|
|
The damage the shot dealt to the object <br/>
|
|
<span class="parameter">location</span>
|
|
The impact location <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onInventoryItemLootCollected" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onInventoryItemLootCollected(collector, lootIndex) <br/>
|
|
</p>
|
|
<div id="onInventoryItemLootCollected" class="code">
|
|
<p>
|
|
Executed whenever inventory item loot gets collected by an entity
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">collector</span>
|
|
The id of the entity which collected the loot <br/>
|
|
<span class="parameter">lootIndex</span>
|
|
The index of the loot that was collected <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onLootCollected" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onLootCollected(collector, lootIndex) <br/>
|
|
</p>
|
|
<div id="onLootCollected" class="code">
|
|
<p>
|
|
Executed whenever loot gets collected by anyone, be it player or AI faction
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">collector</span>
|
|
The id of the entity which collected the loot <br/>
|
|
<span class="parameter">lootIndex</span>
|
|
The index of the collected loot <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onMaterialLootCollected" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onMaterialLootCollected(collector, lootIndex, materialType, value) <br/>
|
|
</p>
|
|
<div id="onMaterialLootCollected" class="code">
|
|
<p>
|
|
Executed whenever material loot gets collected by an entity
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">collector</span>
|
|
The id of the entity which collected the loot <br/>
|
|
<span class="parameter">lootIndex</span>
|
|
The index of the loot that was collected <br/>
|
|
<span class="parameter">materialType</span>
|
|
The type of material contained in the loot <br/>
|
|
<span class="parameter">value</span>
|
|
The amount of material the loot contained <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onMoneyLootCollected" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onMoneyLootCollected(collector, lootIndex, value) <br/>
|
|
</p>
|
|
<div id="onMoneyLootCollected" class="code">
|
|
<p>
|
|
Executed whenever money loot gets collected by an entity
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">collector</span>
|
|
The id of the entity which collected the loot <br/>
|
|
<span class="parameter">lootIndex</span>
|
|
The index of the collected loot <br/>
|
|
<span class="parameter">value</span>
|
|
The amount of credits the loot contained <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onPlanModifiedByBuilding" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onPlanModifiedByBuilding(shipIndex) <br/>
|
|
</p>
|
|
<div id="onPlanModifiedByBuilding" class="code">
|
|
<p>
|
|
Executed whenever the plan of an entity was modified by building, meaning adding or removing blocks.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">shipIndex</span>
|
|
The index of the ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onPlayerEntered" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onPlayerEntered(playerIndex, sectorChangeType) <br/>
|
|
</p>
|
|
<div id="onPlayerEntered" class="code">
|
|
<p>
|
|
Executed whenever a player enters the sector. This callback is executed immediately before the contents of the sector are sent to the player
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">playerIndex</span>
|
|
Index of the player <br/>
|
|
<span class="parameter">sectorChangeType</span>
|
|
The kind of sector change that is happening <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onPlayerLeft" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onPlayerLeft(playerIndex, sectorChangeType) <br/>
|
|
</p>
|
|
<div id="onPlayerLeft" class="code">
|
|
<p>
|
|
Executed whenever a player leaves the sector. Executed after the player left.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">playerIndex</span>
|
|
Index of the player <br/>
|
|
<span class="parameter">sectorChangeType</span>
|
|
The kind of sector change that is happening <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onRestoredFromDisk" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onRestoredFromDisk(time) <br/>
|
|
</p>
|
|
<div id="onRestoredFromDisk" class="code">
|
|
<p>
|
|
Executed when a sector is loaded/restored from disk. This callback is called after the "restore" callback, for both entity and sector scripts.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">time</span>
|
|
The time since the sector has been last updated. This value can be 0 or too small after database corruptions. <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onScriptAdded" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onScriptAdded(entityId, scriptIndex, scriptPath) <br/>
|
|
</p>
|
|
<div id="onScriptAdded" class="code">
|
|
<p>
|
|
Executed after a script was added to an entity in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">scriptIndex</span>
|
|
The index of the new script <br/>
|
|
<span class="parameter">scriptPath</span>
|
|
The path of the new script <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onScriptRemoved" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onScriptRemoved(entityId, oldScriptIndex, scriptPath) <br/>
|
|
</p>
|
|
<div id="onScriptRemoved" class="code">
|
|
<p>
|
|
Executed after a script was removed from an entity in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">oldScriptIndex</span>
|
|
The old index of the script that was removed <br/>
|
|
<span class="parameter">scriptPath</span>
|
|
The path of the old script <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onScriptValueChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onScriptValueChanged(entityId, name, value) <br/>
|
|
</p>
|
|
<div id="onScriptValueChanged" class="code">
|
|
<p>
|
|
Executed whenever a script value of an entity in the sector was changed
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">name</span>
|
|
The name of the value <br/>
|
|
<span class="parameter">value</span>
|
|
The new value <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onSectorGenerated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onSectorGenerated(time) <br/>
|
|
</p>
|
|
<div id="onSectorGenerated" class="code">
|
|
<p>
|
|
Executed when a sector is generated/created for the first time for both entity and sector scripts.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">time</span>
|
|
The time the game has been running already. This value can be 0 or too small after database corruptions. <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onSetForDeletion" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onSetForDeletion(entityId, deletionType) <br/>
|
|
</p>
|
|
<div id="onSetForDeletion" class="code">
|
|
<p>
|
|
Executed whenever an entity is to be deleted.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The index of the entity that is to be deleted <br/>
|
|
<span class="parameter">deletionType</span>
|
|
The deletion type <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShieldActivate" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShieldActivate(entityId) <br/>
|
|
</p>
|
|
<div id="onShieldActivate" class="code">
|
|
<p>
|
|
Executed whenever a shield activates in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShieldDamaged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShieldDamaged(entityId, amount, damageType, inflictorId) <br/>
|
|
</p>
|
|
<div id="onShieldDamaged" class="code">
|
|
<p>
|
|
Executed whenever a shield is damaged in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">amount</span>
|
|
The amount of damage inflicted <br/>
|
|
<span class="parameter">damageType</span>
|
|
The type of damage dealt <br/>
|
|
<span class="parameter">inflictorId</span>
|
|
The id of the entity that inflicted the damage <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShieldDeactivate" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShieldDeactivate(entityId) <br/>
|
|
</p>
|
|
<div id="onShieldDeactivate" class="code">
|
|
<p>
|
|
Executed whenever a shield deactivates in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShieldHealed" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShieldHealed(entityId, amount) <br/>
|
|
</p>
|
|
<div id="onShieldHealed" class="code">
|
|
<p>
|
|
Executed whenever a shield is healed in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">amount</span>
|
|
The amount of damage healed <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShieldHit" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShieldHit(objectIndex, shooterIndex, damage, location) <br/>
|
|
</p>
|
|
<div id="onShieldHit" class="code">
|
|
<p>
|
|
Executed whenever an object's shield is hit by a shot in the sector.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The index of the object that got shot at <br/>
|
|
<span class="parameter">shooterIndex</span>
|
|
The index of the craft that fired the shot <br/>
|
|
<span class="parameter">damage</span>
|
|
The damage the shot dealt to the object <br/>
|
|
<span class="parameter">location</span>
|
|
The impact location <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShotCreated" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShotCreated(shotIndex) <br/>
|
|
</p>
|
|
<div id="onShotCreated" class="code">
|
|
<p>
|
|
Executed whenever a new shot is created in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">shotIndex</span>
|
|
The index of the new shot <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShotFired" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShotFired(entityId) <br/>
|
|
</p>
|
|
<div id="onShotFired" class="code">
|
|
<p>
|
|
Executed whenever a shot is fired in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The index of the firing entity (weapon) <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onShotHit" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onShotHit(objectIndex, shooterIndex, location) <br/>
|
|
</p>
|
|
<div id="onShotHit" class="code">
|
|
<p>
|
|
Executed whenever a block object is hit by a shot in the sector.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The index of the object that got shot at <br/>
|
|
<span class="parameter">shooterIndex</span>
|
|
The index of the craft that fired the shot <br/>
|
|
<span class="parameter">location</span>
|
|
The impact location <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onSquadAdded" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onSquadAdded(entityId, index) <br/>
|
|
</p>
|
|
<div id="onSquadAdded" class="code">
|
|
<p>
|
|
Executed whenever a squad is added to an entity in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">index</span>
|
|
The index of the squad <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onSquadOrdersChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onSquadOrdersChanged(entityId, squadIndex, orders, targetId) <br/>
|
|
</p>
|
|
<div id="onSquadOrdersChanged" class="code">
|
|
<p>
|
|
Executed whenever the orders of a squad change in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">squadIndex</span>
|
|
The index of the squad <br/>
|
|
<span class="parameter">orders</span>
|
|
The orders of the squad <br/>
|
|
<span class="parameter">targetId</span>
|
|
The target assigned to the fighters <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onSquadRemove" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onSquadRemove(entityId, index) <br/>
|
|
</p>
|
|
<div id="onSquadRemove" class="code">
|
|
<p>
|
|
Executed whenever a squad is removed from an entity in the sector, before the squad gets removed
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">index</span>
|
|
The index of the squad <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onSquadRemoved" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onSquadRemoved(entityId, index) <br/>
|
|
</p>
|
|
<div id="onSquadRemoved" class="code">
|
|
<p>
|
|
Executed whenever a squad is removed from an entity in the sector, after the squad got removed
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">index</span>
|
|
The index of the squad <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onStartFiring" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onStartFiring(entityId) <br/>
|
|
</p>
|
|
<div id="onStartFiring" class="code">
|
|
<p>
|
|
Executed whenever an entity starts firing in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The index of the firing entity (weapon) <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onStopFiring" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onStopFiring(entityId) <br/>
|
|
</p>
|
|
<div id="onStopFiring" class="code">
|
|
<p>
|
|
Executed whenever an entity stops firing in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The index of the firing entity (weapon) <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onSystemsChanged" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onSystemsChanged(shipIndex) <br/>
|
|
</p>
|
|
<div id="onSystemsChanged" class="code">
|
|
<p>
|
|
Executed whenever the systems of a ship in the sector changed. This callback is executed *after* the system was changed on the entity.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">shipIndex</span>
|
|
The index of the ship <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onSystemUpgradeLootCollected" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onSystemUpgradeLootCollected(collector, lootIndex) <br/>
|
|
</p>
|
|
<div id="onSystemUpgradeLootCollected" class="code">
|
|
<p>
|
|
Executed whenever system upgrade loot gets collected by an entity
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">collector</span>
|
|
The id of the entity which collected the loot <br/>
|
|
<span class="parameter">lootIndex</span>
|
|
The index of the loot that was collected <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onTorpedoHit" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onTorpedoHit(objectIndex, shooterIndex, torpedoIndex) <br/>
|
|
</p>
|
|
<div id="onTorpedoHit" class="code">
|
|
<p>
|
|
Executed whenever a block object is hit by a torpedo in the sector.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The index of the object that got shot at <br/>
|
|
<span class="parameter">shooterIndex</span>
|
|
The index of the craft that fired the torpedo <br/>
|
|
<span class="parameter">torpedoIndex</span>
|
|
The index of the torpedo that hit the object <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onTorpedoHullHit" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onTorpedoHullHit(objectIndex, blockIndex, shooterIndex, damage, torpedoIndex) <br/>
|
|
</p>
|
|
<div id="onTorpedoHullHit" class="code">
|
|
<p>
|
|
Executed whenever a block object is hit by a torpedo in the sector. Don't delete the block that is hit by the torpedo, this will lead to a crash.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The index of the object that got shot at <br/>
|
|
<span class="parameter">blockIndex</span>
|
|
The index of the block that was hit by the torpedo <br/>
|
|
<span class="parameter">shooterIndex</span>
|
|
The index of the craft that fired the torpedo <br/>
|
|
<span class="parameter">damage</span>
|
|
The damage the torpedo dealt to the object <br/>
|
|
<span class="parameter">torpedoIndex</span>
|
|
The index of the torpedo that hit the object <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onTorpedoLaunched" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onTorpedoLaunched(entityId, torpedoId) <br/>
|
|
</p>
|
|
<div id="onTorpedoLaunched" class="code">
|
|
<p>
|
|
Executed whenever a torpedo was launched from an entity
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">entityId</span>
|
|
The id of the entity <br/>
|
|
<span class="parameter">torpedoId</span>
|
|
The id of the launched torpedo <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onTorpedoShieldHit" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onTorpedoShieldHit(objectIndex, shooterIndex, damage, torpedoIndex) <br/>
|
|
</p>
|
|
<div id="onTorpedoShieldHit" class="code">
|
|
<p>
|
|
Executed whenever an object's shield is hit by a torpedo in the sector.
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">objectIndex</span>
|
|
The index of the object that got shot at <br/>
|
|
<span class="parameter">shooterIndex</span>
|
|
The index of the craft that fired the torpedo <br/>
|
|
<span class="parameter">damage</span>
|
|
The damage the torpedo dealt to the object <br/>
|
|
<span class="parameter">torpedoIndex</span>
|
|
The index of the torpedo that hit the object <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onTurretAdded" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onTurretAdded(shipIndex, turretIndex) <br/>
|
|
</p>
|
|
<div id="onTurretAdded" class="code">
|
|
<p>
|
|
Executed whenever a turret was added to a ship in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">shipIndex</span>
|
|
The id of the entity that turret was attached to <br/>
|
|
<span class="parameter">turretIndex</span>
|
|
The index of the turret <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onTurretDestroyed" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onTurretDestroyed(turretIndex, shipIndex, lastDamageInflictor) <br/>
|
|
</p>
|
|
<div id="onTurretDestroyed" class="code">
|
|
<p>
|
|
Executed whenever a turret was destroyed in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">turretIndex</span>
|
|
The index of the turret that was destroyed <br/>
|
|
<span class="parameter">shipIndex</span>
|
|
The id of the entity that turret was attached to <br/>
|
|
<span class="parameter">lastDamageInflictor</span>
|
|
The index of the last entity that inflicted damage to the destroyed entity <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onTurretLootCollected" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onTurretLootCollected(collector, lootIndex) <br/>
|
|
</p>
|
|
<div id="onTurretLootCollected" class="code">
|
|
<p>
|
|
Executed whenever turret loot gets collected by an entity controlled by AI
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">collector</span>
|
|
The id of the entity which collected the loot <br/>
|
|
<span class="parameter">lootIndex</span>
|
|
The index of the collected loot <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onTurretRemoved" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onTurretRemoved(shipIndex, turretIndex) <br/>
|
|
</p>
|
|
<div id="onTurretRemoved" class="code">
|
|
<p>
|
|
Executed whenever a turret was removed in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">shipIndex</span>
|
|
The id of the entity that turret was attached to <br/>
|
|
<span class="parameter">turretIndex</span>
|
|
The index of the turret <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onTurretRemovedByPlayer" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onTurretRemovedByPlayer(shipIndex, turretIndex) <br/>
|
|
</p>
|
|
<div id="onTurretRemovedByPlayer" class="code">
|
|
<p>
|
|
Executed whenever a turret was removed from a ship by the player in the sector
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">shipIndex</span>
|
|
The id of the entity that turret was attached to <br/>
|
|
<span class="parameter">turretIndex</span>
|
|
The index of the turret <br/>
|
|
</div>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="onUndockedFromEntity" class="codecontainer">
|
|
<p>
|
|
<span class="keyword">callback</span> onUndockedFromEntity(dockeeId, dockerId) <br/>
|
|
</p>
|
|
<div id="onUndockedFromEntity" class="code">
|
|
<p>
|
|
Executed whenever an entity was undocked from another entity
|
|
</p>
|
|
<p><span class="parameter">Parameters</span></p>
|
|
<div class="indented">
|
|
<span class="parameter">dockeeId</span>
|
|
The id of the entity that was docked (child) <br/>
|
|
<span class="parameter">dockerId</span>
|
|
The id of the docking entity (parent) <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>
|