Files

899 lines
36 KiB
HTML

<html>
<head>
<title> Hud</title>
<link rel="stylesheet" href="stylesheet.css"/>
<meta charset="utf-8"/>
</head>
<body>
<div class="maincentered">
<div class="maincontent">
<h1 class="documentationheader">Avorion Script API Documentation</h1>
<div class="sitemap">
<div class="headerlisting flexheader">
<div>
<a href="index.html">Home</a>
<a href="Functions.html">Functions</a>
<a href="Search.html">Search</a>
</div>
<div class="flexheaderwhitespace"></div>
<form action="Search.html" method="get">Search:<input name="search" class="headersearchinput" type="search"></form></div></div>
<div class="floatleft">
<div class="codecontainer">
<table>
<tr>
<td>
<a class="type" href="Hud.html">Hud</a>
<a class="function" href="#Hud">Hud</a>
</td>
</tr>
<tr><td><br/></td></tr>
<tr><td><span class="docheader">Properties</span></td></tr>
<tr><td>
<a href="#buildingUIVisible">buildingUIVisible</a>
</td></tr>
<tr><td>
<a href="#mailWindowVisible">mailWindowVisible</a>
</td></tr>
<tr><td>
<a href="#mouseOverSecondaryWindow">mouseOverSecondaryWindow</a>
</td></tr>
<tr><td>
<a href="#notificationsVisible">notificationsVisible</a>
</td></tr>
<tr><td>
<a href="#playerTradeWindowVisible">playerTradeWindowVisible</a>
</td></tr>
<tr><td>
<a href="#playerWindowVisible">playerWindowVisible</a>
</td></tr>
<tr><td>
<a href="#resourcesVisible">resourcesVisible</a>
</td></tr>
<tr><td>
<a href="#shieldBarSaturation">shieldBarSaturation</a>
</td></tr>
<tr><td>
<a href="#shipWindowVisible">shipWindowVisible</a>
</td></tr>
<tr><td>
<a href="#tutorialActive">tutorialActive</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#center">center</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#height">height</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#index">index</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#layer">layer</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#localCenter">localCenter</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#localPosition">localPosition</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#localRect">localRect</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#lower">lower</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#mouseOver">mouseOver</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#position">position</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#rect">rect</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#size">size</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#tooltip">tooltip</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#tooltipWidth">tooltipWidth</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#upper">upper</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#visible">visible</a>
</td></tr>
<tr><td>
<a class="inheritedproperty" href="#width">width</a>
</td></tr>
<tr><td><br/></td></tr>
<tr><td><span class="docheader">Member Functions</span></td></tr>
<tr><td>
<a class="code" href="#addMouseShowingWindow">addMouseShowingWindow</a>
</td></tr>
<tr><td>
<a class="code" href="#createContainer">createContainer</a>
</td></tr>
<tr><td>
<a class="code" href="#createWindow">createWindow</a>
</td></tr>
<tr><td>
<a class="code" href="#displayHint">displayHint</a>
</td></tr>
<tr><td>
<a class="code" href="#displayNotification">displayNotification</a>
</td></tr>
<tr><td>
<a class="code" href="#highlightScriptButton">highlightScriptButton</a>
</td></tr>
<tr><td>
<a class="code" href="#setCursor">setCursor</a>
</td></tr>
<tr>
<td>
<a class="inheritedcode" href="#hide">hide</a>
</td>
</tr>
<tr>
<td>
<a class="inheritedcode" href="#isMouseOverAndUnobscured">isMouseOverAndUnobscured</a>
</td>
</tr>
<tr>
<td>
<a class="inheritedcode" href="#show">show</a>
</td>
</tr>
</table>
</div>
</div>
<div class="floatright">
<h1>Hud : <a href="UIElement.html">UIElement</a></h1>
<p>
<span class="warning">This object is only available on the client.</span>
</p>
<div id="Hud" class="codecontainer">
<div id="Hud" class="function">
<p>
<span class="keyword">function </span> Hud() <br/>
</p>
</div>
<div id="Hud" class="">
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
A new instance of Hud
</p>
</div>
</p>
</div>
</div>
<div id="Properties" class="codecontainer">
<div id="buildingUIVisible">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">buildingUIVisible</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="mailWindowVisible">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">mailWindowVisible</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="mouseOverSecondaryWindow">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">mouseOverSecondaryWindow</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="notificationsVisible">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">notificationsVisible</span></td><td align="right"></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="playerTradeWindowVisible">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">playerTradeWindowVisible</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="playerWindowVisible">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">playerWindowVisible</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="resourcesVisible">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">resourcesVisible</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="shieldBarSaturation">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">float </span> <span class="property">shieldBarSaturation</span></td><td align="right"><span><b>[write-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="shipWindowVisible">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">shipWindowVisible</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="tutorialActive">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">tutorialActive</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="center">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">vec2 </span> <span class="property">center</span></td><td align="right"></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="height">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">float </span> <span class="property">height</span></td><td align="right"></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="index">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">int </span> <span class="property">index</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="layer">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">int </span> <span class="property">layer</span></td><td align="right"></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="localCenter">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">vec2 </span> <span class="property">localCenter</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="localPosition">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">vec2 </span> <span class="property">localPosition</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="localRect">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">Rect </span> <span class="property">localRect</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="lower">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">vec2 </span> <span class="property">lower</span></td><td align="right"></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="mouseOver">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">mouseOver</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="position">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">vec2 </span> <span class="property">position</span></td><td align="right"></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="rect">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">Rect </span> <span class="property">rect</span></td><td align="right"></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="size">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">vec2 </span> <span class="property">size</span></td><td align="right"></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="tooltip">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">var </span> <span class="property">tooltip</span></td><td align="right"></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="tooltipWidth">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">int </span> <span class="property">tooltipWidth</span></td><td align="right"><span><b>[write-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="upper">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">vec2 </span> <span class="property">upper</span></td><td align="right"></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="visible">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">visible</span></td><td align="right"></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="width">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">float </span> <span class="property">width</span></td><td align="right"></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
</div>
<div id="addMouseShowingWindow" class="codecontainer">
<div id="addMouseShowingWindow" class="function">
<p>
<span class="keyword">function var</span> addMouseShowingWindow(<span class="type">Window</span> <span class="parameter">window</span>) <br/>
</p>
</div>
<div id="addMouseShowingWindow" class="">
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="createContainer" class="codecontainer">
<div id="createContainer" class="function">
<p>
<span class="keyword">function UIContainer</span> createContainer(<span class="type">Rect</span> <span class="parameter">rect</span>) <br/>
</p>
</div>
<div id="createContainer" class="">
</p>
</div>
</div>
<div id="createWindow" class="codecontainer">
<div id="createWindow" class="function">
<p>
<span class="keyword">function Window</span> createWindow(<span class="type">Rect</span> <span class="parameter">rect</span>) <br/>
</p>
</div>
<div id="createWindow" class="">
</p>
</div>
</div>
<div id="displayHint" class="codecontainer">
<div id="displayHint" class="function">
<p>
<span class="keyword">function var</span> displayHint(<span class="type">string</span> <span class="parameter">text</span>, <span class="type">var...</span> <span class="parameter">highlights</span>) <br/>
</p>
</div>
<div id="displayHint" class="">
<p>
Displays a prioritized hint with the given text. The hint won't have a 'Don't show again' field, and it will override all other hints while its active. Hint will be removed when no more objects can be highlighted (which will only happen in case of passing ids of entities that then are deleted or destroyed), or when it's overridden by another call to 'displayHint', or when the player clicks on the 'X', or when the script that did the call was deleted.
</p>
<p><span class="docheader">Parameters</span></p>
<div class="indented">
<span class="parameter">text</span>
Text that will be shown in the hint. Passing "" will disable the hint. <br/>
<span class="parameter">highlights</span>
Objects that should be highlighted. Can be any number of vec3, Rect, ids (string, Uuid) or Entity. Passing 0 objects will disable the hint. <br/>
</div>
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="displayNotification" class="codecontainer">
<div id="displayNotification" class="function">
<p>
<span class="keyword">function var</span> displayNotification(<span class="type">string</span> <span class="parameter">text</span>, <span class="type">Color</span> <span class="parameter">textColor</span>, <span class="type">string</span> <span class="parameter">icon</span>, <span class="type">Color [or nil]</span> <span class="parameter">iconColor</span>, <span class="type">var</span> <span class="parameter">alliance</span>, <span class="type">var</span> <span class="parameter">size</span>, <span class="type">var</span> <span class="parameter">iconPadding</span>) <br/>
</p>
</div>
<div id="displayNotification" class="">
<p>
Displays a notification on the right hand side, similar to warnings or error messages.
</p>
<p><span class="docheader">Parameters</span></p>
<div class="indented">
<span class="parameter">text</span>
The text of the notifiction <br/>
<span class="parameter">textColor</span>
Color of the text <br/>
<span class="parameter">icon</span>
Path to the icon that should be shown <br/>
<span class="parameter">iconColor</span>
Color of the icon <br/>
<span class="parameter">alliance</span>
If the notification is meant for the alliance (will show a small alliance banner next to the icon) <br/>
<span class="parameter">size</span>
Height of the notification in pixels <br/>
<span class="parameter">iconPadding</span>
Padding around the icon image (in percent from 0 to 1) <br/>
</div>
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="highlightScriptButton" class="codecontainer">
<div id="highlightScriptButton" class="function">
<p>
<span class="keyword">function var</span> highlightScriptButton(<span class="type">string</span> <span class="parameter">script</span>) <br/>
</p>
</div>
<div id="highlightScriptButton" class="">
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="setCursor" class="codecontainer">
<div id="setCursor" class="function">
<p>
<span class="keyword">function var</span> setCursor(<span class="type">var</span> <span class="parameter">icon</span>, <span class="type">var</span> <span class="parameter">x</span>, <span class="type">var</span> <span class="parameter">y</span>) <br/>
</p>
</div>
<div id="setCursor" class="">
<p>
Changes the cursor to another cursor. You should be very careful using this function and make sure that the cursor is always returned to what it was before once you don't need a special one any more. Passing nil as icon path will reset the cursor to default.
</p>
<p><span class="docheader">Parameters</span></p>
<div class="indented">
<span class="parameter">icon</span>
path to the icon that should be used as the cursor <br/>
<span class="parameter">x</span>
X coordinate in pixels of the center of the cursor in the icon <br/>
<span class="parameter">y</span>
Y coordinate in pixels of the center of the cursor in the icon <br/>
</div>
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="hide" class="codecontainer">
<div id="hide" class="function">
<p>
<span class="keyword">function var</span> hide() <br/>
</p>
</div>
<div id="hide" class="">
<p>
<span class="inheritedcode">Inherited from <a href="UIElement.html">UIElement</a></span>
</p>
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="isMouseOverAndUnobscured" class="codecontainer">
<div id="isMouseOverAndUnobscured" class="function">
<p>
<span class="keyword">function bool</span> isMouseOverAndUnobscured() <br/>
</p>
</div>
<div id="isMouseOverAndUnobscured" class="">
<p>
<span class="inheritedcode">Inherited from <a href="UIElement.html">UIElement</a></span>
</p>
</p>
</div>
</div>
<div id="show" class="codecontainer">
<div id="show" class="function">
<p>
<span class="keyword">function var</span> show() <br/>
</p>
</div>
<div id="show" class="">
<p>
<span class="inheritedcode">Inherited from <a href="UIElement.html">UIElement</a></span>
</p>
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</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 &copy; 2025 Boxelware GmbH. All rights reserved.</p>
</div>
</div>
</body>
</html>