diff --git a/Moose Development/Dcs/DCSTask.lua b/Moose Development/Dcs/DCSTask.lua index 344f52a25..4b4cd277a 100644 --- a/Moose Development/Dcs/DCSTask.lua +++ b/Moose Development/Dcs/DCSTask.lua @@ -1,10 +1,15 @@ --- @module DCSTask ---- @type Task +--- A task descriptor (internal structure for DCS World) +-- @type Task -- @field #string id -- @field #Task.param param --- @type Task.param +--- List of @{#Task} +-- @type TaskArray +-- @list <#Task> + env.info( "Task defined" ) diff --git a/Moose Development/Dcs/DCSTypes.lua b/Moose Development/Dcs/DCSTypes.lua index b11d4a87b..176725302 100644 --- a/Moose Development/Dcs/DCSTypes.lua +++ b/Moose Development/Dcs/DCSTypes.lua @@ -60,6 +60,16 @@ -- @type TypeName -- @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 -- @field #AI.Skill Skill diff --git a/Moose Development/Moose/Group.lua b/Moose Development/Moose/Group.lua index 818d21eb9..3427faa70 100644 --- a/Moose Development/Moose/Group.lua +++ b/Moose Development/Moose/Group.lua @@ -438,7 +438,7 @@ end -- Note that when the WayPoint parameter is used, the new start mission waypoint of the group will be 1! -- @param #GROUP self -- @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 function GROUP:WayPointExecute( WayPoint, WaitTime ) @@ -807,7 +807,7 @@ end --- Return a Combo Task taking an array of Tasks -- @param #GROUP self --- @param #list DCSTasks +-- @param DCSTask#TaskArray DCSTasks Array of @{DCSTask#Task} -- @return DCSTask#Task function GROUP:TaskCombo( 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 #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 #list 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. function GROUP:TaskEscort( 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. -- @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. -- @return DCSTask#Task The DCS task structure. function GROUP:TaskFireAtPoint( PointVec2, Radius ) @@ -1457,7 +1457,7 @@ end --- (AIR) Engaging targets of defined types. -- @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 #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. -- @return DCSTask#Task The DCS task structure. function GROUP:EnRouteTaskEngageTargets( Distance, TargetTypes, Priority ) @@ -1490,7 +1490,7 @@ end -- @param #GROUP self -- @param DCSTypes#Vec2 PointVec2 2D-coordinates 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. -- @return DCSTask#Task The DCS task structure. function GROUP:EnRouteTaskEngageTargets( PointVec2, Radius, TargetTypes, Priority ) diff --git a/Moose Training/Documentation/DCSTask.html b/Moose Training/Documentation/DCSTask.html index 3950afc35..0bbfd971a 100644 --- a/Moose Training/Documentation/DCSTask.html +++ b/Moose Training/Documentation/DCSTask.html @@ -92,7 +92,10 @@

Type DCSTask

Type Task

-

Field(s)

+ +

A task descriptor (internal structure for DCS World)

+ +

Field(s)

@@ -124,6 +127,11 @@

Type Task.param

+

Type TaskArray

+ +

List of #Task

+ + diff --git a/Moose Training/Documentation/DCSTypes.html b/Moose Training/Documentation/DCSTypes.html index 8f4ec29be..5eeb019c3 100644 --- a/Moose Training/Documentation/DCSTypes.html +++ b/Moose Training/Documentation/DCSTypes.html @@ -2204,6 +2204,21 @@

An angle type

+

Type AttributeName

+ +

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 AttributeNameArray

+ +

List of #AttributeName

+ +

Type Azimuth

Azimuth is an angle of rotation around world axis y counter-clockwise.

diff --git a/Moose Training/Documentation/Group.html b/Moose Training/Documentation/Group.html index a18b037f6..4cf7daf86 100644 --- a/Moose Training/Documentation/Group.html +++ b/Moose Training/Documentation/Group.html @@ -200,7 +200,7 @@ If the DCS Group object does not exist or is nil, the GROUP methods will return - GROUP:EnRouteTaskEngageTargets(Distance, <, Priority, TargetTypes) + GROUP:EnRouteTaskEngageTargets(Distance, TargetTypes, Priority)

(AIR) Engaging targets of defined types.

@@ -628,7 +628,7 @@ If the DCS Group object does not exist or is nil, the GROUP methods will return - GROUP:TaskCombo(<, DCSTasks) + GROUP:TaskCombo(DCSTasks)

Return a Combo Task taking an array of Tasks

