Documentation

This commit is contained in:
FlightControl_Master 2017-08-08 15:56:17 +02:00
parent 386777930e
commit 6dec92168e
10 changed files with 173 additions and 140 deletions

View File

@ -926,6 +926,9 @@ Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI<em>PATROL</em>ZONE.M
<p> This table contains the targets detected during patrol.</p>
</dd> </dd>
</dl> </dl>
<dl class="function"> <dl class="function">

View File

@ -3417,6 +3417,7 @@ The range till cargo will board.</p>
<dl class="function"> <dl class="function">
<dt> <dt>
<em></em>
<a id="#(CARGO_UNIT).CargoCarrier" > <a id="#(CARGO_UNIT).CargoCarrier" >
<strong>CARGO_UNIT.CargoCarrier</strong> <strong>CARGO_UNIT.CargoCarrier</strong>
</a> </a>

View File

@ -433,6 +433,12 @@
<td class="name" nowrap="nowrap"><a href="##(CONTROLLABLE).Route">CONTROLLABLE:Route(Route, DelaySeconds)</a></td> <td class="name" nowrap="nowrap"><a href="##(CONTROLLABLE).Route">CONTROLLABLE:Route(Route, DelaySeconds)</a></td>
<td class="summary"> <td class="summary">
<p>Make the controllable to follow a given route.</p> <p>Make the controllable to follow a given route.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(CONTROLLABLE).RouteGroundTo">CONTROLLABLE:RouteGroundTo(ToCoordinate, Speed, Formation, DelaySeconds)</a></td>
<td class="summary">
<p>Make the GROUND controllable to drive towards a specific point.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -460,7 +466,7 @@
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(CONTROLLABLE).SetTaskAtWaypoint">CONTROLLABLE:SetTaskAtWaypoint(RouteList, WaypointNumber, Task)</a></td> <td class="name" nowrap="nowrap"><a href="##(CONTROLLABLE).SetTaskWaypoint">CONTROLLABLE:SetTaskWaypoint(Waypoint, Task)</a></td>
<td class="summary"> <td class="summary">
<p>Set a Task at a Waypoint using a Route list.</p> <p>Set a Task at a Waypoint using a Route list.</p>
</td> </td>
@ -2214,6 +2220,51 @@ The CONTROLLABLE.</p>
<dl class="function"> <dl class="function">
<dt> <dt>
<a id="#(CONTROLLABLE).RouteGroundTo" >
<strong>CONTROLLABLE:RouteGroundTo(ToCoordinate, Speed, Formation, DelaySeconds)</strong>
</a>
</dt>
<dd>
<p>Make the GROUND controllable to drive towards a specific point.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a> ToCoordinate </em></code>:
A Coordinate to drive to.</p>
</li>
<li>
<p><code><em>#number Speed </em></code>:
(optional) Speed in km/h. The default speed is 999 km/h.</p>
</li>
<li>
<p><code><em>#string Formation </em></code>:
(optional) The route point Formation, which is a text string that specifies exactly the Text in the Type of the route point, like "Vee", "Echelon Right".</p>
</li>
<li>
<p><code><em>#number DelaySeconds </em></code>:
Wait for the specified seconds before executing the Route.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(CONTROLLABLE)">#CONTROLLABLE</a>:</em>
The CONTROLLABLE.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(CONTROLLABLE).RouteToVec2" > <a id="#(CONTROLLABLE).RouteToVec2" >
<strong>CONTROLLABLE:RouteToVec2(Point, Speed)</strong> <strong>CONTROLLABLE:RouteToVec2(Point, Speed)</strong>
</a> </a>
@ -2337,8 +2388,8 @@ self</p>
<dl class="function"> <dl class="function">
<dt> <dt>
<a id="#(CONTROLLABLE).SetTaskAtWaypoint" > <a id="#(CONTROLLABLE).SetTaskWaypoint" >
<strong>CONTROLLABLE:SetTaskAtWaypoint(RouteList, WaypointNumber, Task)</strong> <strong>CONTROLLABLE:SetTaskWaypoint(Waypoint, Task)</strong>
</a> </a>
</dt> </dt>
<dd> <dd>
@ -2349,14 +2400,8 @@ self</p>
<ul> <ul>
<li> <li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE.RouteList)">Wrapper.Controllable#CONTROLLABLE.RouteList</a> RouteList </em></code>: <p><code><em>#table Waypoint </em></code>:
A list of Waypoints.</p> The Waypoint!</p>
</li>
<li>
<p><code><em>#number WaypointNumber </em></code>:
The number of the Waypoint. The first Waypoint starts at 1!</p>
</li> </li>
<li> <li>
@ -3124,8 +3169,8 @@ The variable arguments passed to the function when called! These arguments can b
local ToCoord = RandomZone:GetCoordinate() local ToCoord = RandomZone:GetCoordinate()
-- Create a "ground route point", which is a "point" structure that can be given as a parameter to a Task -- Create a "ground route point", which is a "point" structure that can be given as a parameter to a Task
Route[#Route+1] = FromCoord:RoutePointGround( 72 ) Route[#Route+1] = FromCoord:WaypointGround( 72 )
Route[#Route+1] = ToCoord:RoutePointGround( 60, "Vee" ) Route[#Route+1] = ToCoord:WaypointGround( 60, "Vee" )
local TaskRouteToZone = Vehicle:TaskFunction( "RouteToZone", RandomZone ) local TaskRouteToZone = Vehicle:TaskFunction( "RouteToZone", RandomZone )

View File

@ -2642,7 +2642,7 @@ The group to generate the report for.</p>
<dl class="function"> <dl class="function">
<dt> <dt>
<em>#number</em> <em></em>
<a id="#(DETECTION_BASE).DetectionInterval" > <a id="#(DETECTION_BASE).DetectionInterval" >
<strong>DETECTION_BASE.DetectionInterval</strong> <strong>DETECTION_BASE.DetectionInterval</strong>
</a> </a>

View File

@ -1598,7 +1598,7 @@ A string defining the start state.</p>
<dl class="function"> <dl class="function">
<dt> <dt>
<em>#string</em> <em></em>
<a id="#(FSM)._StartState" > <a id="#(FSM)._StartState" >
<strong>FSM._StartState</strong> <strong>FSM._StartState</strong>
</a> </a>
@ -1897,6 +1897,7 @@ A string defining the start state.</p>
<dl class="function"> <dl class="function">
<dt> <dt>
<em></em>
<a id="#(FSM).current" > <a id="#(FSM).current" >
<strong>FSM.current</strong> <strong>FSM.current</strong>
</a> </a>

View File

@ -918,21 +918,11 @@ The coalition side of the DCS Group.</p>
<p>Returns a COORDINATE object indicating the point of the first UNIT of the GROUP within the mission.</p> <p>Returns a COORDINATE object indicating the point of the first UNIT of the GROUP within the mission.</p>
<h3>Return values</h3> <h3>Return value</h3>
<ol>
<li>
<p><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</em> <p><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</em>
The COORDINATE of the GROUP.</p> The COORDINATE of the GROUP.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd> </dd>
</dl> </dl>
<dl class="function"> <dl class="function">

View File

@ -333,18 +333,6 @@
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).NewFromVec3">COORDINATE:NewFromVec3(Vec3)</a></td> <td class="name" nowrap="nowrap"><a href="##(COORDINATE).NewFromVec3">COORDINATE:NewFromVec3(Vec3)</a></td>
<td class="summary"> <td class="summary">
<p>Create a new COORDINATE object from Vec3 coordinates.</p> <p>Create a new COORDINATE object from Vec3 coordinates.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).RoutePointAir">COORDINATE:RoutePointAir(AltType, Type, Action, Speed, SpeedLocked)</a></td>
<td class="summary">
<p>Build an air type route point.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).RoutePointGround">COORDINATE:RoutePointGround(Speed, Formation)</a></td>
<td class="summary">
<p>Build an ground type route point.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -443,6 +431,18 @@
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).Translate">COORDINATE:Translate(Distance, Angle)</a></td> <td class="name" nowrap="nowrap"><a href="##(COORDINATE).Translate">COORDINATE:Translate(Distance, Angle)</a></td>
<td class="summary"> <td class="summary">
<p>Add a Distance in meters from the COORDINATE orthonormal plane, with the given angle, and calculate the new COORDINATE.</p> <p>Add a Distance in meters from the COORDINATE orthonormal plane, with the given angle, and calculate the new COORDINATE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).WaypointAir">COORDINATE:WaypointAir(AltType, Type, Action, Speed, SpeedLocked)</a></td>
<td class="summary">
<p>Build an air type route point.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).WaypointGround">COORDINATE:WaypointGround(Speed, Formation)</a></td>
<td class="summary">
<p>Build an ground type route point.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -799,8 +799,8 @@
<p>A COORDINATE can prepare waypoints for Ground and Air groups to be embedded into a Route.</p> <p>A COORDINATE can prepare waypoints for Ground and Air groups to be embedded into a Route.</p>
<ul> <ul>
<li><a href="##(COORDINATE).RoutePointAir">COORDINATE.RoutePointAir</a>(): Build an air route point.</li> <li><a href="##(COORDINATE).WaypointAir">COORDINATE.WaypointAir</a>(): Build an air route point.</li>
<li><a href="##(COORDINATE).RoutePointGround">COORDINATE.RoutePointGround</a>(): Build a ground route point.</li> <li><a href="##(COORDINATE).WaypointGround">COORDINATE.WaypointGround</a>(): Build a ground route point.</li>
</ul> </ul>
<p>Route points can be used in the Route methods of the <a href="Group.html##(GROUP)">Group#GROUP</a> class.</p> <p>Route points can be used in the Route methods of the <a href="Group.html##(GROUP)">Group#GROUP</a> class.</p>
@ -1776,90 +1776,6 @@ The Vec3 point.</p>
<p><em><a href="##(COORDINATE)">#COORDINATE</a>:</em></p> <p><em><a href="##(COORDINATE)">#COORDINATE</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).RoutePointAir" >
<strong>COORDINATE:RoutePointAir(AltType, Type, Action, Speed, SpeedLocked)</strong>
</a>
</dt>
<dd>
<p>Build an air type route point.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="##(COORDINATE.RoutePointAltType)">#COORDINATE.RoutePointAltType</a> AltType </em></code>:
The altitude type.</p>
</li>
<li>
<p><code><em><a href="##(COORDINATE.RoutePointType)">#COORDINATE.RoutePointType</a> Type </em></code>:
The route point type.</p>
</li>
<li>
<p><code><em><a href="##(COORDINATE.RoutePointAction)">#COORDINATE.RoutePointAction</a> Action </em></code>:
The route point action.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Speed)">Dcs.DCSTypes#Speed</a> Speed </em></code>:
Airspeed in km/h.</p>
</li>
<li>
<p><code><em>#boolean SpeedLocked </em></code>:
true means the speed is locked.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#table:</em>
The route point.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).RoutePointGround" >
<strong>COORDINATE:RoutePointGround(Speed, Formation)</strong>
</a>
</dt>
<dd>
<p>Build an ground type route point.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Speed)">Dcs.DCSTypes#Speed</a> Speed </em></code>:
Speed in km/h.</p>
</li>
<li>
<p><code><em><a href="##(COORDINATE.RoutePointAction)">#COORDINATE.RoutePointAction</a> Formation </em></code>:
The route point Formation.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#table:</em>
The route point.</p>
</dd> </dd>
</dl> </dl>
<dl class="function"> <dl class="function">
@ -2277,6 +2193,90 @@ The Angle in degrees.</p>
<p><em><a href="##(COORDINATE)">#COORDINATE</a>:</em> <p><em><a href="##(COORDINATE)">#COORDINATE</a>:</em>
The new calculated COORDINATE.</p> The new calculated COORDINATE.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).WaypointAir" >
<strong>COORDINATE:WaypointAir(AltType, Type, Action, Speed, SpeedLocked)</strong>
</a>
</dt>
<dd>
<p>Build an air type route point.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="##(COORDINATE.RoutePointAltType)">#COORDINATE.RoutePointAltType</a> AltType </em></code>:
The altitude type.</p>
</li>
<li>
<p><code><em><a href="##(COORDINATE.RoutePointType)">#COORDINATE.RoutePointType</a> Type </em></code>:
The route point type.</p>
</li>
<li>
<p><code><em><a href="##(COORDINATE.RoutePointAction)">#COORDINATE.RoutePointAction</a> Action </em></code>:
The route point action.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Speed)">Dcs.DCSTypes#Speed</a> Speed </em></code>:
Airspeed in km/h.</p>
</li>
<li>
<p><code><em>#boolean SpeedLocked </em></code>:
true means the speed is locked.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#table:</em>
The route point.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).WaypointGround" >
<strong>COORDINATE:WaypointGround(Speed, Formation)</strong>
</a>
</dt>
<dd>
<p>Build an ground type route point.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#number Speed </em></code>:
(optional) Speed in km/h. The default speed is 999 km/h.</p>
</li>
<li>
<p><code><em>#string Formation </em></code>:
(optional) The route point Formation, which is a text string that specifies exactly the Text in the Type of the route point, like "Vee", "Echelon Right".</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#table:</em>
The route point.</p>
</dd> </dd>
</dl> </dl>
<dl class="function"> <dl class="function">
@ -2829,6 +2829,7 @@ The y coordinate.</p>
<dl class="function"> <dl class="function">
<dt> <dt>
<em></em>
<a id="#(POINT_VEC2).z" > <a id="#(POINT_VEC2).z" >
<strong>POINT_VEC2.z</strong> <strong>POINT_VEC2.z</strong>
</a> </a>

