Merge pull request #59 from FlightControl-Master/Bugfix

Bugfix
This commit is contained in:
Sven Van de Velde 2016-06-03 12:50:42 +02:00
commit 2ac9e76f5c
6 changed files with 67 additions and 58 deletions

View File

@ -1,10 +1,15 @@
--- @module DCSTask --- @module DCSTask
--- @type Task --- A task descriptor (internal structure for DCS World)
-- @type Task
-- @field #string id -- @field #string id
-- @field #Task.param param -- @field #Task.param param
--- @type Task.param --- @type Task.param
--- List of @{#Task}
-- @type TaskArray
-- @list <#Task>
env.info( "Task defined" ) env.info( "Task defined" )

View File

@ -60,6 +60,16 @@
-- @type TypeName -- @type TypeName
-- @extends #string -- @extends #string
--- AttributeName = string
-- Each object type may have attributes.
-- Attributes are enlisted in ./Scripts/Database/db_attributes.Lua.
-- To know what attributes the object type has, look for the unit type script in sub-directories planes/, helicopter/s, vehicles, navy/ of ./Scripts/Database/ directory.
-- @type AttributeName
-- @extends #string
--- List of @{#AttributeName}
-- @type AttributeNameArray
-- @list <#AttributeName>
--- @type AI --- @type AI
-- @field #AI.Skill Skill -- @field #AI.Skill Skill

View File

@ -438,7 +438,7 @@ end
-- Note that when the WayPoint parameter is used, the new start mission waypoint of the group will be 1! -- Note that when the WayPoint parameter is used, the new start mission waypoint of the group will be 1!
-- @param #GROUP self -- @param #GROUP self
-- @param #number WayPoint The WayPoint from where to execute the mission. -- @param #number WayPoint The WayPoint from where to execute the mission.
-- @param #WaitTime The amount seconds to wait before initiating the mission. -- @param #number WaitTime The amount seconds to wait before initiating the mission.
-- @return #GROUP -- @return #GROUP
function GROUP:WayPointExecute( WayPoint, WaitTime ) function GROUP:WayPointExecute( WayPoint, WaitTime )
@ -807,7 +807,7 @@ end
--- Return a Combo Task taking an array of Tasks --- Return a Combo Task taking an array of Tasks
-- @param #GROUP self -- @param #GROUP self
-- @param #list<DCSTask#Task> DCSTasks -- @param DCSTask#TaskArray DCSTasks Array of @{DCSTask#Task}
-- @return DCSTask#Task -- @return DCSTask#Task
function GROUP:TaskCombo( DCSTasks ) function GROUP:TaskCombo( DCSTasks )
self:F2( { DCSTasks } ) self:F2( { DCSTasks } )
@ -1323,7 +1323,7 @@ end
-- @param DCSTypes#Vec3 PointVec3 Position of the unit / lead unit of the group relative lead unit of another group in frame reference oriented by course of lead unit of another group. If another group is on land the unit / group will orbit around. -- @param DCSTypes#Vec3 PointVec3 Position of the unit / lead unit of the group relative lead unit of another group in frame reference oriented by course of lead unit of another group. If another group is on land the unit / group will orbit around.
-- @param #number LastWaypointIndex Detach waypoint of another group. Once reached the unit / group Follow task is finished. -- @param #number LastWaypointIndex Detach waypoint of another group. Once reached the unit / group Follow task is finished.
-- @param #number EngagementDistanceMax Maximal distance from escorted group to threat. If the threat is already engaged by escort escort will disengage if the distance becomes greater than 1.5 * engagementDistMax. -- @param #number EngagementDistanceMax Maximal distance from escorted group to threat. If the threat is already engaged by escort escort will disengage if the distance becomes greater than 1.5 * engagementDistMax.
-- @param #list<DCSTypes#AttributeName> TargetTypes Array of AttributeName that is contains threat categories allowed to engage. -- @param DCSTypes#AttributeNameArray TargetTypes Array of AttributeName that is contains threat categories allowed to engage.
-- @return DCSTask#Task The DCS task structure. -- @return DCSTask#Task The DCS task structure.
function GROUP:TaskEscort( FollowGroup, PointVec3, LastWaypointIndex, EngagementDistance, TargetTypes ) function GROUP:TaskEscort( FollowGroup, PointVec3, LastWaypointIndex, EngagementDistance, TargetTypes )
self:F2( { self.GroupName, FollowGroup, PointVec3, LastWaypointIndex, EngagementDistance, TargetTypes } ) self:F2( { self.GroupName, FollowGroup, PointVec3, LastWaypointIndex, EngagementDistance, TargetTypes } )
@ -1366,7 +1366,7 @@ end
--- (GROUND) Fire at a VEC2 point until ammunition is finished. --- (GROUND) Fire at a VEC2 point until ammunition is finished.
-- @param #GROUP self -- @param #GROUP self
-- @param DCSTypes#Vec2 The point to fire at. -- @param DCSTypes#Vec2 PointVec2 The point to fire at.
-- @param DCSTypes#Distance Radius The radius of the zone to deploy the fire at. -- @param DCSTypes#Distance Radius The radius of the zone to deploy the fire at.
-- @return DCSTask#Task The DCS task structure. -- @return DCSTask#Task The DCS task structure.
function GROUP:TaskFireAtPoint( PointVec2, Radius ) function GROUP:TaskFireAtPoint( PointVec2, Radius )
@ -1457,7 +1457,7 @@ end
--- (AIR) Engaging targets of defined types. --- (AIR) Engaging targets of defined types.
-- @param #GROUP self -- @param #GROUP self
-- @param DCSTypes#Distance Distance Maximal distance from the target to a route leg. If the target is on a greater distance it will be ignored. -- @param DCSTypes#Distance Distance Maximal distance from the target to a route leg. If the target is on a greater distance it will be ignored.
-- @param #list<#DCSTypes#AttributeName> TargetTypes Array of target categories allowed to engage. -- @param DCSTypes#AttributeNameArray TargetTypes Array of target categories allowed to engage.
-- @param #number Priority All enroute tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first. -- @param #number Priority All enroute tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first.
-- @return DCSTask#Task The DCS task structure. -- @return DCSTask#Task The DCS task structure.
function GROUP:EnRouteTaskEngageTargets( Distance, TargetTypes, Priority ) function GROUP:EnRouteTaskEngageTargets( Distance, TargetTypes, Priority )
@ -1490,7 +1490,7 @@ end
-- @param #GROUP self -- @param #GROUP self
-- @param DCSTypes#Vec2 PointVec2 2D-coordinates of the zone. -- @param DCSTypes#Vec2 PointVec2 2D-coordinates of the zone.
-- @param DCSTypes#Distance Radius Radius of the zone. -- @param DCSTypes#Distance Radius Radius of the zone.
-- @param #list<#DCSTypes#AttributeName> TargetTypes Array of target categories allowed to engage. -- @param DCSTypes#AttributeNameArray TargetTypes Array of target categories allowed to engage.
-- @param #number Priority All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first. -- @param #number Priority All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first.
-- @return DCSTask#Task The DCS task structure. -- @return DCSTask#Task The DCS task structure.
function GROUP:EnRouteTaskEngageTargets( PointVec2, Radius, TargetTypes, Priority ) function GROUP:EnRouteTaskEngageTargets( PointVec2, Radius, TargetTypes, Priority )

View File

@ -92,7 +92,10 @@
<h2><a id="#(DCSTask)" >Type <code>DCSTask</code></a></h2> <h2><a id="#(DCSTask)" >Type <code>DCSTask</code></a></h2>
<h2><a id="#(Task)" >Type <code>Task</code></a></h2> <h2><a id="#(Task)" >Type <code>Task</code></a></h2>
<h3>Field(s)</h3>
<p>A task descriptor (internal structure for DCS World)</p>
<h3>Field(s)</h3>
<dl class="function"> <dl class="function">
<dt> <dt>
@ -124,6 +127,11 @@
<h2><a id="#(Task.param)" >Type <code>Task.param</code></a></h2> <h2><a id="#(Task.param)" >Type <code>Task.param</code></a></h2>
<h2><a id="#(TaskArray)" >Type <code>TaskArray</code></a></h2>
<p>List of <a href="##(Task)">#Task</a></p>
</div> </div>
</div> </div>

View File

@ -2204,6 +2204,21 @@
<p>An angle type</p> <p>An angle type</p>
<h2><a id="#(AttributeName)" >Type <code>AttributeName</code></a></h2>
<p>AttributeName = string
Each object type may have attributes.</p>
<p>Attributes are enlisted in ./Scripts/Database/db_attributes.Lua.
To know what attributes the object type has, look for the unit type script in sub-directories planes/, helicopter/s, vehicles, navy/ of ./Scripts/Database/ directory. </p>
<h2><a id="#(AttributeNameArray)" >Type <code>AttributeNameArray</code></a></h2>
<p>List of <a href="##(AttributeName)">#AttributeName</a></p>
<h2><a id="#(Azimuth)" >Type <code>Azimuth</code></a></h2> <h2><a id="#(Azimuth)" >Type <code>Azimuth</code></a></h2>
<p>Azimuth is an angle of rotation around world axis y counter-clockwise.</p> <p>Azimuth is an angle of rotation around world axis y counter-clockwise.</p>

View File

@ -200,7 +200,7 @@ If the DCS Group object does not exist or is nil, the GROUP methods will return
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).EnRouteTaskEngageTargets">GROUP:EnRouteTaskEngageTargets(Distance, <, Priority, TargetTypes)</a></td> <td class="name" nowrap="nowrap"><a href="##(GROUP).EnRouteTaskEngageTargets">GROUP:EnRouteTaskEngageTargets(Distance, TargetTypes, Priority)</a></td>
<td class="summary"> <td class="summary">
<p>(AIR) Engaging targets of defined types.</p> <p>(AIR) Engaging targets of defined types.</p>
</td> </td>
@ -628,7 +628,7 @@ If the DCS Group object does not exist or is nil, the GROUP methods will return
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskCombo">GROUP:TaskCombo(<, DCSTasks)</a></td> <td class="name" nowrap="nowrap"><a href="##(GROUP).TaskCombo">GROUP:TaskCombo(DCSTasks)</a></td>
<td class="summary"> <td class="summary">
<p>Return a Combo Task taking an array of Tasks</p> <p>Return a Combo Task taking an array of Tasks</p>
</td> </td>
@ -658,7 +658,7 @@ If the DCS Group object does not exist or is nil, the GROUP methods will return
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskEscort">GROUP:TaskEscort(EscortGroup, PointVec3, LastWaypointIndex, EngagementDistanceMax, <, FollowGroup, EngagementDistance, TargetTypes)</a></td> <td class="name" nowrap="nowrap"><a href="##(GROUP).TaskEscort">GROUP:TaskEscort(EscortGroup, PointVec3, LastWaypointIndex, EngagementDistanceMax, TargetTypes, FollowGroup, EngagementDistance)</a></td>
<td class="summary"> <td class="summary">
<p>(AIR) Escort another airborne group.</p> <p>(AIR) Escort another airborne group.</p>
</td> </td>
@ -670,7 +670,7 @@ If the DCS Group object does not exist or is nil, the GROUP methods will return
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskFireAtPoint">GROUP:TaskFireAtPoint(The, Radius, PointVec2)</a></td> <td class="name" nowrap="nowrap"><a href="##(GROUP).TaskFireAtPoint">GROUP:TaskFireAtPoint(PointVec2, Radius)</a></td>
<td class="summary"> <td class="summary">
<p>(GROUND) Fire at a VEC2 point until ammunition is finished.</p> <p>(GROUND) Fire at a VEC2 point until ammunition is finished.</p>
</td> </td>
@ -766,7 +766,7 @@ If the DCS Group object does not exist or is nil, the GROUP methods will return
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).WayPointExecute">GROUP:WayPointExecute(WayPoint, The, WaitTime)</a></td> <td class="name" nowrap="nowrap"><a href="##(GROUP).WayPointExecute">GROUP:WayPointExecute(WayPoint, WaitTime)</a></td>
<td class="summary"> <td class="summary">
<p>Executes the WayPoint plan.</p> <p>Executes the WayPoint plan.</p>
</td> </td>
@ -1162,7 +1162,7 @@ The DCS task structure.</p>
<dt> <dt>
<a id="#(GROUP).EnRouteTaskEngageTargets" > <a id="#(GROUP).EnRouteTaskEngageTargets" >
<strong>GROUP:EnRouteTaskEngageTargets(Distance, <, Priority, TargetTypes)</strong> <strong>GROUP:EnRouteTaskEngageTargets(Distance, TargetTypes, Priority)</strong>
</a> </a>
</dt> </dt>
<dd> <dd>
@ -1179,8 +1179,8 @@ Maximal distance from the target to a route leg. If the target is on a greater d
</li> </li>
<li> <li>
<p><code><em><a href="##(list)">#list</a> &lt; </em></code>: <p><code><em><a href="DCSTypes.html##(AttributeNameArray)">DCSTypes#AttributeNameArray</a> TargetTypes </em></code>:
DCSTypes#AttributeName> TargetTypes Array of target categories allowed to engage. </p> Array of target categories allowed to engage. </p>
</li> </li>
<li> <li>
@ -1188,11 +1188,6 @@ DCSTypes#AttributeName> TargetTypes Array of target categories allowed to engage
<p><code><em>#number Priority </em></code>: <p><code><em>#number Priority </em></code>:
All enroute tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first. </p> All enroute tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first. </p>
</li>
<li>
<p><code><em> TargetTypes </em></code>: </p>
</li> </li>
</ul> </ul>
<h3>Return value</h3> <h3>Return value</h3>
@ -2973,24 +2968,19 @@ The DCS task structure.</p>
<dt> <dt>
<a id="#(GROUP).TaskCombo" > <a id="#(GROUP).TaskCombo" >
<strong>GROUP:TaskCombo(<, DCSTasks)</strong> <strong>GROUP:TaskCombo(DCSTasks)</strong>
</a> </a>
</dt> </dt>
<dd> <dd>
<p>Return a Combo Task taking an array of Tasks</p> <p>Return a Combo Task taking an array of Tasks</p>
<h3>Parameters</h3> <h3>Parameter</h3>
<ul> <ul>
<li> <li>
<p><code><em><a href="##(list)">#list</a> &lt; </em></code>: <p><code><em><a href="DCSTask.html##(TaskArray)">DCSTask#TaskArray</a> DCSTasks </em></code>:
CSTask#Task> DCSTasks</p> Array of <a href="DCSTask.html##(Task)">DCSTask#Task</a></p>
</li>
<li>
<p><code><em> DCSTasks </em></code>: </p>
</li> </li>
</ul> </ul>
@ -3155,7 +3145,7 @@ The DCS task structure</p>
<dt> <dt>
<a id="#(GROUP).TaskEscort" > <a id="#(GROUP).TaskEscort" >
<strong>GROUP:TaskEscort(EscortGroup, PointVec3, LastWaypointIndex, EngagementDistanceMax, <, FollowGroup, EngagementDistance, TargetTypes)</strong> <strong>GROUP:TaskEscort(EscortGroup, PointVec3, LastWaypointIndex, EngagementDistanceMax, TargetTypes, FollowGroup, EngagementDistance)</strong>
</a> </a>
</dt> </dt>
<dd> <dd>
@ -3194,8 +3184,8 @@ Maximal distance from escorted group to threat. If the threat is already engaged
</li> </li>
<li> <li>
<p><code><em><a href="##(list)">#list</a> &lt; </em></code>: <p><code><em><a href="DCSTypes.html##(AttributeNameArray)">DCSTypes#AttributeNameArray</a> TargetTypes </em></code>:
CSTypes#AttributeName> TargetTypes Array of AttributeName that is contains threat categories allowed to engage. </p> Array of AttributeName that is contains threat categories allowed to engage. </p>
</li> </li>
<li> <li>
@ -3207,11 +3197,6 @@ CSTypes#AttributeName> TargetTypes Array of AttributeName that is contains threa
<p><code><em> EngagementDistance </em></code>: </p> <p><code><em> EngagementDistance </em></code>: </p>
</li>
<li>
<p><code><em> TargetTypes </em></code>: </p>
</li> </li>
</ul> </ul>
<h3>Return value</h3> <h3>Return value</h3>
@ -3274,7 +3259,7 @@ The DCS task structure.</p>
<dt> <dt>
<a id="#(GROUP).TaskFireAtPoint" > <a id="#(GROUP).TaskFireAtPoint" >
<strong>GROUP:TaskFireAtPoint(The, Radius, PointVec2)</strong> <strong>GROUP:TaskFireAtPoint(PointVec2, Radius)</strong>
</a> </a>
</dt> </dt>
<dd> <dd>
@ -3285,8 +3270,8 @@ The DCS task structure.</p>
<ul> <ul>
<li> <li>
<p><code><em><a href="DCSTypes.html##(Vec2)">DCSTypes#Vec2</a> The </em></code>: <p><code><em><a href="DCSTypes.html##(Vec2)">DCSTypes#Vec2</a> PointVec2 </em></code>:
point to fire at.</p> The point to fire at.</p>
</li> </li>
<li> <li>
@ -3294,11 +3279,6 @@ point to fire at.</p>
<p><code><em><a href="DCSTypes.html##(Distance)">DCSTypes#Distance</a> Radius </em></code>: <p><code><em><a href="DCSTypes.html##(Distance)">DCSTypes#Distance</a> Radius </em></code>:
The radius of the zone to deploy the fire at.</p> The radius of the zone to deploy the fire at.</p>
</li>
<li>
<p><code><em> PointVec2 </em></code>: </p>
</li> </li>
</ul> </ul>
<h3>Return value</h3> <h3>Return value</h3>
@ -3799,7 +3779,7 @@ The formation string.</p>
<dt> <dt>
<a id="#(GROUP).WayPointExecute" > <a id="#(GROUP).WayPointExecute" >
<strong>GROUP:WayPointExecute(WayPoint, The, WaitTime)</strong> <strong>GROUP:WayPointExecute(WayPoint, WaitTime)</strong>
</a> </a>
</dt> </dt>
<dd> <dd>
@ -3820,13 +3800,8 @@ The WayPoint from where to execute the mission.</p>
</li> </li>
<li> <li>
<p><code><em><a href="##(WaitTime)">#WaitTime</a> The </em></code>: <p><code><em>#number WaitTime </em></code>:
amount seconds to wait before initiating the mission.</p> The amount seconds to wait before initiating the mission.</p>
</li>
<li>
<p><code><em> WaitTime </em></code>: </p>
</li> </li>
</ul> </ul>
@ -3951,10 +3926,6 @@ The waypoint function to be called when the group moves over the waypoint. The w
</dd> </dd>
</dl> </dl>
<h2><a id="#(WaitTime)" >Type <code>WaitTime</code></a></h2>
<h2><a id="#(list)" >Type <code>list</code></a></h2>
</div> </div>
</div> </div>