@@ -658,7 +658,7 @@ If the DCS Group object does not exist or is nil, the GROUP methods will return - GROUP:TaskEscort(EscortGroup, PointVec3, LastWaypointIndex, EngagementDistanceMax, <, FollowGroup, EngagementDistance, TargetTypes) + GROUP:TaskEscort(EscortGroup, PointVec3, LastWaypointIndex, EngagementDistanceMax, TargetTypes, FollowGroup, EngagementDistance)

(AIR) Escort another airborne group.

@@ -670,7 +670,7 @@ If the DCS Group object does not exist or is nil, the GROUP methods will return - GROUP:TaskFireAtPoint(The, Radius, PointVec2) + GROUP:TaskFireAtPoint(PointVec2, Radius)

(GROUND) Fire at a VEC2 point until ammunition is finished.

@@ -766,7 +766,7 @@ If the DCS Group object does not exist or is nil, the GROUP methods will return - GROUP:WayPointExecute(WayPoint, The, WaitTime) + GROUP:WayPointExecute(WayPoint, WaitTime)

Executes the WayPoint plan.

@@ -1162,7 +1162,7 @@ The DCS task structure.

-GROUP:EnRouteTaskEngageTargets(Distance, <, Priority, TargetTypes) +GROUP:EnRouteTaskEngageTargets(Distance, TargetTypes, Priority)
@@ -1179,8 +1179,8 @@ Maximal distance from the target to a route leg. If the target is on a greater d
  • -

    #list < : -DCSTypes#AttributeName> TargetTypes Array of target categories allowed to engage.

    +

    DCSTypes#AttributeNameArray TargetTypes : +Array of target categories allowed to engage.

  • @@ -1188,11 +1188,6 @@ DCSTypes#AttributeName> TargetTypes Array of target categories allowed to engage

    #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.

    -
    • -
  • - -

    TargetTypes :

    -

    • Return value

    @@ -2973,24 +2968,19 @@ The DCS task structure.

    -GROUP:TaskCombo(<, DCSTasks) +GROUP:TaskCombo(DCSTasks)

    Return a Combo Task taking an array of Tasks

    -

    Parameters

    +

    Parameter

    @@ -3155,7 +3145,7 @@ The DCS task structure

    -GROUP:TaskEscort(EscortGroup, PointVec3, LastWaypointIndex, EngagementDistanceMax, <, FollowGroup, EngagementDistance, TargetTypes) +GROUP:TaskEscort(EscortGroup, PointVec3, LastWaypointIndex, EngagementDistanceMax, TargetTypes, FollowGroup, EngagementDistance)
    @@ -3194,8 +3184,8 @@ Maximal distance from escorted group to threat. If the threat is already engaged
  • -

    #list < : -CSTypes#AttributeName> TargetTypes Array of AttributeName that is contains threat categories allowed to engage.

    +

    DCSTypes#AttributeNameArray TargetTypes : +Array of AttributeName that is contains threat categories allowed to engage.

  • @@ -3207,11 +3197,6 @@ CSTypes#AttributeName> TargetTypes Array of AttributeName that is contains threa

    EngagementDistance :

    -
    • -
  • - -

    TargetTypes :

    -

    • Return value

    @@ -3274,7 +3259,7 @@ The DCS task structure.

    -GROUP:TaskFireAtPoint(The, Radius, PointVec2) +GROUP:TaskFireAtPoint(PointVec2, Radius)
    @@ -3285,8 +3270,8 @@ The DCS task structure.

    • -

      DCSTypes#Vec2 The : -point to fire at.

      +

      DCSTypes#Vec2 PointVec2 : +The point to fire at.

    • @@ -3294,11 +3279,6 @@ point to fire at.

      DCSTypes#Distance Radius : The radius of the zone to deploy the fire at.

      -
      • -
    • - -

      PointVec2 :

      -

    Return value

    @@ -3799,7 +3779,7 @@ The formation string.

    -GROUP:WayPointExecute(WayPoint, The, WaitTime) +GROUP:WayPointExecute(WayPoint, WaitTime)
    @@ -3820,13 +3800,8 @@ The WayPoint from where to execute the mission.

  • -

    #WaitTime The : -amount seconds to wait before initiating the mission.

    - -
    • -
  • - -

    WaitTime :

    +

    #number WaitTime : +The amount seconds to wait before initiating the mission.

    • @@ -3951,10 +3926,6 @@ The waypoint function to be called when the group moves over the waypoint. The w
    -

    Type WaitTime

    - -

    Type list

    -