- Added change logs of API changes in MOOSE documentation.

- Added ZONE_BASE:GetName() method.

- Added ZONE_BASE:GetZoneProbability() method.

- Added ZONE_BASE:SetZoneProbability() method.

- Added ZONE_BASE:GetZoneMaybe() method.

- Added SPAWN:InitRandomizeZones() method.
This commit is contained in:
Sven Van de Velde
2016-08-15 18:44:04 +02:00
parent 0bfac2d2ed
commit 0c15f92210
9 changed files with 438 additions and 44 deletions

View File

@@ -135,7 +135,7 @@
<ul>
<li><a href="##(ZONE_BASE).SetRandomizeProbability">ZONE_BASE.SetRandomizeProbability</a>(): Set the randomization probability of a zone to be selected, taking a value between 0 and 1 ( 0 = 0%, 1 = 100% )</li>
<li><a href="##(ZONE_BASE).GetRandomizeProbability">ZONE_BASE.GetRandomizeProbability</a>(): Get the randomization probability of a zone to be selected, passing a value between 0 and 1 ( 0 = 0%, 1 = 100% )</li>
<li><a href="##(ZONE_BASE).GetZoneRandomize">ZONE_BASE.GetZoneRandomize</a>(): Get the zone taking into account the randomization probability. nil is returned if this zone is not a candidate.</li>
<li><a href="##(ZONE_BASE).GetZoneMaybe">ZONE_BASE.GetZoneMaybe</a>(): Get the zone taking into account the randomization probability. nil is returned if this zone is not a candidate.</li>
</ul>
<h3>1.3) A zone manages Vectors:</h3>
@@ -216,6 +216,25 @@ This class is an abstract BASE class for derived classes, and is not meant to be
<p>The ZONE_POLYGON class defined by a sequence of <a href="Group.html##(GROUP)">Group#GROUP</a> waypoints within the Mission Editor, forming a polygon.
This class implements the inherited functions from <a href="Zone.html##(ZONE_RADIUS)">Zone#ZONE_RADIUS</a> taking into account the own zone format and properties.</p>
<hr/>
<h1><strong>API CHANGE HISTORY</strong></h1>
<p>The underlying change log documents the API changes. Please read this carefully. The following notation is used:</p>
<ul>
<li><strong>Added</strong> parts are expressed in bold type face.</li>
<li><em>Removed</em> parts are expressed in italic type face.</li>
</ul>
<p>Hereby the change log:</p>
<p>2016-08-15: ZONE_BASE:<strong>SetRandomizationProbability( RandomizationProbability )</strong> added.</p>
<p>2016-08-15: ZONE_BASE:<strong>GetRandomizationProbability()</strong> added.</p>
<p>2016-08-15: ZONE_BASE:<strong>GetZoneMaybe()</strong> added.</p>
<hr/>
@@ -313,7 +332,7 @@ This class implements the inherited functions from <a href="Zone.html##(ZONE_RAD
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_BASE).GetZoneRandomized">ZONE_BASE:GetZoneRandomized()</a></td>
<td class="name" nowrap="nowrap"><a href="##(ZONE_BASE).GetZoneMaybe">ZONE_BASE:GetZoneMaybe()</a></td>
<td class="summary">
<p>Get the zone taking into account the randomization probability of a zone to be selected.</p>
</td>
@@ -873,8 +892,8 @@ A value between 0 and 1. 0 = 0% and 1 = 100% probability.</p>
<dl class="function">
<dt>
<a id="#(ZONE_BASE).GetZoneRandomized" >
<strong>ZONE_BASE:GetZoneRandomized()</strong>
<a id="#(ZONE_BASE).GetZoneMaybe" >
<strong>ZONE_BASE:GetZoneMaybe()</strong>
</a>
</dt>
<dd>