+
+; Those are the arguments that need to be passed at the start
+Global $SourceFolder = $CmdLine[1] ;"./Results"
+Global $OutputFolder = $CmdLine[2] ;"@ScriptDir&"/source/index.html.md"
+
+Global $Log = FileOpen(@ScriptDir & "\SlateGenerator2.log", 2)
+Global $DataFile = FileOpen(@ScriptDir & "\TreeHierarchy.csv", 2)
+Global $FunctionList = FileOpen(@ScriptDir & "\FuctionList.txt", 2)
+
+#include "Parser.au3"
+#include "DataStorer.au3"
+#include "Writer.au3"
+
+
+Func ExitCleanly()
+ FileClose($DataFile)
+ FileClose($FunctionList)
+ FileWrite($Log, "SlateGenerator2 exited cleanly")
+ FileClose($Log)
+EndFunc
+
+
+; Small function to determine if a comment block is describing a module, a type or a function
+Func IdentifyBlock($Block, $Declaration)
+ Local $Kind
+ Local $KindFunction
+
+ $Kind = ParseForOneTag($Block, "@module")
+ If $Kind Then
+ Return "module"
+ EndIf
+
+ $Kind = ParseForOneTag($Block, "@type")
+ If $Kind Then
+ Return "type"
+ EndIf
+
+
+ $KindFunction = ParseFunctionName($Block, $Declaration)
+ If $KindFunction[0] Then
+ Return "function"
+ EndIf
+
+ Return ""
+EndFunc
+
+
+
+
+; -----------------------------------------------------------------
+; Main
+; -----------------------------------------------------------------
+
+; Step 1 !
+; -----------------------------------------------------------------
+
+Local $SourceList = _FileListToArrayRec($SourceFolder, "*", $FLTAR_FILES, $FLTAR_RECUR, $FLTAR_NOSORT, $FLTAR_FULLPATH)
+Local $CurrentFile
+Local $CarretPos = 0
+Local $CommentBlock
+Local $CommentKind
+Local $CommentInfo[2]
+Local $CurrentModule
+
+ConsoleWrite("1. Parsing Source Files... ")
+FileWrite($Log, @CRLF&@CRLF&@TAB&"INFO : Building Hierarchy" & @CRLF)
+For $i=1 To $SourceList[0] ; for each .lua source file
+
+
+ FileWrite($Log, "DEBUG : "&$SourceList[$i])
+
+ ; let's read the next .lua source file
+ $CurrentFile = FileOpen($SourceList[$i], $FO_READ)
+ FileWrite($Log, @CRLF&"INFO : Reading File "&$SourceList[$i] & @CRLF)
+ While True ; for each comment block in the current .lua source file
+
+ ; We read the next comment block. If we could not, it's probably eof, time to open the next .lua file
+ $CommentBlock = ReadNextBlock($CurrentFile, $CarretPos)
+ If Not $CommentBlock[1] Then
+ ExitLoop
+ EndIf
+
+ $CarretPos = $CommentBlock[0]
+ $CommentKind = IdentifyBlock($CommentBlock[1], $CommentBlock[2])
+ ; Depending on the kind of comment block it is, we write the appropriate line in TreeHierarchy.csv
+ Switch $CommentKind
+ Case "function"
+ $CommentInfo = ParseFunctionName($CommentBlock[1], $CommentBlock[2])
+ AddNode("function", $CurrentModule, $CommentInfo[0], $CommentInfo[1], $SourceList[$i], $CommentBlock[3])
+ FileWrite($Log, "INFO : Added function "&$CommentInfo[0]&" to hierarchy" & @CRLF)
+ Case "type"
+ $CommentInfo[0] = ParseForOneTag($CommentBlock[1], "@type")
+ $CommentInfo[1] = ParseForOneTag($CommentBlock[1], "@extends")
+ $CommentInfo[1] = StringRegExpReplace($CommentInfo[1], "(.*#)", "")
+ AddNode("type", $CurrentModule, $CommentInfo[0], $CommentInfo[1], $SourceList[$i], $CommentBlock[3])
+ FileWrite($Log, "INFO : Added type "&$CommentInfo[0]&" to hierarchy" & @CRLF)
+ Case "module"
+ $CurrentModule = ParseForOneTag($CommentBlock[1], "@module")
+ AddNode("module", "", $CurrentModule, "", $SourceList[$i], $CommentBlock[3])
+ FileWrite($Log, "INFO : Added module "&$CurrentModule&" to hierarchy" & @CRLF)
+ EndSwitch
+
+ WEnd
+ $CarretPos = 0
+ FileClose($CurrentFile)
+
+Next
+ConsoleWrite("Done"&@CRLF)
+
+
+; Step 2 !
+; -----------------------------------------------------------------
+ConsoleWrite("2. Sorting Hierarchy")
+FileWrite($Log, @CRLF&@CRLF&@TAB&"INFO : Sorting Hierarchy" & @CRLF)
+; The magic happens in DataStorer.au3
+DataSort()
+ConsoleWrite("Done"&@CRLF)
+
+
+
+; Step 3 !
+; -----------------------------------------------------------------
+ConsoleWrite("3. Writing Markdown Documentation")
+FileWrite($Log, @CRLF&@CRLF&@TAB&"INFO : Writing Markdown Documentation" & @CRLF)
+
+Local $CurrentOutput
+Local $CurrentFolder
+Local $RegexResult
+Local $Line
+Local $CarretPos = 0
+Local $Results
+Local $Output
+Local $Declaration
+
+FileSetPos($DataFile, 0, $FILE_BEGIN)
+While True ; For each line in TreeHierarchySorted.csv
+
+ ; read the next line until eof
+ FileSetPos($DataFile, $CarretPos, $FILE_BEGIN)
+ $Line = FileReadLine($DataFile)
+ If @error Then ; eof
+ ExitLoop
+ Endif
+
+ $CarretPos = FileGetPos($DataFile)
+
+ ; find the file/position of the next comment block referenced in the line
+ $RegexResult = StringRegExp($Line, "\@F=(.+?),", $STR_REGEXPARRAYMATCH)
+ $CurrentFile = FileOpen($RegexResult[0], $FO_READ)
+
+ $RegexResult = StringRegExp($Line, "\@C=(.+?),", $STR_REGEXPARRAYMATCH)
+ $DataPos = $RegexResult[0]
+
+ ; get the comment block itself
+ $Results = ReadNextBlock($CurrentFile, $DataPos)
+ $Block = $Results[1]
+ $Declaration = $Results[2]
+
+
+ ; choose the right function to write mardown depending on the type of comment block
+ $RegexResult = StringRegExp($Line, "\@K=(.+?),", $STR_REGEXPARRAYMATCH)
+
+ If $RegexResult[0] == "module" Then
+ ConsoleWrite(".")
+ ; We need the name of the folder containing this particular source file
+ $RegexResult = StringRegExp($Line, "\@F=(.+?),", $STR_REGEXPARRAYMATCH)
+ $RegexResult = StringRegExp($RegexResult[0], "\\(.*)\\.*\.lua", $STR_REGEXPARRAYMATCH)
+ If @error Then
+ $CurrentFolder = ""
+ Else
+ $CurrentFolder = $RegexResult[0]
+ Endif
+
+ ; Now we can write the markdown for this module
+ $CurrentOutput = WriteModule($Block, $CurrentFolder)
+ EndIf
+
+ If $RegexResult[0] == "type" Then
+ ; We need the name of the Module containing the type
+ $RegexResult = StringRegExp($Line, "\@M=(.+?),", $STR_REGEXPARRAYMATCH)
+
+ ; Now we can write the markdown for this type
+ WriteType($Block, $RegexResult[0], $CurrentOutput)
+ EndIf
+
+ If $RegexResult[0] == "function" Then
+ ; We can write the markdown for this function
+ WriteFunction($Block, $Declaration, $CurrentOutput)
+ EndIf
+
+ FileClose($CurrentFile)
+Wend
+ConsoleWrite("Done"&@CRLF)
+
+
+; Step 4 !
+; -----------------------------------------------------------------
+ConsoleWrite("4. Processing Hyperlinks...")
+FileWrite($Log, @CRLF&@CRLF&@TAB&"INFO : Processing Hyperlinks" & @CRLF)
+Local $i=1
+Local $TempFilesArray = _FileListToArray(@ScriptDir & "/TEMP")
+Local $CurrentFile
+Local $FinalFile
+While $i <= $TempFilesArray[0] ; For each markdown file in the temporary folder
+
+ ;read the file
+ $CurrentFile = FileOpen(@ScriptDir & "/TEMP/" & $TempFilesArray[$i], 0)
+ ; The magic happens in Parser.au3
+ $FinalString = ReplaceHyperlinks($CurrentFile)
+
+ ; copy the result to the final file location
+ $FinalFile = FileOpen($OutputFolder & "/includes/" & $TempFilesArray[$i], 2)
+ FileWrite($FinalFile, $FinalString)
+
+ FileClose($FinalFile)
+ FileClose($CurrentFile)
+ $i += 1
+WEnd
+ConsoleWrite("Done"&@CRLF)
+
+
+; Step 5 !
+; -----------------------------------------------------------------
+ConsoleWrite("5. Adding new documentation to index...")
+FileWrite($Log, @CRLF&@CRLF&@TAB&"INFO : Adding new documentation to index" & @CRLF)
+
+; Now this is a bit annoying : there is no way to insert a line in a document.
+; So we need to read the first half of it, read the second half, and the wipe the whole document
+; This way, in the new doc, we can write the first half, what we wanted to insert, and then the second half !
+
+; Let's store the index file in $IndexString
+Local $IndexFile = $OutputFolder&"/index.html.md"
+Local $IndexFileHandle = FileOpen($IndexFile, 0)
+Local $IndexString = FileRead($IndexFileHandle)
+$IndexString = StringRegExpReplace($IndexString, "-\h[A-Z][a-z]+\.[A-Z][a-z]+\s", "")
+
+; Now we slpit it into and store the results in $BeforeString and $AfterString
+Local $SearchPos = StringInStr($IndexString, "search:")
+local $BeforeString = StringTrimRight($IndexString, StringLen($IndexString) - $SearchPos + 5)
+local $AfterString = StringTrimLeft($IndexString, $SearchPos - 1)
+
+; reopening the index file wiping everything
+FileClose($IndexFileHandle)
+$IndexFileHandle = FileOpen($IndexFile, 2)
+
+; write the first half
+FileWrite($IndexFileHandle, $BeforeString)
+Local $IncludePos = StringInStr($IndexString, "includes:")
+FileSetPos($IndexFileHandle, $IncludePos + 10, $FILE_BEGIN)
+
+; add the new markdown files to the index
+$i = 1
+While $i <= $TempFilesArray[0]
+ FileWrite($Log, StringTrimRight($TempFilesArray[$i], 3)&@CRLF)
+
+ FileWrite($IndexFileHandle, " - "&StringTrimRight($TempFilesArray[$i], 3)&@CRLF)
+ $i+=1
+WEnd
+FileWrite($IndexFileHandle, @CRLF)
+
+; append the second half of the file
+FileWrite($IndexFileHandle, $AfterString)
+FileClose($IndexFileHandle)
+ConsoleWrite("Done"&@CRLF)
+
+; WE ARE DONE !
+ExitCleanly()
diff --git a/Utils/Slate Documentation Generator/src/Writer.au3 b/Utils/Slate Documentation Generator/src/Writer.au3
new file mode 100644
index 000000000..b6a249540
--- /dev/null
+++ b/Utils/Slate Documentation Generator/src/Writer.au3
@@ -0,0 +1,209 @@
+; Takes an array and returns it in a markdown flavored list
+; If the list is a retun, then, there is no variable name...
+Func ArrayToList($Array, $Return)
+ $String = ""
+ $i = 0
+ do
+ $String &= "* "
+ $String &= $Array[$i] & " "
+
+ If $Return Then
+ If $Array[$i + 2] == "" or $Array[$i + 2] == " " Then
+ $String &= @CRLF
+ Else
+ $String &= " " & $Array[$i + 1] & " " & $Array[$i + 2] & @CRLF
+ EndIf
+ Else
+
+ $String &= $Array[$i + 1]
+ If $Array[$i + 2] == "" or $Array[$i + 2] == " " Then
+ $String &= @CRLF
+ Else
+ $String &= " : " & $Array[$i + 2] & @CRLF
+ EndIf
+ EndIf
+ $i += 3
+ Until $i >= UBound($Array)
+ Return $String
+EndFunc
+
+
+Func WriteModule($Block, $Group)
+ Local $ModuleName = ParseForOneTag($Block, "@module")
+ DirCreate(@ScriptDir & "\TEMP")
+ Local $Output = FileOpen(@ScriptDir & "\TEMP\" & $Group & "." & $ModuleName & ".md", $FO_OVERWRITE)
+ Local $Data = ""
+ Local $DataPos = 1
+
+ FileWrite($Log, @CRLF&@TAB&"Writing "&$Group & "." & $ModuleName & ".md" &@CRLF)
+ FileWrite($Log, "Writing Module "&$ModuleName&@CRLF)
+
+ ; Add title of Module
+ FileWrite($Output, "# " & $Group & "." & $ModuleName & " Module" & @CRLF)
+
+ ; Copy the short description
+ While StringRight($Data, 1) <> @CRLF And StringRight($Data, 1) <> @CR
+ If StringRight($Data, 7) == "@module" Then ; If there is no comment in the module block
+ Return $Output
+ EndIf
+ $Data &= StringMid($Block, $DataPos, 1)
+ $DataPos += 1
+ WEnd
+ $Data = StringTrimRight($Data, 1)
+ $Block = StringTrimLeft($Block, $DataPos)
+ FileWrite($Output, $Data & @CRLF)
+
+ ; copy the long description
+ $DataPos = 1
+ $Data = ""
+ $Omit = False
+ While StringRight($Data, 7) <> "@module"
+ $Data &= StringMid($Block, $DataPos, 1)
+ $DataPos += 1
+ WEnd
+ $Data = StringTrimRight($Data, 8)
+ FileWrite($Output, $Data & @CRLF)
+ Return $Output
+EndFunc
+
+
+Func WriteType($Block, $ModuleName, $Output)
+ Local $TypeName = ParseForOneTag($Block, "@type")
+ Local $ParentClass = GetData($TypeName, "parent")
+ Local $Fields = ParseForTags($Block, "@field")
+
+ FileWrite($Log, "Writing Type "&$TypeName&@CRLF)
+
+ ; Add title of Type
+ FileWrite($Output, "## " & $TypeName & " Class" & @CRLF)
+
+ ; Add hierearchy info if necessary. Some cool ASCII drawing is going on !
+ If $ParentClass <> "ROOT" Then
+ FileWrite($Output, "" & @CRLF)
+ FileWrite($Output, "Inheritance : The " & $TypeName & " Class inherits from the following parents :" & @CRLF)
+ Local $Hierarchy = GetParents($TypeName)
+ Local $String = ""
+ Local $TabBuffer = @TAB
+ $String &= $Hierarchy[0]&@CRLF
+ For $i=1 to UBound($Hierarchy)-1
+ $String &= $TabBuffer&"`-- "&$Hierarchy[$i]&@CRLF
+ $TabBuffer &= @TAB
+ Next
+ FileWrite($Output, $String)
+ FileWrite($Output, "
" & @CRLF)
+ Else
+ FileWrite($Output, "" & @CRLF)
+ FileWrite($Output, "The " & $TypeName & " class does not inherit" & @CRLF)
+ FileWrite($Output, "
" & @CRLF)
+ EndIf
+
+ ; Copy the long description
+ Local $DataPos = 1
+ Local $Data = ""
+ Local $Omit = False
+
+ While StringRight($Data, 1) <> @CR ; We discard the first line
+ $Data &= StringMid($Block, $DataPos, 1)
+ $DataPos += 1
+ WEnd
+ ; If there is a tag in the first line, there is no description
+ if StringInStr($Data, "@type") == 0 and StringInStr($Data, "@extends") == 0 and StringInStr($Data, "@field") == 0 Then
+ $Data = ""
+ $DataPos += 1
+
+ While StringRight($Data, 5) <> "@type"
+ $Data &= StringMid($Block, $DataPos, 1)
+ $DataPos += 1
+ WEnd
+ $Data = StringTrimRight($Data, 5)
+ FileWrite($Output, $Data & @CRLF)
+ EndIf
+
+ ; Add the Attributes
+ If IsArray($Fields) Then
+ FileWrite($Output, " Attributes
" & @CRLF & @CRLF)
+ FileWrite($Output, ArrayToList($Fields, False) & @CRLF)
+ EndIf
+ FileWrite($Output, @CRLF)
+ Return $TypeName
+EndFunc
+
+
+
+Func WriteFunction($Block, $Declaration, $Output)
+ Local $RegexResult = ParseFunctionName($Block, $Declaration)
+ Local $FunctionName = $RegexResult[0]
+ Local $TypeName = $RegexResult[1]
+ Local $Parameters = ParseParams($Block, $Declaration)
+ Local $Returns = ParseForTags($Block, "@return")
+ Local $Usage = ParseForOneTag($Block, "@usage")
+ Local $RegexResult
+
+ FileWrite($Log, "Writing Function "&$FunctionName&@CRLF)
+
+ If StringLeft($FunctionName, 1) == "_" Then
+ _FileWriteLog($Log, @TAB&@Tab&"Function is private. Ignored." & @CRLF)
+ Return $FunctionName
+ EndIf
+ ; Add the class before the function name
+ If IsArray($Parameters) Then
+ If $Parameters[1] == "self" Then
+ $FunctionName = $TypeName & ":" & $FunctionName
+ EndIf
+ Else
+ $FunctionName = $TypeName & "." & $FunctionName
+ EndIf
+
+ ; add the parameters in parenthesis
+ $FunctionName &= "("
+ If IsArray($Parameters) Then
+ For $i = 3 To UBound($Parameters) - 3 Step 3
+ $FunctionName &= $Parameters[$i + 1] & ", "
+ Next
+ If UBound($Parameters) > 3 Then
+ $FunctionName = StringTrimRight($FunctionName, 2)
+ EndIf
+ EndIf
+ $FunctionName &= ")"
+
+ ;write the file name
+ FileWrite($Output, "### " & $FunctionName & @CRLF)
+
+ ;Write the exemple if any
+ If $Usage <> "" Then
+ FileWrite($Output, "``` lua")
+ FileWrite($Output, $Usage)
+ FileWrite($Output, "```" & @CRLF)
+ EndIf
+
+ ;Write the description
+ FileWrite($Log, $Block)
+ FileWrite($Log, StringTrimRight($Block, StringLen($Block) - StringInStr($Block, "@param") + 1) & @CRLF)
+ FileWrite($Output, StringTrimRight($Block, StringLen($Block) - StringInStr($Block, "@param") + 1) & @CRLF)
+
+ ; Write the parameters
+ FileWrite($Output, " Parameters
" & @CRLF)
+ If IsArray($Parameters) Then
+ FileWrite($Output, ArrayToList($Parameters, False) & @CRLF)
+ EndIf
+
+ ; Write the returns
+ FileWrite($Output, " Returns
" & @CRLF)
+ If IsArray($Returns) Then
+ FileWrite($Output, ArrayToList($Returns, True) & @CRLF)
+ EndIf
+
+ FileWrite($Output, @CRLF)
+
+ ; add to the list of function balises (useful for hyperlinks)
+ $RegexResult = ParseFunctionName($Block, $Declaration)
+ Local $URLBalise = $TypeName & "-" & $RegexResult[0] & "-"
+ If IsArray($Parameters) Then
+ For $i = 3 To UBound($Parameters) - 3 Step 3
+ $URLBalise &= StringLower($Parameters[$i + 1]) & "-"
+ Next
+ EndIf
+ $URLBalise = StringTrimRight($URLBalise, 1)
+ FileWrite($FunctionList, $URLBalise & @CRLF)
+ return $FunctionName
+EndFunc
\ No newline at end of file
diff --git a/docs/Documentation/AI_Patrol.html b/docs/Documentation/AI_Patrol.html
index 21275d1d5..da3a39afb 100644
--- a/docs/Documentation/AI_Patrol.html
+++ b/docs/Documentation/AI_Patrol.html
@@ -951,6 +951,9 @@ Use the method AIPATROLZONE.M
+
+ This table contains the targets detected during patrol.
+
diff --git a/docs/Documentation/CommandCenter.html b/docs/Documentation/CommandCenter.html
index 99e1f3291..7b2d84919 100644
--- a/docs/Documentation/CommandCenter.html
+++ b/docs/Documentation/CommandCenter.html
@@ -251,24 +251,60 @@
| REPORT:Add(Text) |
Add a new line to a REPORT.
+ |
+
+
+ | REPORT:AddIndent(Text) |
+
+ Add a new line to a REPORT.
|
| REPORT.ClassName |
+ |
+
+
+ | REPORT:HasText() |
+
+ Has the REPORT Text?
+ |
+
+
+ | REPORT.Indent |
+
+
|
| REPORT:New(Title) |
Create a new REPORT.
+ |
+
+
+ | REPORT.Report |
+
+
+ |
+
+
+ | REPORT:SetIndent(Indent) |
+
+ Set indent of a REPORT.
|
| REPORT:Text(Delimiter) |
Produces the text of the report, taking into account an optional delimeter, which is \n by default.
+ |
+
+
+ | REPORT.Title |
+
+
|
@@ -765,6 +801,32 @@ Group#GROUP
#REPORT:
+
+
+
+-
+
+
+REPORT:AddIndent(Text)
+
+
+-
+
+
Add a new line to a REPORT.
+
+ Parameter
+
+ -
+
+
#string Text :
+
+
+
+ Return value
+
+#REPORT:
+
+
@@ -779,6 +841,38 @@ Group#GROUP
+
+
+
+-
+
+
+REPORT:HasText()
+
+
+-
+
+
Has the REPORT Text?
+
+ Return value
+
+#boolean:
+
+
+
+
+
+-
+
+
+
+REPORT.Indent
+
+
+-
+
+
+
@@ -805,6 +899,46 @@ Group#GROUP
#REPORT:
+
+
+
+-
+
+
+
+REPORT.Report
+
+
+-
+
+
+
+
+
+
+-
+
+
+REPORT:SetIndent(Indent)
+
+
+-
+
+
Set indent of a REPORT.
+
+ Parameter
+
+ -
+
+
#number Indent :
+
+
+
+ Return value
+
+#REPORT:
+
+
@@ -832,6 +966,20 @@ Group#GROUP
#string:
The report text.
+
+
+
+-
+
+
+
+REPORT.Title
+
+
+-
+
+
+
diff --git a/docs/Documentation/Controllable.html b/docs/Documentation/Controllable.html
index 5b025cdc7..ad27bec5c 100644
--- a/docs/Documentation/Controllable.html
+++ b/docs/Documentation/Controllable.html
@@ -382,7 +382,7 @@ This is different from the EnRoute tasks, where the targets of the task need to
- | CONTROLLABLE:IsTargetDetected(DCSObject) |
+ CONTROLLABLE:IsTargetDetected(DCSObject, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK) |
|
@@ -1466,19 +1466,49 @@ WayPoints If WayPoints is given, then return the WayPoints structure.
-CONTROLLABLE:IsTargetDetected(DCSObject)
+CONTROLLABLE:IsTargetDetected(DCSObject, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)
- Parameter
+ Parameters
-
DCSObject :
+
+ -
+
+
DetectVisual :
+
+
+ -
+
+
DetectOptical :
+
+
+ -
+
+
DetectRadar :
+
+
+ -
+
+
DetectIRST :
+
+
+ -
+
+
DetectRWR :
+
+
+ -
+
+
DetectDLINK :
+
diff --git a/docs/Documentation/Database.html b/docs/Documentation/Database.html
index e43251af7..bdaa3f280 100644
--- a/docs/Documentation/Database.html
+++ b/docs/Documentation/Database.html
@@ -326,6 +326,12 @@ The following iterator methods are currently available within the DATABASE:
DATABASE:ForEachPlayerJoined(IteratorFunction, ...) |
Iterate the DATABASE and call an iterator function for each player who has joined the mission, providing the Unit of the player and optional parameters.
+ |
+
+
+ | DATABASE:ForEachStatic(IteratorFunction, FinalizeFunction, ...) |
+
+ Iterate the DATABASE and call an iterator function for each alive STATIC, providing the STATIC and optional parameters.
|
@@ -1279,6 +1285,43 @@ self
-
+
+DATABASE:ForEachStatic(IteratorFunction, FinalizeFunction, ...)
+
+
+-
+
+
Iterate the DATABASE and call an iterator function for each alive STATIC, providing the STATIC and optional parameters.
+
+ Parameters
+
+ Return value
+
+#DATABASE:
+self
+
+
+
+
+-
+
DATABASE:ForEachUnit(IteratorFunction, FinalizeFunction, ...)
diff --git a/docs/Documentation/Designate.html b/docs/Documentation/Designate.html
index 9854fc628..0b38068a2 100644
--- a/docs/Documentation/Designate.html
+++ b/docs/Documentation/Designate.html
@@ -279,7 +279,7 @@ each detected set of potential targets can be lased or smoked...
- | DESIGNATE:MenuStatus(AttackGroup) |
+ DESIGNATE:MenuStatus(AttackGroup, Duration) |
|
@@ -375,7 +375,7 @@ each detected set of potential targets can be lased or smoked...
- | DESIGNATE:SendStatus(AttackGroup, MenuAttackGroup) |
+ DESIGNATE:SendStatus(AttackGroup, Duration, MenuAttackGroup) |
Sends the status to the Attack Groups.
|
@@ -1065,19 +1065,24 @@ function below will use the range 1-7 just in case
- Parameter
+ Parameters
-
AttackGroup :
+
+ -
+
+
Duration :
+
@@ -1556,7 +1561,7 @@ The Attack collection of GROUP objects to designate and report for.
-DESIGNATE:SendStatus(AttackGroup, MenuAttackGroup)
+DESIGNATE:SendStatus(AttackGroup, Duration, MenuAttackGroup)
@@ -1572,6 +1577,12 @@ The Attack collection of GROUP objects to designate and report for.
+#number Duration :
+The time in seconds the report should be visible.
+
+
+
+
MenuAttackGroup :
diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html
index af236b70d..73f24c75d 100644
--- a/docs/Documentation/Detection.html
+++ b/docs/Documentation/Detection.html
@@ -192,6 +192,12 @@ DETECTION uses the in-built detection capabilities of DCS World, but adds new fu
DETECTION_AREAS:CreateDetectionItems() |
Make a DetectionSet table.
+ |
+
+
+ | DETECTION_AREAS:DetectedItemMenu(Index) |
+
+ Menu of a detected item using a given numeric index.
|
@@ -204,6 +210,12 @@ DETECTION uses the in-built detection capabilities of DCS World, but adds new fu
| DETECTION_AREAS.DetectedItems |
A list of areas containing the set of Units, Zones, the center Unit within the zone, and ID of each area that was detected within a DetectionZoneRange.
+ |
+
+
+ | DETECTION_AREAS:DetectedReportDetailed() |
+
+ Report detailed of a detection result.
|
@@ -331,7 +343,7 @@ DETECTION uses the in-built detection capabilities of DCS World, but adds new fu
- | DETECTION_BASE:AddDetectedItem(DetectedItemIndex, Set) |
+ DETECTION_BASE:AddDetectedItem(ItemPrefix, DetectedItemIndex, Set) |
Adds a new DetectedItem to the DetectedItems list.
|
@@ -424,6 +436,12 @@ DETECTION uses the in-built detection capabilities of DCS World, but adds new fu
DETECTION_BASE.DetectedItemMax |
+ |
+
+
+ | DETECTION_BASE:DetectedItemMenu(Index) |
+
+ Menu of a detected item using a given numeric index.
|
@@ -513,12 +531,24 @@ The different values of Unit.Category can be:
Multiple Unit.Category entries can be given as a table and then these will be evaluated as an OR expression.
+
+
+
+ | DETECTION_BASE:GetDetectedID(Index) |
+
+ Get a detected ID using a given numeric index.
|
| DETECTION_BASE:GetDetectedItem(Index) |
Get a detected item using a given numeric index.
+ |
+
+
+ | DETECTION_BASE:GetDetectedItemID(Index) |
+
+ Get a detected ItemID using a given numeric index.
|
@@ -905,6 +935,42 @@ The different values of Unit.Category can be:
| DETECTION_BASE.DetectedObject.Identified |
+ |
+
+
+ | DETECTION_BASE.DetectedObject.IsVisible |
+
+
+ |
+
+
+ | DETECTION_BASE.DetectedObject.KnowDistance |
+
+
+ |
+
+
+ | DETECTION_BASE.DetectedObject.KnowType |
+
+
+ |
+
+
+ | DETECTION_BASE.DetectedObject.LastPos |
+
+
+ |
+
+
+ | DETECTION_BASE.DetectedObject.LastTime |
+
+
+ |
+
+
+ | DETECTION_BASE.DetectedObject.LastVelocity |
+
+
|
@@ -917,12 +983,6 @@ The different values of Unit.Category can be:
| DETECTION_BASE.DetectedObject.Type |
- |
-
-
- | DETECTION_BASE.DetectedObject.Visible |
-
-
|
@@ -939,6 +999,12 @@ The different values of Unit.Category can be:
DETECTION_TYPES:CreateDetectionItems() |
Create the DetectedItems list from the DetectedObjects table.
+ |
+
+
+ | DETECTION_TYPES:DetectedItemMenu(Index, DetectedTypeName) |
+
+ Menu of a DetectedItem using a given numeric index.
|
@@ -1015,6 +1081,12 @@ The different values of Unit.Category can be:
| DETECTION_UNITS:CreateDetectionItems() |
Create the DetectedItems list from the DetectedObjects table.
+ |
+
+
+ | DETECTION_UNITS:DetectedItemMenu(Index) |
+
+ Menu of a DetectedItem using a given numeric index.
|
@@ -1476,6 +1548,32 @@ self
#DETECTION_AREAS:
self
+
+
+
+-
+
+
+
+-
+
+
Menu of a detected item using a given numeric index.
+
+ Parameter
+
+ Return value
+
+#string:
+
+
@@ -1516,6 +1614,24 @@ self
A list of areas containing the set of Units, Zones, the center Unit within the zone, and ID of each area that was detected within a DetectionZoneRange.
+
+
+
+-
+
+
+DETECTION_AREAS:DetectedReportDetailed()
+
+
+-
+
+
Report detailed of a detection result.
+
+ Return value
+
+#string:
+
+
@@ -1944,7 +2060,7 @@ self
-
-DETECTION_BASE:AddDetectedItem(DetectedItemIndex, Set)
+DETECTION_BASE:AddDetectedItem(ItemPrefix, DetectedItemIndex, Set)
-
@@ -1958,6 +2074,11 @@ self
+
+
+-
+
+
+
+-
+
+
Menu of a detected item using a given numeric index.
+
+ Parameter
+
+ Return value
+
+#string:
+
+
@@ -2468,6 +2615,32 @@ self
-
+
+DETECTION_BASE:GetDetectedID(Index)
+
+
+-
+
+
Get a detected ID using a given numeric index.
+
+ Parameter
+
+ -
+
+
#number Index :
+
+
+
+ Return value
+
+#string:
+DetectedItemID
+
+
+
+
+-
+
DETECTION_BASE:GetDetectedItem(Index)
@@ -2489,6 +2662,32 @@ self
#DETECTION_BASE.DetectedItem:
+
+
+
+-
+
+
+DETECTION_BASE:GetDetectedItemID(Index)
+
+
+-
+
+
Get a detected ItemID using a given numeric index.
+
+ Parameter
+
+ -
+
+
#number Index :
+
+
+
+ Return value
+
+#string:
+DetectedItemID
+
@@ -4061,6 +4260,90 @@ The To State string.
+
+
+
+-
+
+ #boolean
+
+DETECTION_BASE.DetectedObject.IsVisible
+
+
+-
+
+
+
+
+
+
+-
+
+ #boolean
+
+DETECTION_BASE.DetectedObject.KnowDistance
+
+
+-
+
+
+
+
+
+
+-
+
+ #boolean
+
+DETECTION_BASE.DetectedObject.KnowType
+
+
+-
+
+
+
+
+
+
+-
+
+ #boolean
+
+DETECTION_BASE.DetectedObject.LastPos
+
+
+-
+
+
+
+
+
+
+-
+
+ #number
+
+DETECTION_BASE.DetectedObject.LastTime
+
+
+-
+
+
+
+
+
+
+-
+
+ #number
+
+DETECTION_BASE.DetectedObject.LastVelocity
+
+
+-
+
+
+
@@ -4089,20 +4372,6 @@ The To State string.
-
-
-
--
-
- #boolean
-
-DETECTION_BASE.DetectedObject.Visible
-
-
--
-
-
-
@@ -4154,6 +4423,37 @@ Beware that when the amount of different types detected is large, the DetectedIt
#DETECTION_TYPES:
self
+
+
+
+-
+
+
+
+-
+
+
Menu of a DetectedItem using a given numeric index.
+
+ Parameters
+
+ -
+
+
Index :
+
+
+ -
+
+
DetectedTypeName :
+
+
+
+ Return value
+
+#string:
+
+
@@ -4389,6 +4689,32 @@ Beware that when the amount of units detected is large, the DetectedItems list w
#DETECTION_UNITS:
self
+
+
+
+-
+
+
+
+-
+
+
Menu of a DetectedItem using a given numeric index.
+
+ Parameter
+
+ Return value
+
+#string:
+
+
diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html
index 425da196e..eb52982ac 100644
--- a/docs/Documentation/Fsm.html
+++ b/docs/Documentation/Fsm.html
@@ -1622,7 +1622,7 @@ A string defining the start state.
-
- #string
+
FSM._StartState
@@ -1921,6 +1921,7 @@ A string defining the start state.
-
+
FSM.current
diff --git a/docs/Documentation/Mission.html b/docs/Documentation/Mission.html
index 5cf8ca5d8..96f09fc56 100644
--- a/docs/Documentation/Mission.html
+++ b/docs/Documentation/Mission.html
@@ -167,7 +167,7 @@ A CLIENT needs to be registered within the MISSION:GetMenu(TaskGroup)
+
| MISSION:GetMenu() |
Gets the mission menu for the coalition.
|
@@ -200,6 +200,12 @@ A CLIENT needs to be registered within the MISSION:GetTasks()
Get all the TASKs from the Mission.
+ |
+
+
+ | MISSION:GetTasksRemaining() |
+
+
|
@@ -209,39 +215,51 @@ A CLIENT needs to be registered within the MISSION:IsCompleted()
+ | MISSION:IsCOMPLETED() |
- Is the Mission Completed.
+Is the Mission COMPLETED.
|
- | MISSION:IsFailed() |
+ MISSION:IsENGAGED() |
- Is the Mission Failed.
+Is the Mission ENGAGED.
|
- | MISSION:IsHold() |
+ MISSION:IsFAILED() |
- Is the Mission Hold.
+Is the Mission FAILED.
|
- | MISSION:IsIdle() |
+ MISSION:IsHOLD() |
- Is the Mission Idle.
+Is the Mission HOLD.
|
- | MISSION:IsOngoing() |
+ MISSION:IsIDLE() |
- Is the Mission Ongoing.
+Is the Mission IDLE.
|
| MISSION:JoinUnit(PlayerUnit, PlayerGroup) |
Add a Unit to join the Mission.
+ |
+
+
+ | MISSION:MenuReportOverview(TaskStatus, ReportGroup) |
+
+
+ |
+
+
+ | MISSION:MenuReportSummary(ReportGroup) |
+
+
|
@@ -323,51 +341,51 @@ A CLIENT needs to be registered within the MISSION:OnEnterCompleted(From, Event, To)
+ | MISSION:OnEnterCOMPLETED(From, Event, To) |
- OnEnter Transition Handler for State Completed.
+OnEnter Transition Handler for State COMPLETED.
|
- | MISSION:OnEnterFailed(From, Event, To) |
+ MISSION:OnEnterENGAGED(From, Event, To) |
- OnEnter Transition Handler for State Failed.
+OnEnter Transition Handler for State ENGAGED.
|
- | MISSION:OnEnterIdle(From, Event, To) |
+ MISSION:OnEnterFAILED(From, Event, To) |
- OnEnter Transition Handler for State Idle.
+OnEnter Transition Handler for State FAILED.
|
- | MISSION:OnEnterOngoing(From, Event, To) |
+ MISSION:OnEnterIDLE(From, Event, To) |
- OnEnter Transition Handler for State Ongoing.
+OnEnter Transition Handler for State IDLE.
|
- | MISSION:OnLeaveCompleted(From, Event, To) |
+ MISSION:OnLeaveCOMPLETED(From, Event, To) |
- OnLeave Transition Handler for State Completed.
+OnLeave Transition Handler for State COMPLETED.
|
- | MISSION:OnLeaveFailed(From, Event, To) |
+ MISSION:OnLeaveENGAGED(From, Event, To) |
- OnLeave Transition Handler for State Failed.
+OnLeave Transition Handler for State ENGAGED.
|
- | MISSION:OnLeaveIdle(From, Event, To) |
+ MISSION:OnLeaveFAILED(From, Event, To) |
- OnLeave Transition Handler for State Idle.
+OnLeave Transition Handler for State FAILED.
|
- | MISSION:OnLeaveOngoing(From, Event, To) |
+ MISSION:OnLeaveIDLE(From, Event, To) |
- OnLeave Transition Handler for State Ongoing.
+OnLeave Transition Handler for State IDLE.
|
@@ -395,7 +413,7 @@ A CLIENT needs to be registered within the MISSION:ReportOverview()
+ | MISSION:ReportOverview(TaskStatus) |
Create a overview report of the Mission (multiple lines).
|
@@ -467,7 +485,7 @@ A CLIENT needs to be registered within the MISSION:onenterCompleted(From, Event, To)
+ MISSION:onenterCOMPLETED(From, Event, To) |
|
@@ -697,21 +715,13 @@ true if Unit is part of a Task in the Mission.
Gets the mission menu for the coalition.
- Parameter
-
Return value
Core.Menu#MENU_COALITION:
@@ -851,6 +861,24 @@ Returns nil if no task was found.
Tasks = Mission:GetTasks()
env.info( "Task 2 Completion = " .. Tasks[2]:GetGoalPercentage() .. "%" )
+
+
+
+-
+
+
+MISSION:GetTasksRemaining()
+
+
+-
+
+
+
+
Return value
+
+#number:
+
+
@@ -893,13 +921,13 @@ true if the Mission has a Group.
-
-
-MISSION:IsCompleted()
+
+MISSION:IsCOMPLETED()
-
-
Is the Mission Completed.
+Is the Mission COMPLETED.
Return value
@@ -911,13 +939,13 @@ true if the Mission has a Group.
-
-
-MISSION:IsFailed()
+
+MISSION:IsENGAGED()
-
-
Is the Mission Failed.
+Is the Mission ENGAGED.
Return value
@@ -929,13 +957,13 @@ true if the Mission has a Group.
-
-
-MISSION:IsHold()
+
+MISSION:IsFAILED()
-
-
Is the Mission Hold.
+Is the Mission FAILED.
Return value
@@ -947,13 +975,13 @@ true if the Mission has a Group.
-
-
-MISSION:IsIdle()
+
+MISSION:IsHOLD()
-
-
Is the Mission Idle.
+Is the Mission HOLD.
Return value
@@ -965,13 +993,13 @@ true if the Mission has a Group.
-
-
-MISSION:IsOngoing()
+
+MISSION:IsIDLE()
-
-
Is the Mission Ongoing.
+Is the Mission IDLE.
Return value
@@ -1016,6 +1044,54 @@ The GROUP of the player joining the Mission.
#boolean:
true if Unit is part of a Task in the Mission.
+
+
+
+-
+
+
+
+-
+
+
+
+
Parameters
+
+
+
+
+-
+
+
+
+-
+
+
+
+
Parameter
+
@@ -1422,13 +1498,13 @@ Return false to cancel Transition.
-
-
-MISSION:OnEnterCompleted(From, Event, To)
+
+MISSION:OnEnterCOMPLETED(From, Event, To)
-
-
OnEnter Transition Handler for State Completed.
+OnEnter Transition Handler for State COMPLETED.
Parameters
@@ -1456,13 +1532,13 @@ The To State string.
-
-
-MISSION:OnEnterFailed(From, Event, To)
+
+MISSION:OnEnterENGAGED(From, Event, To)
-
-
OnEnter Transition Handler for State Failed.
+OnEnter Transition Handler for State ENGAGED.
Parameters
@@ -1490,13 +1566,13 @@ The To State string.
-
-
-MISSION:OnEnterIdle(From, Event, To)
+
+MISSION:OnEnterFAILED(From, Event, To)
-
-
OnEnter Transition Handler for State Idle.
+OnEnter Transition Handler for State FAILED.
Parameters
@@ -1524,13 +1600,13 @@ The To State string.
-
-
-MISSION:OnEnterOngoing(From, Event, To)
+
+MISSION:OnEnterIDLE(From, Event, To)
-
-
OnEnter Transition Handler for State Ongoing.
+OnEnter Transition Handler for State IDLE.
Parameters
@@ -1558,13 +1634,13 @@ The To State string.
-
-
-MISSION:OnLeaveCompleted(From, Event, To)
+
+MISSION:OnLeaveCOMPLETED(From, Event, To)
-
-
OnLeave Transition Handler for State Completed.
+OnLeave Transition Handler for State COMPLETED.
Parameters
@@ -1597,13 +1673,13 @@ Return false to cancel Transition.
-
-
-MISSION:OnLeaveFailed(From, Event, To)
+
+MISSION:OnLeaveENGAGED(From, Event, To)
-
-
OnLeave Transition Handler for State Failed.
+OnLeave Transition Handler for State ENGAGED.
Parameters
@@ -1636,13 +1712,13 @@ Return false to cancel Transition.
-
-
-MISSION:OnLeaveIdle(From, Event, To)
+
+MISSION:OnLeaveFAILED(From, Event, To)
-
-
OnLeave Transition Handler for State Idle.
+OnLeave Transition Handler for State FAILED.
Parameters
@@ -1675,13 +1751,13 @@ Return false to cancel Transition.
-
-
-MISSION:OnLeaveOngoing(From, Event, To)
+
+MISSION:OnLeaveIDLE(From, Event, To)
-
-
OnLeave Transition Handler for State Ongoing.
+OnLeave Transition Handler for State IDLE.
Parameters
@@ -548,6 +564,20 @@ Return true if you want the task assigning to continue... false will cancel the
The groups to which the FAC will report to.
+
+
+
+-
+
+
+
+TASK_A2G_DISPATCHER.Tasks
+
+
+-
+
+
+
diff --git a/docs/Documentation/Utils.html b/docs/Documentation/Utils.html
index b129e87db..406805680 100644
--- a/docs/Documentation/Utils.html
+++ b/docs/Documentation/Utils.html
@@ -299,6 +299,12 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
UTILS.tostringLL(lat, lon, acc, DMS) |
+ |
+
+
+ | UTILS.tostringMGRS(MGRS, acc) |
+
+
|
@@ -867,6 +873,35 @@ So:
+
+
+-
+
+
+UTILS.tostringMGRS(MGRS, acc)
+
+
+-
+
+
+
+
+
acc- the accuracy of each easting/northing. 0, 1, 2, 3, 4, or 5.
+
+ Parameters
+
+ -
+
+
MGRS :
+
+
+ -
+
+
acc :
+
+
+
+
diff --git a/docs/Documentation/Zone.html b/docs/Documentation/Zone.html
index f620a9c0c..b9f59126b 100644
--- a/docs/Documentation/Zone.html
+++ b/docs/Documentation/Zone.html
@@ -252,6 +252,12 @@
ZONE_BASE:GetBoundingSquare() |
Get the bounding square the zone.
+ |
+
+
+ | ZONE_BASE:GetCoordinate(Height) |
+
+ Returns a Point#COORDINATE of the zone.
|
@@ -933,6 +939,33 @@ The bounding square.
-
+
+ZONE_BASE:GetCoordinate(Height)
+
+
+-
+
+
Returns a Point#COORDINATE of the zone.
+
+ Parameter
+
+ Return value
+
+Core.Point#COORDINATE:
+The Coordinate of the zone.
+
+
+
+
+-
+
ZONE_BASE:GetName()