MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-09-01 21:03:17 +00:00
parent 0fe0ac5cbb
commit f9d7e00e51
30 changed files with 774 additions and 775 deletions

View File

@@ -1744,19 +1744,20 @@ And there is NO cargo object actually declared within the script! However, if yo
Note that this option is optional, so can be omitted. The default value of the RR is 10 meters.</li>
</ul>
<h2>5.2) The #CARGO tag to create CARGO_CRATE objects:</h2>
<h2>5.2) The #CARGO tag to create CARGO_CRATE or CARGO_SLINGLOAD objects:</h2>
<p>You can also use the #CARGO tag on <strong>static</strong> objects, including <strong>static cargo</strong> objects of the mission editor.</p>
<p>For example, the following #CARGO naming in the <strong>static name</strong> of the object, will create a CARGO_CRATE object when the mission starts.</p>
<p> <code>Static #CARGO(T=Workmaterials,RR=500,NR=25)</code></p>
<p> <code>Static #CARGO(T=Workmaterials,C=CRATE,RR=500,NR=25)</code></p>
<p>This will create a CARGO_CRATE object:</p>
<ul>
<li>with the group name <code>Static #CARGO</code></li>
<li>is of type <code>Workmaterials</code></li>
<li>is of category <code>CRATE</code> (as opposed to <code>SLING</code>)</li>
<li>will report when a carrier is within 500 meters</li>
<li>will board to carriers when the carrier is within 500 meters from the cargo object</li>
<li>will disappear when the cargo is within 25 meters from the carrier during boarding</li>
@@ -1764,10 +1765,11 @@ And there is NO cargo object actually declared within the script! However, if yo
<p>So the overall syntax of the #CARGO naming tag and arguments are:</p>
<p> <code>StaticName #CARGO(T=CargoTypeName,RR=Range,NR=Range)</code></p>
<p> <code>StaticName #CARGO(T=CargoTypeName,C=Category,RR=Range,NR=Range)</code></p>
<ul>
<li><strong>T=</strong> Provide a text that contains the type name of the cargo object. This type name can be used to filter cargo within a SET_CARGO object.</li>
<li><strong>C=</strong> Provide either <code>CRATE</code> or <code>SLING</code> to have this static created as a CARGO_CRATE or CARGO_SLINGLOAD respectivly.</li>
<li><strong>RR=</strong> Provide the minimal range in meters when the report to the carrier, and board to the carrier.
Note that this option is optional, so can be omitted. The default value of the RR is 250 meters.</li>
<li><strong>NR=</strong> Provide the maximum range in meters when the cargo units will be boarded within the carrier during boarding.