View File

@ -760,21 +760,11 @@ The POSITIONABLE is not existing or alive. </p>
<p>Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p> <p>Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
<h3>Return values</h3> <h3>Return value</h3>
<ol>
<li>
<p><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</em> <p><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</em>
The COORDINATE of the POSITIONABLE.</p> The COORDINATE of the POSITIONABLE.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd> </dd>
</dl> </dl>
<dl class="function"> <dl class="function">

View File

@ -2735,6 +2735,9 @@ when nothing was spawned.</p>
<p> Overwrite unit names by default with group name.</p>
</dd> </dd>
</dl> </dl>
<dl class="function"> <dl class="function">
@ -3132,7 +3135,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
<dl class="function"> <dl class="function">
<dt> <dt>
<em></em> <em>#boolean</em>
<a id="#(SPAWN).SpawnUnControlled" > <a id="#(SPAWN).SpawnUnControlled" >
<strong>SPAWN.SpawnUnControlled</strong> <strong>SPAWN.SpawnUnControlled</strong>
</a> </a>
@ -3156,7 +3159,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
<p> When the first Spawn executes, all the Groups need to be made visible before start.</p> <p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p>
</dd> </dd>
</dl> </dl>

View File

@ -552,7 +552,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<dl class="function"> <dl class="function">
<dt> <dt>
<em><a href="Core.Cargo.html##(CARGO_GROUP)">Core.Cargo#CARGO_GROUP</a></em> <em><a href="Core.Cargo.html##(CARGO)">Core.Cargo#CARGO</a></em>
<a id="#(FSM_PROCESS).Cargo" > <a id="#(FSM_PROCESS).Cargo" >
<strong>FSM_PROCESS.Cargo</strong> <strong>FSM_PROCESS.Cargo</strong>
</a> </a>
@ -566,7 +566,6 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<dl class="function"> <dl class="function">
<dt> <dt>
<em></em>
<a id="#(FSM_PROCESS).DeployZone" > <a id="#(FSM_PROCESS).DeployZone" >
<strong>FSM_PROCESS.DeployZone</strong> <strong>FSM_PROCESS.DeployZone</strong>
</a> </a>
@ -631,7 +630,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<dl class="function"> <dl class="function">
<dt> <dt>
<em>#number</em> <em></em>
<a id="#(TASK_CARGO).CargoLimit" > <a id="#(TASK_CARGO).CargoLimit" >
<strong>TASK_CARGO.CargoLimit</strong> <strong>TASK_CARGO.CargoLimit</strong>
</a> </a>