dave/avorion-docgen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
avorion-docgen/Documentation/Plan.html

1175 lines
42 KiB
HTML
Raw Permalink Blame History

<html>
<head>
<title> Plan</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="Plan.html">Plan</a>
<a class="function" href="#Plan">Plan</a>
</td>
</tr>
<tr><td><br/></td></tr>
<tr><td><span class="docheader">Properties</span></td></tr>
<tr><td>
<a href="#accumulatingHealth">accumulatingHealth</a>
</td></tr>
<tr><td>
<a href="#boundingBox">boundingBox</a>
</td></tr>
<tr><td>
<a href="#boundingSphere">boundingSphere</a>
</td></tr>
<tr><td>
<a href="#centerOfMass">centerOfMass</a>
</td></tr>
<tr><td>
<a href="#collisionDamage">collisionDamage</a>
</td></tr>
<tr><td>
<a href="#convex">convex</a>
</td></tr>
<tr><td>
<a href="#durability">durability</a>
</td></tr>
<tr><td>
<a href="#entity">entity</a>
</td></tr>
<tr><td>
<a href="#entityId">entityId</a>
</td></tr>
<tr><td>
<a href="#mass">mass</a>
</td></tr>
<tr><td>
<a href="#numBlocks">numBlocks</a>
</td></tr>
<tr><td>
<a href="#processingPower">processingPower</a>
</td></tr>
<tr><td>
<a href="#radius">radius</a>
</td></tr>
<tr><td>
<a href="#root">root</a>
</td></tr>
<tr><td>
<a href="#rootIndex">rootIndex</a>
</td></tr>
<tr><td>
<a href="#singleBlockDestructionEnabled">singleBlockDestructionEnabled</a>
</td></tr>
<tr><td>
<a href="#size">size</a>
</td></tr>
<tr><td>
<a href="#volume">volume</a>
</td></tr>
<tr><td><br/></td></tr>
<tr><td><span class="docheader">Member Functions</span></td></tr>
<tr><td>
<a class="code" href="#addBlock">addBlock</a>
</td></tr>
<tr><td>
<a class="code" href="#addPlan">addPlan</a>
</td></tr>
<tr><td>
<a class="code" href="#addPlanDisplaced">addPlanDisplaced</a>
</td></tr>
<tr><td>
<a class="code" href="#damage">damage</a>
</td></tr>
<tr><td>
<a class="code" href="#deleteSubTree">deleteSubTree</a>
</td></tr>
<tr><td>
<a class="code" href="#destroy">destroy</a>
</td></tr>
<tr><td>
<a class="code" href="#empty">empty</a>
</td></tr>
<tr><td>
<a class="code" href="#exists">exists</a>
</td></tr>
<tr><td>
<a class="code" href="#get">get</a>
</td></tr>
<tr><td>
<a class="code" href="#getBlock">getBlock</a>
</td></tr>
<tr><td>
<a class="code" href="#getBlockIndices">getBlockIndices</a>
</td></tr>
<tr><td>
<a class="code" href="#getBlocksByType">getBlocksByType</a>
</td></tr>
<tr><td>
<a class="code" href="#getMoneyValue">getMoneyValue</a>
</td></tr>
<tr><td>
<a class="code" href="#getMove">getMove</a>
</td></tr>
<tr><td>
<a class="code" href="#getNthBlock">getNthBlock</a>
</td></tr>
<tr><td>
<a class="code" href="#getNthIndex">getNthIndex</a>
</td></tr>
<tr><td>
<a class="code" href="#getNumBlocks">getNumBlocks</a>
</td></tr>
<tr><td>
<a class="code" href="#getRemoved">getRemoved</a>
</td></tr>
<tr><td>
<a class="code" href="#getResourceValue">getResourceValue</a>
</td></tr>
<tr><td>
<a class="code" href="#getStats">getStats</a>
</td></tr>
<tr><td>
<a class="code" href="#getUndamagedMoneyValue">getUndamagedMoneyValue</a>
</td></tr>
<tr><td>
<a class="code" href="#getUndamagedResourceValue">getUndamagedResourceValue</a>
</td></tr>
<tr><td>
<a class="code" href="#heal">heal</a>
</td></tr>
<tr><td>
<a class="code" href="#move">move</a>
</td></tr>
<tr><td>
<a class="code" href="#removeBlock">removeBlock</a>
</td></tr>
<tr><td>
<a class="code" href="#set">set</a>
</td></tr>
<tr><td>
<a class="code" href="#setBlockColor">setBlockColor</a>
</td></tr>
<tr><td>
<a class="code" href="#setBlockDamageFactor">setBlockDamageFactor</a>
</td></tr>
<tr><td>
<a class="code" href="#setBlockType">setBlockType</a>
</td></tr>
<tr><td>
<a class="code" href="#setBlockTypeDamageFactor">setBlockTypeDamageFactor</a>
</td></tr>
<tr><td>
<a class="code" href="#setColor">setColor</a>
</td></tr>
<tr><td>
<a class="code" href="#setMaterial">setMaterial</a>
</td></tr>
<tr><td>
<a class="code" href="#setSecondaryBlockColor">setSecondaryBlockColor</a>
</td></tr>
</table>
</div>
</div>
<div class="floatright">
<h1>Plan</h1>
<div id="Plan" class="codecontainer">
<div id="Plan" class="function">
<p>
<span class="keyword">function </span> Plan(<span class="type">var</span> <span class="parameter">id</span>) <br/>
</p>
</div>
<div id="Plan" class="">
<p><span class="docheader">Parameters</span></p>
<div class="indented">
<span class="parameter">id</span>
The id of the entity this component belongs to, or the entity itself, must be an id of an existing entity or nil for the entity in the current script context <br/>
</div>
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
A new instance of Plan
</p>
</div>
</p>
</div>
</div>
<div id="Properties" class="codecontainer">
<div id="accumulatingHealth">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">accumulatingHealth</span></td><td align="right"></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="boundingBox">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">Box </span> <span class="property">boundingBox</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="boundingSphere">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">Sphere </span> <span class="property">boundingSphere</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="centerOfMass">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">vec3 </span> <span class="property">centerOfMass</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="collisionDamage">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">collisionDamage</span></td><td align="right"></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="convex">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">convex</span></td><td align="right"></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="durability">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">double </span> <span class="property">durability</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="entity">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">Entity </span> <span class="property">entity</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="entityId">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">uuid </span> <span class="property">entityId</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="mass">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">double </span> <span class="property">mass</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="numBlocks">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">int </span> <span class="property">numBlocks</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="processingPower">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">double </span> <span class="property">processingPower</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="radius">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">float </span> <span class="property">radius</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="root">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">BlockPlanBlock </span> <span class="property">root</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="rootIndex">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">var </span> <span class="property">rootIndex</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="singleBlockDestructionEnabled">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">bool </span> <span class="property">singleBlockDestructionEnabled</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">int </span> <span class="property">size</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
<div id="volume">
<table style="width:100%;"><tr>
<td><span class="keyword">property</span> <span class="type">float </span> <span class="property">volume</span></td><td align="right"><span><b>[read-only]</b></span></td></tr></table>
<div style="padding-left:20px; padding-bottom:10px">
</div>
</div>
</div>
<div id="addBlock" class="codecontainer">
<div id="addBlock" class="function">
<p>
<span class="keyword">function int</span> addBlock(<span class="type">vec3</span> <span class="parameter">position</span>, <span class="type">vec3</span> <span class="parameter">size</span>, <span class="type">int</span> <span class="parameter">parentIndex</span>, <span class="type">int</span> <span class="parameter">index</span>, <span class="type">Color</span> <span class="parameter">color</span>, <span class="type">Material</span> <span class="parameter">material</span>, <span class="type">Matrix</span> <span class="parameter">orientation</span>, <span class="type">int</span> <span class="parameter">blockIndex</span>, <span class="type">var</span> <span class="parameter">secondaryColor</span>) <br/>
</p>
</div>
<div id="addBlock" class="">
<p>
Add a new block to an existing plan.
</p>
<p><span class="docheader">Parameters</span></p>
<div class="indented">
<span class="parameter">position</span>
The position of the new <br/>
<span class="parameter">size</span>
The size of the new block <br/>
<span class="parameter">parentIndex</span>
The parent index of the block the new block will be attached to. This parameter will be ignored when there are no blocks in the plan. <br/>
<span class="parameter">index</span>
The index of the new block. Use -1 to assign an index automatically (recommended) <br/>
<span class="parameter">color</span>
The color of the new block <br/>
<span class="parameter">material</span>
The material of the new block <br/>
<span class="parameter">orientation</span>
The orientation of the new block <br/>
<span class="parameter">blockIndex</span>
The type of the new block, must be a valid block type. See enum BlockType <br/>
<span class="parameter">secondaryColor</span>
The secondaryColor of the new block. If nil, ColorNone() will be used <br/>
</div>
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
Returns the index of the new block on success, nil otherwise.
</p>
</div>
</p>
</div>
</div>
<div id="addPlan" class="codecontainer">
<div id="addPlan" class="function">
<p>
<span class="keyword">function int</span> addPlan(<span class="type">int</span> <span class="parameter">parentIndex</span>, <span class="type">BlockPlan</span> <span class="parameter">other</span>, <span class="type">int</span> <span class="parameter">otherBlock</span>) <br/>
</p>
</div>
<div id="addPlan" class="">
</p>
</div>
</div>
<div id="addPlanDisplaced" class="codecontainer">
<div id="addPlanDisplaced" class="function">
<p>
<span class="keyword">function int</span> addPlanDisplaced(<span class="type">int</span> <span class="parameter">parentIndex</span>, <span class="type">BlockPlan</span> <span class="parameter">other</span>, <span class="type">int</span> <span class="parameter">otherBlock</span>, <span class="type">vec3</span> <span class="parameter">delta</span>) <br/>
</p>
</div>
<div id="addPlanDisplaced" class="">
</p>
</div>
</div>
<div id="damage" class="codecontainer">
<div id="damage" class="function">
<p>
<span class="keyword">function var</span> damage(<span class="type">float</span> <span class="parameter">damage</span>, <span class="type">int</span> <span class="parameter">block</span>, <span class="type">vec3</span> <span class="parameter">location</span>, <span class="type">Uuid</span> <span class="parameter">inflictingEntity</span>, <span class="type">var</span> <span class="parameter">damageSource</span>, <span class="type">var</span> <span class="parameter">damageType</span>) <br/>
</p>
</div>
<div id="damage" class="">
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="deleteSubTree" class="codecontainer">
<div id="deleteSubTree" class="function">
<p>
<span class="keyword">function var</span> deleteSubTree(<span class="type">int</span> <span class="parameter">index</span>) <br/>
</p>
</div>
<div id="deleteSubTree" class="">
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="destroy" class="codecontainer">
<div id="destroy" class="function">
<p>
<span class="keyword">function var</span> destroy() <br/>
</p>
</div>
<div id="destroy" class="">
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="empty" class="codecontainer">
<div id="empty" class="function">
<p>
<span class="keyword">function bool</span> empty() <br/>
</p>
</div>
<div id="empty" class="">
</p>
</div>
</div>
<div id="exists" class="codecontainer">
<div id="exists" class="function">
<p>
<span class="keyword">function bool</span> exists(<span class="type">int</span> <span class="parameter">index</span>) <br/>
</p>
</div>
<div id="exists" class="">
</p>
</div>
</div>
<div id="get" class="codecontainer">
<div id="get" class="function">
<p>
<span class="keyword">function BlockPlan</span> get() <br/>
</p>
</div>
<div id="get" class="">
<p>
Returns the plan of the entity. This copies the entire plan, keep that in mind when using plans with large block counts.
</p>
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
A copy of the plan of the entity
</p>
</div>
</p>
</div>
</div>
<div id="getBlock" class="codecontainer">
<div id="getBlock" class="function">
<p>
<span class="keyword">function BlockPlanBlock</span> getBlock(<span class="type">int</span> <span class="parameter">index</span>) <br/>
</p>
</div>
<div id="getBlock" class="">
</p>
</div>
</div>
<div id="getBlockIndices" class="codecontainer">
<div id="getBlockIndices" class="function">
<p>
<span class="keyword">function int...</span> getBlockIndices() <br/>
</p>
</div>
<div id="getBlockIndices" class="">
</p>
</div>
</div>
<div id="getBlocksByType" class="codecontainer">
<div id="getBlocksByType" class="function">
<p>
<span class="keyword">function int...</span> getBlocksByType(<span class="type">int</span> <span class="parameter">index</span>) <br/>
</p>
</div>
<div id="getBlocksByType" class="">
</p>
</div>
</div>
<div id="getMoneyValue" class="codecontainer">
<div id="getMoneyValue" class="function">
<p>
<span class="keyword">function double</span> getMoneyValue() <br/>
</p>
</div>
<div id="getMoneyValue" class="">
</p>
</div>
</div>
<div id="getMove" class="codecontainer">
<div id="getMove" class="function">
<p>
<span class="keyword">function BlockPlan</span> getMove() <br/>
</p>
</div>
<div id="getMove" class="">
<p>
Returns the plan of the entity. This function will move the plan out of the entity, and replace the entity's plan with a single block. This operation is independent of the size of the plan, use it when you have to get large plans with lots of blocks.
</p>
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
The plan of the entity
</p>
</div>
</p>
</div>
</div>
<div id="getNthBlock" class="codecontainer">
<div id="getNthBlock" class="function">
<p>
<span class="keyword">function BlockPlanBlock</span> getNthBlock(<span class="type">int</span> <span class="parameter">n</span>) <br/>
</p>
</div>
<div id="getNthBlock" class="">
</p>
</div>
</div>
<div id="getNthIndex" class="codecontainer">
<div id="getNthIndex" class="function">
<p>
<span class="keyword">function var</span> getNthIndex(<span class="type">int</span> <span class="parameter">n</span>) <br/>
</p>
</div>
<div id="getNthIndex" class="">
</p>
</div>
</div>
<div id="getNumBlocks" class="codecontainer">
<div id="getNumBlocks" class="function">
<p>
<span class="keyword">function int</span> getNumBlocks(<span class="type">int</span> <span class="parameter">blockIndex</span>) <br/>
</p>
</div>
<div id="getNumBlocks" class="">
</p>
</div>
</div>
<div id="getRemoved" class="codecontainer">
<div id="getRemoved" class="function">
<p>
<span class="keyword">function int...</span> getRemoved(<span class="type">int</span> <span class="parameter">index</span>) <br/>
</p>
</div>
<div id="getRemoved" class="">
</p>
</div>
</div>
<div id="getResourceValue" class="codecontainer">
<div id="getResourceValue" class="function">
<p>
<span class="keyword">function double...</span> getResourceValue() <br/>
</p>
</div>
<div id="getResourceValue" class="">
</p>
</div>
</div>
<div id="getStats" class="codecontainer">
<div id="getStats" class="function">
<p>
<span class="keyword">function BlockStatistics</span> getStats() <br/>
</p>
</div>
<div id="getStats" class="">
</p>
</div>
</div>
<div id="getUndamagedMoneyValue" class="codecontainer">
<div id="getUndamagedMoneyValue" class="function">
<p>
<span class="keyword">function double</span> getUndamagedMoneyValue() <br/>
</p>
</div>
<div id="getUndamagedMoneyValue" class="">
</p>
</div>
</div>
<div id="getUndamagedResourceValue" class="codecontainer">
<div id="getUndamagedResourceValue" class="function">
<p>
<span class="keyword">function double...</span> getUndamagedResourceValue() <br/>
</p>
</div>
<div id="getUndamagedResourceValue" class="">
</p>
</div>
</div>
<div id="heal" class="codecontainer">
<div id="heal" class="function">
<p>
<span class="keyword">function var</span> heal(<span class="type">float</span> <span class="parameter">damage</span>, <span class="type">int</span> <span class="parameter">block</span>, <span class="type">vec3</span> <span class="parameter">location</span>, <span class="type">Uuid</span> <span class="parameter">inflictingEntity</span>) <br/>
</p>
</div>
<div id="heal" class="">
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="move" class="codecontainer">
<div id="move" class="function">
<p>
<span class="keyword">function var</span> move(<span class="type">BlockPlan</span> <span class="parameter">plan</span>) <br/>
</p>
</div>
<div id="move" class="">
<p>
Set the new plan of the entity. The entity will get deleted if the plan is empty. This moves all the data out of the plan that is used as the first argument. The content of the plan given as argument is then undefined, but still valid. It might be empty, it might contain the previous plan. This operation is independent of the size of the plan, use it when you have to set large plans with lots of blocks.
</p>
<p><span class="docheader">Parameters</span></p>
<div class="indented">
<span class="parameter">plan</span>
The new BlockPlan of the entity <br/>
</div>
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="removeBlock" class="codecontainer">
<div id="removeBlock" class="function">
<p>
<span class="keyword">function var</span> removeBlock(<span class="type">int</span> <span class="parameter">index</span>) <br/>
</p>
</div>
<div id="removeBlock" class="">
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="set" class="codecontainer">
<div id="set" class="function">
<p>
<span class="keyword">function var</span> set(<span class="type">BlockPlan</span> <span class="parameter">plan</span>) <br/>
</p>
</div>
<div id="set" class="">
<p>
Set the new plan of the entity. The entity will get deleted if the plan is empty. This copies the entire plan that is given as argument, keep that in mind when setting plans with large block counts.
</p>
<p><span class="docheader">Parameters</span></p>
<div class="indented">
<span class="parameter">plan</span>
The new BlockPlan of the entity <br/>
</div>
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="setBlockColor" class="codecontainer">
<div id="setBlockColor" class="function">
<p>
<span class="keyword">function var</span> setBlockColor(<span class="type">int</span> <span class="parameter">index</span>, <span class="type">Color</span> <span class="parameter">color</span>) <br/>
</p>
</div>
<div id="setBlockColor" class="">
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="setBlockDamageFactor" class="codecontainer">
<div id="setBlockDamageFactor" class="function">
<p>
<span class="keyword">function var</span> setBlockDamageFactor(<span class="type">int</span> <span class="parameter">blockIndex</span>, <span class="type">float</span> <span class="parameter">factor</span>) <br/>
</p>
</div>
<div id="setBlockDamageFactor" class="">
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="setBlockType" class="codecontainer">
<div id="setBlockType" class="function">
<p>
<span class="keyword">function var</span> setBlockType(<span class="type">int</span> <span class="parameter">index</span>, <span class="type">int</span> <span class="parameter">type</span>) <br/>
</p>
</div>
<div id="setBlockType" class="">
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="setBlockTypeDamageFactor" class="codecontainer">
<div id="setBlockTypeDamageFactor" class="function">
<p>
<span class="keyword">function var</span> setBlockTypeDamageFactor(<span class="type">int</span> <span class="parameter">blockType</span>, <span class="type">float</span> <span class="parameter">factor</span>) <br/>
</p>
</div>
<div id="setBlockTypeDamageFactor" class="">
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="setColor" class="codecontainer">
<div id="setColor" class="function">
<p>
<span class="keyword">function var</span> setColor(<span class="type">Color</span> <span class="parameter">color</span>, <span class="type">var</span> <span class="parameter">secondaryColor</span>) <br/>
</p>
</div>
<div id="setColor" class="">
<p>
Set all blocks of plan to the same color (and secondary color)
</p>
<p><span class="docheader">Parameters</span></p>
<div class="indented">
<span class="parameter">color</span>
The new primary color <br/>
<span class="parameter">secondaryColor</span>
The new secondary color. If nil, ColorNone() will be used <br/>
</div>
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="setMaterial" class="codecontainer">
<div id="setMaterial" class="function">
<p>
<span class="keyword">function var</span> setMaterial(<span class="type">Material</span> <span class="parameter">material</span>) <br/>
</p>
</div>
<div id="setMaterial" class="">
<p><span class="docheader">Returns</span></p>
<div class="indented">
<p>
nothing
</p>
</div>
</p>
</div>
</div>
<div id="setSecondaryBlockColor" class="codecontainer">
<div id="setSecondaryBlockColor" class="function">
<p>
<span class="keyword">function var</span> setSecondaryBlockColor(<span class="type">int</span> <span class="parameter">index</span>, <span class="type">Color</span> <span class="parameter">color</span>) <br/>
</p>
</div>
<div id="setSecondaryBlockColor" class="">
<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>
Reference in New Issue View Git Blame Copy Permalink