From 5c9e3570e2dd46070a7e4ccfe80b9860d1364f28 Mon Sep 17 00:00:00 2001 From: kaltokri Date: Sun, 29 Oct 2023 19:43:55 +0100 Subject: [PATCH 1/6] Added more docker jobs and apply same naming convention as build jobs --- .../Dockerfile | 2 +- .../docker-compose.yml | 0 .../{moose-build-docs => build-docs}/start.sh | 0 docker/build-includes/Dockerfile | 10 ++++++++++ docker/build-includes/docker-compose.yml | 14 +++++++++++++ docker/build-includes/start.sh | 20 +++++++++++++++++++ docker/gh-pages-check/Dockerfile | 4 ++++ docker/gh-pages-check/docker-compose.yml | 17 ++++++++++++++++ docker/gh-pages/Dockerfile | 12 +++++++++++ docker/gh-pages/docker-compose.yml | 14 +++++++++++++ 10 files changed, 92 insertions(+), 1 deletion(-) rename docker/{moose-build-docs => build-docs}/Dockerfile (94%) rename docker/{moose-build-docs => build-docs}/docker-compose.yml (100%) rename docker/{moose-build-docs => build-docs}/start.sh (100%) create mode 100644 docker/build-includes/Dockerfile create mode 100644 docker/build-includes/docker-compose.yml create mode 100644 docker/build-includes/start.sh create mode 100644 docker/gh-pages-check/Dockerfile create mode 100644 docker/gh-pages-check/docker-compose.yml create mode 100644 docker/gh-pages/Dockerfile create mode 100644 docker/gh-pages/docker-compose.yml diff --git a/docker/moose-build-docs/Dockerfile b/docker/build-docs/Dockerfile similarity index 94% rename from docker/moose-build-docs/Dockerfile rename to docker/build-docs/Dockerfile index 839828c60..6fd7007ff 100644 --- a/docker/moose-build-docs/Dockerfile +++ b/docker/build-docs/Dockerfile @@ -10,4 +10,4 @@ RUN luarocks install metalua-compiler 0.7.3-1 RUN luarocks install metalua-parser 0.7.3-2 RUN luarocks install checks COPY start.sh /start.sh -RUN chmod +x /start.sh \ No newline at end of file +RUN chmod +x /start.sh diff --git a/docker/moose-build-docs/docker-compose.yml b/docker/build-docs/docker-compose.yml similarity index 100% rename from docker/moose-build-docs/docker-compose.yml rename to docker/build-docs/docker-compose.yml diff --git a/docker/moose-build-docs/start.sh b/docker/build-docs/start.sh similarity index 100% rename from docker/moose-build-docs/start.sh rename to docker/build-docs/start.sh diff --git a/docker/build-includes/Dockerfile b/docker/build-includes/Dockerfile new file mode 100644 index 000000000..2c72a7996 --- /dev/null +++ b/docker/build-includes/Dockerfile @@ -0,0 +1,10 @@ +FROM nickblah/lua:5.3-luarocks-ubuntu + +RUN apt-get -qq update +RUN apt-get -qq install tree +RUN apt-get -qq install build-essential +RUN apt-get -qq install git +RUN luarocks install luasrcdiet +RUN luarocks install luacheck +COPY start.sh /start.sh +RUN chmod +x /start.sh diff --git a/docker/build-includes/docker-compose.yml b/docker/build-includes/docker-compose.yml new file mode 100644 index 000000000..e994882fc --- /dev/null +++ b/docker/build-includes/docker-compose.yml @@ -0,0 +1,14 @@ +version: "3.5" + +services: + moose-build-includes: + image: moose/build-includes + build: + context: . + dockerfile: Dockerfile + container_name: moose-build-includes + volumes: + - ../../:/moose + stdin_open: true + tty: true + command: /bin/bash -c /start.sh diff --git a/docker/build-includes/start.sh b/docker/build-includes/start.sh new file mode 100644 index 000000000..10b29231e --- /dev/null +++ b/docker/build-includes/start.sh @@ -0,0 +1,20 @@ +#!/bin/bash + +# Prepare environment +cd /moose/ +mkdir -p build/result/Moose_Include_Dynamic +mkdir -p build/result/Moose_Include_Static + +GIT_SHA=$(git rev-parse HEAD) +GIT_SHA=$(echo $GIT_SHA|tr -d '\n') +COMMIT_TIME=$(date +%Y-%m-%dT%H:%M:%S) + +# Create Includes +lua "./Moose Setup/Moose_Create.lua" S "$COMMIT_TIME-$GIT_SHA" "./Moose Development/Moose" "./Moose Setup" "./build/result/Moose_Include_Static" +lua "./Moose Setup/Moose_Create.lua" D "$COMMIT_TIME-$GIT_SHA" "./Moose Development/Moose" "./Moose Setup" "./build/result/Moose_Include_Dynamic" + +# Create Moose_.lua +luasrcdiet --basic --opt-emptylines ./build/result/Moose_Include_Static/Moose.lua -o ./build/result/Moose_Include_Static/Moose_.lua + +# Run luacheck +luacheck --std=lua51c --config=.luacheckrc -gurasqq "Moose Development/Moose" diff --git a/docker/gh-pages-check/Dockerfile b/docker/gh-pages-check/Dockerfile new file mode 100644 index 000000000..282c600dd --- /dev/null +++ b/docker/gh-pages-check/Dockerfile @@ -0,0 +1,4 @@ +FROM node:latest + +WORKDIR /usr/app +RUN npm install linkinator \ No newline at end of file diff --git a/docker/gh-pages-check/docker-compose.yml b/docker/gh-pages-check/docker-compose.yml new file mode 100644 index 000000000..30035ba8e --- /dev/null +++ b/docker/gh-pages-check/docker-compose.yml @@ -0,0 +1,17 @@ +version: "3.5" + +services: + moose-gh-pages-checks: + image: moose/gh-pages-checks + #image: node:latest + #image: joskfg/np + build: + context: . + dockerfile: Dockerfile + container_name: moose-gh-pages-checks + volumes: + - .:/moose + stdin_open: true + tty: true + #command: /bin/bash -c /moose/start.sh + command: npx linkinator https://flightcontrol-master.github.io/MOOSE/ diff --git a/docker/gh-pages/Dockerfile b/docker/gh-pages/Dockerfile new file mode 100644 index 000000000..a499513b2 --- /dev/null +++ b/docker/gh-pages/Dockerfile @@ -0,0 +1,12 @@ +FROM ruby:2.7 + +ENV LC_ALL C.UTF-8 +ENV LANG en_US.UTF-8 +ENV LANGUAGE en_US.UTF-8 + +WORKDIR /usr/src/app + +COPY Gemfile just-the-docs.gemspec ./ +RUN gem install bundler && bundle install + +EXPOSE 4000 diff --git a/docker/gh-pages/docker-compose.yml b/docker/gh-pages/docker-compose.yml new file mode 100644 index 000000000..26e978667 --- /dev/null +++ b/docker/gh-pages/docker-compose.yml @@ -0,0 +1,14 @@ +version: "3.5" + +services: + jekyll: + build: + context: ../../docs + dockerfile: ./Dockerfile + ports: + - 4000:4000 + volumes: + - ../../docs:/usr/src/app + stdin_open: true + tty: true + command: bundle exec jekyll serve -H 0.0.0.0 -t --force_polling From 0e2dff4e6b52294268203b146d2ef598a0440fa5 Mon Sep 17 00:00:00 2001 From: kaltokri Date: Sun, 29 Oct 2023 23:06:09 +0100 Subject: [PATCH 2/6] Fixed some dead links in Ops.Airboss --- Moose Development/Moose/Ops/Airboss.lua | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/Moose Development/Moose/Ops/Airboss.lua b/Moose Development/Moose/Ops/Airboss.lua index a1616b965..b9c544ad7 100644 --- a/Moose Development/Moose/Ops/Airboss.lua +++ b/Moose Development/Moose/Ops/Airboss.lua @@ -27,17 +27,17 @@ -- **Supported Carriers:** -- -- * [USS John C. Stennis](https://en.wikipedia.org/wiki/USS_John_C._Stennis) (CVN-74) --- * [USS Theodore Roosevelt](https://en.wikipedia.org/wiki/USS_Theodore_Roosevelt_(CVN-71\)) (CVN-71) [Super Carrier Module] --- * [USS Abraham Lincoln](https://en.wikipedia.org/wiki/USS_Abraham_Lincoln_(CVN-72\)) (CVN-72) [Super Carrier Module] --- * [USS George Washington](https://en.wikipedia.org/wiki/USS_George_Washington_(CVN-73\)) (CVN-73) [Super Carrier Module] +-- * [USS Theodore Roosevelt](https://en.wikipedia.org/wiki/USS_Theodore_Roosevelt_\(CVN-71\)) (CVN-71) [Super Carrier Module] +-- * [USS Abraham Lincoln](https://en.wikipedia.org/wiki/USS_Abraham_Lincoln_\(CVN-72\)) (CVN-72) [Super Carrier Module] +-- * [USS George Washington](https://en.wikipedia.org/wiki/USS_George_Washington_\(CVN-73\)) (CVN-73) [Super Carrier Module] -- * [USS Harry S. Truman](https://en.wikipedia.org/wiki/USS_Harry_S._Truman) (CVN-75) [Super Carrier Module] --- * [USS Forrestal](https://en.wikipedia.org/wiki/USS_Forrestal_(CV-59\)) (CV-59) [Heatblur Carrier Module] --- * [HMS Hermes](https://en.wikipedia.org/wiki/HMS_Hermes_(R12\)) (R12) --- * [HMS Invincible](https://en.wikipedia.org/wiki/HMS_Invincible_(R05\)) (R05) --- * [USS Tarawa](https://en.wikipedia.org/wiki/USS_Tarawa_(LHA-1\)) (LHA-1) --- * [USS America](https://en.wikipedia.org/wiki/USS_America_(LHA-6\)) (LHA-6) +-- * [USS Forrestal](https://en.wikipedia.org/wiki/USS_Forrestal_\(CV-59\)) (CV-59) [Heatblur Carrier Module] +-- * [HMS Hermes](https://en.wikipedia.org/wiki/HMS_Hermes_\(R12\)) (R12) +-- * [HMS Invincible](https://en.wikipedia.org/wiki/HMS_Invincible_\(R05\)) (R05) +-- * [USS Tarawa](https://en.wikipedia.org/wiki/USS_Tarawa_\(LHA-1\)) (LHA-1) +-- * [USS America](https://en.wikipedia.org/wiki/USS_America_\(LHA-6\)) (LHA-6) -- * [Juan Carlos I](https://en.wikipedia.org/wiki/Spanish_amphibious_assault_ship_Juan_Carlos_I) (L61) --- * [HMAS Canberra](https://en.wikipedia.org/wiki/HMAS_Canberra_(L02\)) (L02) +-- * [HMAS Canberra](https://en.wikipedia.org/wiki/HMAS_Canberra_\(L02\)) (L02) -- -- **Supported Aircraft:** -- @@ -45,7 +45,7 @@ -- * [F-14A/B Tomcat](https://forums.eagle.ru/forumdisplay.php?f=395) (Player & AI) -- * [A-4E Skyhawk Community Mod](https://forums.eagle.ru/showthread.php?t=224989) (Player & AI) -- * [AV-8B N/A Harrier](https://forums.eagle.ru/forumdisplay.php?f=555) (Player & AI) --- * [T-45C Goshawk](https://www.vnao-cvw-7.com/t-45-goshawk) (VNAO mod) (Player & AI) +-- * [T-45C Goshawk](https://forum.dcs.world/topic/203816-vnao-t-45-goshawk/) (VNAO mod) (Player & AI) -- * [FE/A-18E/F/G Superhornet](https://forum.dcs.world/topic/316971-cjs-super-hornet-community-mod-v20-official-thread/) (CJS mod) (Player & AI) -- * F/A-18C Hornet (AI) -- * F-14A Tomcat (AI) @@ -61,7 +61,7 @@ -- -- Heatblur's mighty F-14B Tomcat has been added (March 13th 2019) as well. Same goes for the A version. -- --- The [DCS Supercarriers](https://forums.eagle.ru/forum/151-dcs-supercarrier/) are also supported. +-- The [DCS Supercarriers](https://www.digitalcombatsimulator.com/de/shop/modules/supercarrier/) are also supported. -- -- ## Discussion -- From 92b21aa5c15803b29b226f3bd2dec3281048dffd Mon Sep 17 00:00:00 2001 From: kaltokri Date: Mon, 30 Oct 2023 14:48:49 +0100 Subject: [PATCH 3/6] Fixed broken links in documentation --- Moose Development/Moose/Core/Fsm.lua | 2 +- Moose Development/Moose/Core/Spawn.lua | 6 +++--- Moose Development/Moose/Functional/Artillery.lua | 4 ++-- Moose Development/Moose/Functional/Mantis.lua | 6 +++--- Moose Development/Moose/Functional/RAT.lua | 10 +++++----- Moose Development/Moose/Functional/Warehouse.lua | 6 +++--- Moose Development/Moose/Ops/Airboss.lua | 5 ----- Moose Development/Moose/Ops/CTLD.lua | 2 +- Moose Development/Moose/Ops/RescueHelo.lua | 2 -- Moose Development/Moose/Sound/SoundOutput.lua | 2 +- Moose Development/Moose/Tasking/DetectionManager.lua | 2 +- Moose Development/Moose/Tasking/Task_CARGO.lua | 11 +++++------ .../Moose/Tasking/Task_Cargo_Dispatcher.lua | 2 +- Moose Development/Moose/Wrapper/Airbase.lua | 2 +- Moose Development/Moose/Wrapper/Marker.lua | 2 -- 15 files changed, 27 insertions(+), 37 deletions(-) diff --git a/Moose Development/Moose/Core/Fsm.lua b/Moose Development/Moose/Core/Fsm.lua index 2b5f499e5..2580bd386 100644 --- a/Moose Development/Moose/Core/Fsm.lua +++ b/Moose Development/Moose/Core/Fsm.lua @@ -249,7 +249,7 @@ do -- FSM -- -- ### Linear Transition Example -- - -- This example is fully implemented in the MOOSE test mission on GITHUB: [FSM-100 - Transition Explanation](https://github.com/FlightControl-Master/MOOSE/blob/master/Moose%20Test%20Missions/FSM%20-%20Finite%20State%20Machine/FSM-100%20-%20Transition%20Explanation/FSM-100%20-%20Transition%20Explanation.lua) + -- This example is fully implemented in the MOOSE test mission on GITHUB: [FSM-100 - Transition Explanation](https://github.com/FlightControl-Master/MOOSE_MISSIONS/blob/master/FSM%20-%20Finite%20State%20Machine/FSM-100%20-%20Transition%20Explanation/FSM-100%20-%20Transition%20Explanation.lua) -- -- It models a unit standing still near Batumi, and flaring every 5 seconds while switching between a Green flare and a Red flare. -- The purpose of this example is not to show how exciting flaring is, but it demonstrates how a Linear Transition FSM can be build. diff --git a/Moose Development/Moose/Core/Spawn.lua b/Moose Development/Moose/Core/Spawn.lua index adcafc31f..052c7d152 100644 --- a/Moose Development/Moose/Core/Spawn.lua +++ b/Moose Development/Moose/Core/Spawn.lua @@ -1331,7 +1331,7 @@ do -- Delay methods return self end - --- Turns the Delay On for the @{Wrapper.Group} when spawning with @{SpawnScheduled}(). In effect then the 1st group will only be spawned + --- Turns the Delay On for the @{Wrapper.Group} when spawning with @{#SpawnScheduled}(). In effect then the 1st group will only be spawned -- after the number of seconds given in SpawnScheduled as arguments, and not immediately. -- @param #SPAWN self -- @return #SPAWN The SPAWN object @@ -1669,7 +1669,7 @@ end -- @param #number SpawnTimeVariation The variation to be applied on the defined time interval between each new spawn. -- The variation is a number between 0 and 1, representing the % of variation to be applied on the time interval. -- @param #boolean WithDelay Do not spawn the **first** group immediately, but delay the spawn as per the calculation below. --- Effectively the same as @{InitDelayOn}(). +-- Effectively the same as @{#InitDelayOn}(). -- @return #SPAWN self -- @usage -- -- NATO helicopters engaging in the battle field. @@ -3622,7 +3622,7 @@ function SPAWN:_OnLand( EventData ) end --- Will detect AIR Units shutting down their engines ... --- When the event takes place, and the method @{RepeatOnEngineShutDown} was called, the spawned Group will Re-SPAWN. +-- When the event takes place, and the method @{#InitRepeatOnEngineShutDown} was called, the spawned Group will Re-SPAWN. -- But only when the Unit was registered to have landed. -- @param #SPAWN self -- @param Core.Event#EVENTDATA EventData diff --git a/Moose Development/Moose/Functional/Artillery.lua b/Moose Development/Moose/Functional/Artillery.lua index 1a96ee165..df31fd196 100644 --- a/Moose Development/Moose/Functional/Artillery.lua +++ b/Moose Development/Moose/Functional/Artillery.lua @@ -291,14 +291,14 @@ -- ### Illumination Shells -- -- ARTY groups that possess shells can fire shells with illumination bombs. First, the group needs to be equipped with this weapon. This is done by the --- function @{ARTY.SetIlluminationShells}(*n*, *power*), where *n* is the number of shells the group has available and *power* the illumination power in mega candela (mcd). +-- function @{#ARTY.SetIlluminationShells}(*n*, *power*), where *n* is the number of shells the group has available and *power* the illumination power in mega candela (mcd). -- -- In order to execute an engagement with illumination shells one has to use the weapon type *ARTY.WeaponType.IlluminationShells* in the -- @{#ARTY.AssignTargetCoord}() function. -- -- In the simulation, the explosive shell that is fired is destroyed once it gets close to the target point but before it can actually impact. -- At this position an illumination bomb is triggered at a random altitude between 500 and 1000 meters. This interval can be set by the function --- @{ARTY.SetIlluminationMinMaxAlt}(*minalt*, *maxalt*). +-- @{#ARTY.SetIlluminationMinMaxAlt}(*minalt*, *maxalt*). -- -- ### Smoke Shells -- diff --git a/Moose Development/Moose/Functional/Mantis.lua b/Moose Development/Moose/Functional/Mantis.lua index 9bd80659b..72de47973 100644 --- a/Moose Development/Moose/Functional/Mantis.lua +++ b/Moose Development/Moose/Functional/Mantis.lua @@ -893,7 +893,7 @@ do --- Function to get the HQ object for further use -- @param #MANTIS self - -- @return Wrapper.GROUP#GROUP The HQ #GROUP object or *nil* if it doesn't exist + -- @return Wrapper.Group#GROUP The HQ #GROUP object or *nil* if it doesn't exist function MANTIS:GetCommandCenter() self:T(self.lid .. "GetCommandCenter") if self.HQ_CC then @@ -929,7 +929,7 @@ do --- Function to set the HQ object for further use -- @param #MANTIS self - -- @param Wrapper.GROUP#GROUP group The #GROUP object to be set as HQ + -- @param Wrapper.Group#GROUP group The #GROUP object to be set as HQ function MANTIS:SetCommandCenter(group) self:T(self.lid .. "SetCommandCenter") local group = group or nil @@ -991,7 +991,7 @@ do --- Set using your own #INTEL_DLINK object instead of #DETECTION -- @param #MANTIS self - -- @param Ops.Intelligence#INTEL_DLINK DLink The data link object to be used. + -- @param Ops.Intel#INTEL_DLINK DLink The data link object to be used. function MANTIS:SetUsingDLink(DLink) self:T(self.lid .. "SetUsingDLink") self.DLink = true diff --git a/Moose Development/Moose/Functional/RAT.lua b/Moose Development/Moose/Functional/RAT.lua index f5b262277..3f81559b7 100644 --- a/Moose Development/Moose/Functional/RAT.lua +++ b/Moose Development/Moose/Functional/RAT.lua @@ -225,7 +225,7 @@ -- -- * Landing: When an aircraft tries to land at an airport where it does not have a valid parking spot, it is immidiately despawned the moment its wheels touch the runway, i.e. -- when a landing event is triggered. This leads to the loss of the RAT aircraft. On possible way to circumvent the this problem is to let another RAT aircraft spawn at landing --- and not when it shuts down its engines. See the @{RAT.RespawnAfterLanding}() function. +-- and not when it shuts down its engines. See the @{#RAT.RespawnAfterLanding}() function. -- * Spawning: When a big aircraft is dynamically spawned on a small airbase a few things can go wrong. For example, it could be spawned at a parking spot with a shelter. -- Or it could be damaged by a scenery object when it is taxiing out to the runway, or it could overlap with other aircraft on parking spots near by. -- @@ -2474,11 +2474,11 @@ end -- @param #RAT self -- @param #number takeoff Takeoff type. Could also be air start. -- @param #number landing Landing type. Could also be a destination in air. --- @param Wrapper.Airport#AIRBASE _departure (Optional) Departure airbase. --- @param Wrapper.Airport#AIRBASE _destination (Optional) Destination airbase. +-- @param Wrapper.Airbase#AIRBASE _departure (Optional) Departure airbase. +-- @param Wrapper.Airbase#AIRBASE _destination (Optional) Destination airbase. -- @param #table _waypoint Initial waypoint. --- @return Wrapper.Airport#AIRBASE Departure airbase. --- @return Wrapper.Airport#AIRBASE Destination airbase. +-- @return Wrapper.Airbase#AIRBASE Departure airbase. +-- @return Wrapper.Airbase#AIRBASE Destination airbase. -- @return #table Table of flight plan waypoints. -- @return #nil If no valid departure or destination airport could be found. function RAT:_SetRoute(takeoff, landing, _departure, _destination, _waypoint) diff --git a/Moose Development/Moose/Functional/Warehouse.lua b/Moose Development/Moose/Functional/Warehouse.lua index 97222cd6f..8ce1752d0 100644 --- a/Moose Development/Moose/Functional/Warehouse.lua +++ b/Moose Development/Moose/Functional/Warehouse.lua @@ -742,7 +742,7 @@ -- -- ## Save Assets -- --- Saving asset data to file is achieved by the @{WAREHOUSE.Save}(*path*, *filename*) function. The parameter *path* specifies the path on the file system where the +-- Saving asset data to file is achieved by the @{#WAREHOUSE.Save}(*path*, *filename*) function. The parameter *path* specifies the path on the file system where the -- warehouse data is saved. If you do not specify a path, the file is saved your the DCS installation root directory. -- The parameter *filename* is optional and defines the name of the saved file. By default this is automatically created from the warehouse id and name, for example -- "Warehouse-1234_Batumi.txt". @@ -753,13 +753,13 @@ -- -- ### Automatic Save at Mission End -- --- The assets can be saved automatically when the mission is ended via the @{WAREHOUSE.SetSaveOnMissionEnd}(*path*, *filename*) function, i.e. +-- The assets can be saved automatically when the mission is ended via the @{#WAREHOUSE.SetSaveOnMissionEnd}(*path*, *filename*) function, i.e. -- -- warehouseBatumi:SetSaveOnMissionEnd("D:\\My Warehouse Data\\") -- -- ## Load Assets -- --- Loading assets data from file is achieved by the @{WAREHOUSE.Load}(*path*, *filename*) function. The parameter *path* specifies the path on the file system where the +-- Loading assets data from file is achieved by the @{#WAREHOUSE.Load}(*path*, *filename*) function. The parameter *path* specifies the path on the file system where the -- warehouse data is loaded from. If you do not specify a path, the file is loaded from your the DCS installation root directory. -- The parameter *filename* is optional and defines the name of the file to load. By default this is automatically generated from the warehouse id and name, for example -- "Warehouse-1234_Batumi.txt". diff --git a/Moose Development/Moose/Ops/Airboss.lua b/Moose Development/Moose/Ops/Airboss.lua index b9c544ad7..c8710d3bf 100644 --- a/Moose Development/Moose/Ops/Airboss.lua +++ b/Moose Development/Moose/Ops/Airboss.lua @@ -95,11 +95,6 @@ -- * [[MOOSE] Airboss - CASE I, "Until We Go Down" featuring the F-14B by Pikes](https://www.youtube.com/watch?v=ojgHDSw3Doc) -- * [[MOOSE] Airboss - Skipper Menu](https://youtu.be/awnecCxRoNQ) -- --- ### Lex explaining Boat Ops: --- --- * [( DCS HORNET ) Some boat ops basics VID 1](https://www.youtube.com/watch?v=LvGQS-3AzMc) --- * [( DCS HORNET ) Some boat ops basics VID 2](https://www.youtube.com/watch?v=bN44wvtRsw0) --- -- ### Jabbers Case I and III Recovery Tutorials: -- -- * [DCS World - F/A-18 - Case I Carrier Recovery Tutorial](https://www.youtube.com/watch?v=lm-M3VUy-_I) diff --git a/Moose Development/Moose/Ops/CTLD.lua b/Moose Development/Moose/Ops/CTLD.lua index d98ffc882..80c8d7d6e 100644 --- a/Moose Development/Moose/Ops/CTLD.lua +++ b/Moose Development/Moose/Ops/CTLD.lua @@ -601,7 +601,7 @@ do -- -- === -- --- ![Banner Image](OPS_CTLD.jpg) +-- ![Banner Image](../Images/OPS_CTLD.jpg) -- -- # CTLD Concept -- diff --git a/Moose Development/Moose/Ops/RescueHelo.lua b/Moose Development/Moose/Ops/RescueHelo.lua index b341c8a14..65f1e57c5 100644 --- a/Moose Development/Moose/Ops/RescueHelo.lua +++ b/Moose Development/Moose/Ops/RescueHelo.lua @@ -64,8 +64,6 @@ -- -- === -- --- ![Banner Image](..\Presentations\RESCUEHELO\RescueHelo_Main.png) --- -- # Recue Helo -- -- The rescue helo will fly in close formation with another unit, which is typically an aircraft carrier. diff --git a/Moose Development/Moose/Sound/SoundOutput.lua b/Moose Development/Moose/Sound/SoundOutput.lua index 57ce2f9a4..38a8337fe 100644 --- a/Moose Development/Moose/Sound/SoundOutput.lua +++ b/Moose Development/Moose/Sound/SoundOutput.lua @@ -313,7 +313,7 @@ do -- Text-To-Speech -- -- ## Specific Voice -- - -- You can use a specific voice for the transmission with the @{SOUNDTEXT.SetVoice}(*VoiceName*) function. Here are some examples + -- You can use a specific voice for the transmission with the @{#SOUNDTEXT.SetVoice}(*VoiceName*) function. Here are some examples -- -- * Name: Microsoft Hazel Desktop, Culture: en-GB, Gender: Female, Age: Adult, Desc: Microsoft Hazel Desktop - English (Great Britain) -- * Name: Microsoft David Desktop, Culture: en-US, Gender: Male, Age: Adult, Desc: Microsoft David Desktop - English (United States) diff --git a/Moose Development/Moose/Tasking/DetectionManager.lua b/Moose Development/Moose/Tasking/DetectionManager.lua index 3130ed4b1..d5af8de8d 100644 --- a/Moose Development/Moose/Tasking/DetectionManager.lua +++ b/Moose Development/Moose/Tasking/DetectionManager.lua @@ -18,7 +18,7 @@ -- Derived classes need to implement the method @{#DETECTION_MANAGER.GetReportDisplayTime}() to use the correct display time for displayed messages during a report. -- -- Reporting can be started and stopped using the methods @{#DETECTION_MANAGER.StartReporting}() and @{#DETECTION_MANAGER.StopReporting}() respectively. --- If an ad-hoc report is requested, use the method @{#DETECTION_MANAGER#ReportNow}(). +-- If an ad-hoc report is requested, use the method @{#DETECTION_MANAGER.ReportNow}(). -- -- The default reporting interval is every 60 seconds. The reporting messages are displayed 15 seconds. -- diff --git a/Moose Development/Moose/Tasking/Task_CARGO.lua b/Moose Development/Moose/Tasking/Task_CARGO.lua index 0bb782526..637298e51 100644 --- a/Moose Development/Moose/Tasking/Task_CARGO.lua +++ b/Moose Development/Moose/Tasking/Task_CARGO.lua @@ -5,7 +5,7 @@ -- * TASK_CARGO is the **base class** for: -- -- * @{Tasking.Task_Cargo_Transport#TASK_CARGO_TRANSPORT} --- * @{Tasking.Task_CARGO_CSAR#TASK_CARGO_CSAR} +-- * @{Tasking.Task_Cargo_CSAR#TASK_CARGO_CSAR} -- -- -- === @@ -14,7 +14,7 @@ -- -- Test missions can be located on the main GITHUB site. -- --- [FlightControl-Master/MOOSE_MISSIONS/TAD - Task Dispatching/CGO - Cargo Dispatching/](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/TAD%20-%20Task%20Dispatching/CGO%20-%20Cargo%20Dispatching) +-- [FlightControl-Master/MOOSE_MISSIONS/TAD - Task Dispatching/CGO - Cargo Dispatching/](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/TAD%20-%20Task%20Dispatching/CGO%20-%20Cargo%20Task%20Dispatching) -- -- === -- @@ -34,7 +34,7 @@ -- The following TASK_CARGO_ classes are important, as they implement the CONCRETE tasks: -- -- * @{Tasking.Task_Cargo_Transport#TASK_CARGO_TRANSPORT}: Defines a task for a human player to transport a set of cargo between various zones. --- * @{Tasking.Task_CARGO_CSAR#TASK_CARGO_CSAR}: Defines a task for a human player to Search and Rescue wounded pilots. +-- * @{Tasking.Task_Cargo_CSAR#TASK_CARGO_CSAR}: Defines a task for a human player to Search and Rescue wounded pilots. -- -- However! The menu system and basic usage of the TASK_CARGO classes is explained in the @{#TASK_CARGO} class description. -- So please browse further below to understand how to use it from a player perspective! @@ -49,7 +49,7 @@ -- Once the task is assigned to the player and accepted by the player, the player will obtain -- an extra **Cargo (Radio) Menu** that contains the CARGO objects that need to be transported. -- --- Each @{Cargo.Cargo} object has a certain state: +-- Each @{CARGO.Cargo} object has a certain state: -- -- * **UnLoaded**: The cargo is located within the battlefield. It may still need to be transported. -- * **Loaded**: The cargo is loaded within a Carrier. This can be your air unit, or another air unit, or even a vehicle. @@ -298,8 +298,7 @@ -- -- When you are within the range of the deploy zone (can be also a polygon!), a message is communicated by HQ that you have arrived within the zone! -- --- The routing messages are formulated in the coordinate format that is currently active as configured in your settings profile. --- ![Task_Types](../Tasking/Task_Cargo_Settings.JPG) +-- The routing messages are formulated in the coordinate format that is currently active as configured in your settings profile. -- Use the **Settings Menu** to select the coordinate format that you would like to use for location determination. -- -- #### Unboard Cargo. diff --git a/Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua b/Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua index fd1ed2075..09623e79f 100644 --- a/Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua +++ b/Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua @@ -570,7 +570,7 @@ do -- TASK_CARGO_DISPATCHER -- @param #string CSARTaskPrefix (optional) The prefix of the CSAR task. -- @param Core.Point#COORDINATE CSARCoordinate The coordinate where a downed pilot will be spawned. -- @param #number CSARHeading The heading of the pilot in degrees. - -- @param DCSCountry#Country CSARCountry The country ID of the pilot that will be spawned. + -- @param #DCSCountry CSARCountry The country ID of the pilot that will be spawned. -- @param #string CSARBriefing The briefing of the CSAR task. -- @return #string The CSAR Task Name as a string. The Task Name is the main key and is shown in the task list of the Mission Tasking menu. -- @usage diff --git a/Moose Development/Moose/Wrapper/Airbase.lua b/Moose Development/Moose/Wrapper/Airbase.lua index 5dcf2757b..c8c55c81b 100644 --- a/Moose Development/Moose/Wrapper/Airbase.lua +++ b/Moose Development/Moose/Wrapper/Airbase.lua @@ -61,7 +61,7 @@ -- -- The DCS Airbase APIs are used extensively within MOOSE. The AIRBASE class has for each DCS Airbase API a corresponding method. -- To be able to distinguish easily in your code the difference between a AIRBASE API call and a DCS Airbase API call, --- the first letter of the method is also capitalized. So, by example, the DCS Airbase method @{DCSWrapper.Airbase#Airbase.getName}() +-- the first letter of the method is also capitalized. So, by example, the DCS Airbase method DCSWrapper.Airbase#Airbase.getName() -- is implemented in the AIRBASE class as @{#AIRBASE.GetName}(). -- -- @field #AIRBASE AIRBASE diff --git a/Moose Development/Moose/Wrapper/Marker.lua b/Moose Development/Moose/Wrapper/Marker.lua index 4bb7f9c7b..9d138341c 100644 --- a/Moose Development/Moose/Wrapper/Marker.lua +++ b/Moose Development/Moose/Wrapper/Marker.lua @@ -32,8 +32,6 @@ -- -- === -- --- ![Banner Image](..\Presentations\MARKER\Marker_Main.jpg) --- -- # The MARKER Class Idea -- -- The MARKER class simplifies creating, updating and removing of markers on the F10 map. From d7df08d754f6ee55239490d9a30ba68dcab36485 Mon Sep 17 00:00:00 2001 From: kaltokri Date: Mon, 30 Oct 2023 18:01:57 +0100 Subject: [PATCH 4/6] Fixed broken links in documentation --- Moose Development/Moose/AI/AI_A2A_Dispatcher.lua | 6 +++--- Moose Development/Moose/AI/AI_A2G_Dispatcher.lua | 10 ---------- Moose Development/Moose/AI/AI_CAP.lua | 10 +++++----- Moose Development/Moose/AI/AI_Formation.lua | 4 ++-- Moose Development/Moose/Actions/Act_Assign.lua | 4 ++-- Moose Development/Moose/Cargo/Cargo.lua | 4 ++-- Moose Development/Moose/Core/Astar.lua | 2 +- Moose Development/Moose/Core/Event.lua | 4 ++-- Moose Development/Moose/Core/Pathline.lua | 2 +- Moose Development/Moose/Core/Spot.lua | 6 +++--- Moose Development/Moose/Functional/DetectionZones.lua | 2 +- Moose Development/Moose/Functional/Escort.lua | 2 +- Moose Development/Moose/Ops/CSAR.lua | 2 -- Moose Development/Moose/Sound/Radio.lua | 2 +- 14 files changed, 24 insertions(+), 36 deletions(-) diff --git a/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua b/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua index c0e20617b..e68068435 100644 --- a/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua +++ b/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua @@ -310,7 +310,7 @@ do -- AI_A2A_DISPATCHER -- Use the method @{#AI_A2A_DISPATCHER.SetEngageRadius}() to set a specific Engage Radius. -- **The Engage Radius is defined for ALL squadrons which are operational.** -- - -- Demonstration Mission: [AID-019 - AI_A2A - Engage Range Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/release-2-2-pre/AID%20-%20AI%20Dispatching/AID-019%20-%20AI_A2A%20-%20Engage%20Range%20Test) + -- Demonstration Mission: [AID-019 - AI_A2A - Engage Range Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching/AID-A2A-019%20-%20Engage%20Range%20Test) -- -- In this example an Engage Radius is set to various values. -- @@ -333,7 +333,7 @@ do -- AI_A2A_DISPATCHER -- Use the method @{#AI_A2A_DISPATCHER.SetGciRadius}() to set a specific controlled ground intercept radius. -- **The Ground Controlled Intercept radius is defined for ALL squadrons which are operational.** -- - -- Demonstration Mission: [AID-013 - AI_A2A - Intercept Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/release-2-2-pre/AID%20-%20AI%20Dispatching/AID-013%20-%20AI_A2A%20-%20Intercept%20Test) + -- Demonstration Mission: [AID-013 - AI_A2A - Intercept Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching/AID-A2A-013%20-%20Intercept%20Test) -- -- In these examples, the Gci Radius is set to various values: -- @@ -366,7 +366,7 @@ do -- AI_A2A_DISPATCHER -- it makes it easier sometimes for the mission maker to envisage where the red and blue territories roughly are. -- In a hot war the borders are effectively defined by the ground based radar coverage of a coalition. -- - -- Demonstration Mission: [AID-009 - AI_A2A - Border Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/release-2-2-pre/AID%20-%20AI%20Dispatching/AID-009 - AI_A2A - Border Test) + -- Demonstration Mission: [AID-009 - AI_A2A - Border Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching/AID-A2A-009%20-%20Border%20Test) -- -- In this example a border is set for the CCCP A2A dispatcher: -- diff --git a/Moose Development/Moose/AI/AI_A2G_Dispatcher.lua b/Moose Development/Moose/AI/AI_A2G_Dispatcher.lua index 6be8a0872..c3bb89ee2 100644 --- a/Moose Development/Moose/AI/AI_A2G_Dispatcher.lua +++ b/Moose Development/Moose/AI/AI_A2G_Dispatcher.lua @@ -296,8 +296,6 @@ do -- AI_A2G_DISPATCHER -- -- ## 1. AI\_A2G\_DISPATCHER constructor: -- - -- ![Banner Image](..\Presentations\AI_A2G_DISPATCHER\AI_A2G_DISPATCHER-ME_1.JPG) - -- -- -- The @{#AI_A2G_DISPATCHER.New}() method creates a new AI_A2G_DISPATCHER instance. -- @@ -311,8 +309,6 @@ do -- AI_A2G_DISPATCHER -- A reconnaissance network, is used to detect enemy ground targets, -- potentially group them into areas, and to understand the position, level of threat of the enemy. -- - -- ![Banner Image](..\Presentations\AI_A2G_DISPATCHER\Dia5.JPG) - -- -- As explained in the introduction, depending on the type of mission you want to achieve, different types of units can be applied to detect ground enemy targets. -- Ground based units are very useful to act as a reconnaissance, but they lack sometimes the visibility to detect targets at greater range. -- Recce are very useful to acquire the position of enemy ground targets when spread out over the battlefield at strategic positions. @@ -686,8 +682,6 @@ do -- AI_A2G_DISPATCHER -- -- Use the method @{#AI_A2G_DISPATCHER.SetSquadronGrouping}() to set the grouping of aircraft when spawned in. -- - -- ![Banner Image](..\Presentations\AI_A2G_DISPATCHER\Dia12.JPG) - -- -- In the case of **on call** engagement, the @{#AI_A2G_DISPATCHER.SetSquadronGrouping}() method has additional behaviour. -- When there aren't enough patrol flights airborne, a on call will be initiated for the remaining -- targets to be engaged. Depending on the grouping parameter, the spawned flights for on call aircraft are grouped into this setting. @@ -701,8 +695,6 @@ do -- AI_A2G_DISPATCHER -- The effectiveness can be set with the **overhead parameter**. This is a number that is used to calculate the amount of Units that dispatching command will allocate to GCI in surplus of detected amount of units. -- The **default value** of the overhead parameter is 1.0, which means **equal balance**. -- - -- ![Banner Image](..\Presentations\AI_A2G_DISPATCHER\Dia11.JPG) - -- -- However, depending on the (type of) aircraft (strength and payload) in the squadron and the amount of resources available, this parameter can be changed. -- -- The @{#AI_A2G_DISPATCHER.SetSquadronOverhead}() method can be used to tweak the defense strength, @@ -848,8 +840,6 @@ do -- AI_A2G_DISPATCHER -- -- For example, the following setup will set the default refuel tanker to "Tanker": -- - -- ![Banner Image](..\Presentations\AI_A2G_DISPATCHER\AI_A2G_DISPATCHER-ME_11.JPG) - -- -- -- Set the default tanker for refuelling to "Tanker", when the default fuel threshold has reached 90% fuel left. -- A2GDispatcher:SetDefaultFuelThreshold( 0.9 ) -- A2GDispatcher:SetDefaultTanker( "Tanker" ) diff --git a/Moose Development/Moose/AI/AI_CAP.lua b/Moose Development/Moose/AI/AI_CAP.lua index c2bce7d39..f2168a6c0 100644 --- a/Moose Development/Moose/AI/AI_CAP.lua +++ b/Moose Development/Moose/AI/AI_CAP.lua @@ -20,11 +20,11 @@ -- ### Author: **FlightControl** -- ### Contributions: -- --- * **[Quax](https://forums.eagle.ru/member.php?u=90530)**: Concept, Advice & Testing. --- * **[Pikey](https://forums.eagle.ru/member.php?u=62835)**: Concept, Advice & Testing. --- * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision. --- * **[Whisper](http://forums.eagle.ru/member.php?u=3829): Testing. --- * **[Delta99](https://forums.eagle.ru/member.php?u=125166): Testing. +-- * **Quax**: Concept, Advice & Testing. +-- * **Pikey**: Concept, Advice & Testing. +-- * **Gunterlund**: Test case revision. +-- * **Whisper**: Testing. +-- * **Delta99**: Testing. -- -- === -- diff --git a/Moose Development/Moose/AI/AI_Formation.lua b/Moose Development/Moose/AI/AI_Formation.lua index fa4e4ea4b..06b14d271 100644 --- a/Moose Development/Moose/AI/AI_Formation.lua +++ b/Moose Development/Moose/AI/AI_Formation.lua @@ -8,7 +8,7 @@ -- -- === -- --- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/FOR%20-%20Formation) +-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/FOR%20-%20AI%20Group%20Formation) -- -- === -- @@ -31,7 +31,7 @@ -- @field Core.Set#SET_GROUP FollowGroupSet -- @field #string FollowName -- @field #AI_FORMATION.MODE FollowMode The mode the escort is in. --- @field Scheduler#SCHEDULER FollowScheduler The instance of the SCHEDULER class. +-- @field Core.Scheduler#SCHEDULER FollowScheduler The instance of the SCHEDULER class. -- @field #number FollowDistance The current follow distance. -- @field #boolean ReportTargets If true, nearby targets are reported. -- @Field DCSTypes#AI.Option.Air.val.ROE OptionROE Which ROE is set to the FollowGroup. diff --git a/Moose Development/Moose/Actions/Act_Assign.lua b/Moose Development/Moose/Actions/Act_Assign.lua index 75f9e2e3f..c23383ca4 100644 --- a/Moose Development/Moose/Actions/Act_Assign.lua +++ b/Moose Development/Moose/Actions/Act_Assign.lua @@ -59,7 +59,7 @@ -- -- === -- --- # 1) @{#ACT_ASSIGN_ACCEPT} class, extends @{Core.Fsm.Assign#ACT_ASSIGN} +-- # 1) @{#ACT_ASSIGN_ACCEPT} class, extends @{Core.Fsm#ACT_ASSIGN} -- -- The ACT_ASSIGN_ACCEPT class accepts by default a task for a player. No player intervention is allowed to reject the task. -- @@ -69,7 +69,7 @@ -- -- === -- --- # 2) @{#ACT_ASSIGN_MENU_ACCEPT} class, extends @{Core.Fsm.Assign#ACT_ASSIGN} +-- # 2) @{#ACT_ASSIGN_MENU_ACCEPT} class, extends @{Core.Fsm#ACT_ASSIGN} -- -- The ACT_ASSIGN_MENU_ACCEPT class accepts a task when the player accepts the task through an added menu option. -- This assignment type is useful to conditionally allow the player to choose whether or not he would accept the task. diff --git a/Moose Development/Moose/Cargo/Cargo.lua b/Moose Development/Moose/Cargo/Cargo.lua index 257e118a9..462259b86 100644 --- a/Moose Development/Moose/Cargo/Cargo.lua +++ b/Moose Development/Moose/Cargo/Cargo.lua @@ -980,7 +980,7 @@ do -- CARGO --- Report to a Carrier Group with a Flaring signal. -- @param #CARGO self - -- @param Utils#UTILS.FlareColor FlareColor the color of the flare. + -- @param Utilities.Utils#UTILS.FlareColor FlareColor the color of the flare. -- @return #CARGO function CARGO:ReportFlare( FlareColor ) @@ -989,7 +989,7 @@ do -- CARGO --- Report to a Carrier Group with a Smoking signal. -- @param #CARGO self - -- @param Utils#UTILS.SmokeColor SmokeColor the color of the smoke. + -- @param Utilities.Utils#UTILS.SmokeColor SmokeColor the color of the smoke. -- @return #CARGO function CARGO:ReportSmoke( SmokeColor ) diff --git a/Moose Development/Moose/Core/Astar.lua b/Moose Development/Moose/Core/Astar.lua index 9514d179e..a7b032ad9 100644 --- a/Moose Development/Moose/Core/Astar.lua +++ b/Moose Development/Moose/Core/Astar.lua @@ -112,7 +112,7 @@ -- -- # Calculate the Path -- --- Finally, we have to calculate the path. This is done by the @{ASTAR.GetPath}(*ExcludeStart, ExcludeEnd*) function. This function returns a table of nodes, which +-- Finally, we have to calculate the path. This is done by the @{#GetPath}(*ExcludeStart, ExcludeEnd*) function. This function returns a table of nodes, which -- describe the optimal path from the start node to the end node. -- -- By default, the start and end node are include in the table that is returned. diff --git a/Moose Development/Moose/Core/Event.lua b/Moose Development/Moose/Core/Event.lua index 95c4f6a35..d057805f3 100644 --- a/Moose Development/Moose/Core/Event.lua +++ b/Moose Development/Moose/Core/Event.lua @@ -313,7 +313,7 @@ EVENTS = { -- @field Cargo.Cargo#CARGO Cargo The cargo object. -- @field #string CargoName The name of the cargo object. -- --- @field Core.ZONE#ZONE Zone The zone object. +-- @field Core.Zone#ZONE Zone The zone object. -- @field #string ZoneName The name of the zone. @@ -988,7 +988,7 @@ do -- Event Creation --- Creation of a New ZoneGoal Event. -- @param #EVENT self - -- @param Core.Functional#ZONE_GOAL ZoneGoal The ZoneGoal created. + -- @param Functional.ZoneGoal#ZONE_GOAL ZoneGoal The ZoneGoal created. function EVENT:CreateEventNewZoneGoal( ZoneGoal ) self:F( { ZoneGoal } ) diff --git a/Moose Development/Moose/Core/Pathline.lua b/Moose Development/Moose/Core/Pathline.lua index a71da23a3..b9b8b08f2 100644 --- a/Moose Development/Moose/Core/Pathline.lua +++ b/Moose Development/Moose/Core/Pathline.lua @@ -199,7 +199,7 @@ end --- Get points of pathline. Not that points are tables, that contain more information as just the 2D or 3D position but also the surface type etc. -- @param #PATHLINE self --- @return <#PATHLINE.Point> List of points. +-- @return #PATHLINE.Point List of points. function PATHLINE:GetPoints() return self.points end diff --git a/Moose Development/Moose/Core/Spot.lua b/Moose Development/Moose/Core/Spot.lua index af00fee8f..9db60f640 100644 --- a/Moose Development/Moose/Core/Spot.lua +++ b/Moose Development/Moose/Core/Spot.lua @@ -21,9 +21,9 @@ -- ### Author: **FlightControl** -- ### Contributions: -- --- * [**Ciribob**](https://forums.eagle.ru/member.php?u=112175): Showing the way how to lase targets + how laser codes work!!! Explained the autolase script. --- * [**EasyEB**](https://forums.eagle.ru/member.php?u=112055): Ideas and Beta Testing --- * [**Wingthor**](https://forums.eagle.ru/member.php?u=123698): Beta Testing +-- * **Ciribob**: Showing the way how to lase targets + how laser codes work!!! Explained the autolase script. +-- * **EasyEB**: Ideas and Beta Testing +-- * **Wingthor**: Beta Testing -- -- === -- diff --git a/Moose Development/Moose/Functional/DetectionZones.lua b/Moose Development/Moose/Functional/DetectionZones.lua index 8cb9b9d10..20680559d 100644 --- a/Moose Development/Moose/Functional/DetectionZones.lua +++ b/Moose Development/Moose/Functional/DetectionZones.lua @@ -21,7 +21,7 @@ do -- DETECTION_ZONES -- -- Retrieve the DetectedItems[].Set with the method @{Functional.Detection#DETECTION_BASE.GetDetectedSet}(). A @{Core.Set#SET_UNIT} object will be returned. -- - -- Retrieve the formed @{Zone@ZONE_UNIT}s as a result of the grouping the detected units within the DetectionZoneRange, use the method @{Functional.Detection#DETECTION_BASE.GetDetectionZones}(). + -- Retrieve the formed @{Core.Zone#ZONE_UNIT}s as a result of the grouping the detected units within the DetectionZoneRange, use the method @{Functional.Detection#DETECTION_BASE.GetDetectionZones}(). -- To understand the amount of zones created, use the method @{Functional.Detection#DETECTION_BASE.GetDetectionZoneCount}(). -- If you want to obtain a specific zone from the DetectedZones, use the method @{Functional.Detection#DETECTION_BASE.GetDetectionZone}() with a given index. -- diff --git a/Moose Development/Moose/Functional/Escort.lua b/Moose Development/Moose/Functional/Escort.lua index d0c470d3f..38d25de68 100644 --- a/Moose Development/Moose/Functional/Escort.lua +++ b/Moose Development/Moose/Functional/Escort.lua @@ -252,7 +252,7 @@ end --- Set a Detection method for the EscortClient to be reported upon. -- Detection methods are based on the derived classes from DETECTION_BASE. -- @param #ESCORT self --- @param Function.Detection#DETECTION_BASE Detection +-- @param Functional.Detection#DETECTION_BASE Detection function ESCORT:SetDetection( Detection ) self.Detection = Detection diff --git a/Moose Development/Moose/Ops/CSAR.lua b/Moose Development/Moose/Ops/CSAR.lua index 9d23a86e1..0c1950e41 100644 --- a/Moose Development/Moose/Ops/CSAR.lua +++ b/Moose Development/Moose/Ops/CSAR.lua @@ -46,8 +46,6 @@ -- -- === -- --- ![Banner Image](OPS_CSAR.jpg) --- -- # CSAR Concept -- -- * MOOSE-based Helicopter CSAR Operations for Players. diff --git a/Moose Development/Moose/Sound/Radio.lua b/Moose Development/Moose/Sound/Radio.lua index 56eb8ddf0..002e6ddaf 100644 --- a/Moose Development/Moose/Sound/Radio.lua +++ b/Moose Development/Moose/Sound/Radio.lua @@ -44,7 +44,7 @@ -- -- * First, you need to **"add a @{#RADIO} object** to your @{Wrapper.Positionable#POSITIONABLE}. This is done using the @{Wrapper.Positionable#POSITIONABLE.GetRadio}() function, -- * Then, you will **set the relevant parameters** to the transmission (see below), --- * When done, you can actually **broadcast the transmission** (i.e. play the sound) with the @{RADIO.Broadcast}() function. +-- * When done, you can actually **broadcast the transmission** (i.e. play the sound) with the @{#RADIO.Broadcast}() function. -- -- Methods to set relevant parameters for both a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP} or any other @{Wrapper.Positionable#POSITIONABLE} -- From b05683d3842996d5043fa98b9c043eff486b1840 Mon Sep 17 00:00:00 2001 From: kaltokri Date: Tue, 31 Oct 2023 10:25:00 +0100 Subject: [PATCH 5/6] Fixed some broken links --- Moose Development/Moose/AI/AI_A2A_Gci.lua | 2 -- Moose Development/Moose/AI/AI_A2G_SEAD.lua | 20 +------------------ .../Moose/AI/AI_Air_Dispatcher.lua | 10 ---------- Moose Development/Moose/AI/AI_Air_Engage.lua | 2 +- Moose Development/Moose/AI/AI_BAI.lua | 2 +- Moose Development/Moose/AI/AI_Balancer.lua | 6 +++--- Moose Development/Moose/AI/AI_CAS.lua | 6 +++--- .../Moose/Actions/Act_Account.lua | 2 +- .../Moose/Actions/Act_Assist.lua | 2 +- Moose Development/Moose/Core/Database.lua | 2 +- Moose Development/Moose/Core/Menu.lua | 2 +- Moose Development/Moose/Core/Message.lua | 4 ++-- Moose Development/Moose/Core/Pathline.lua | 2 +- Moose Development/Moose/Core/Scheduler.lua | 2 +- Moose Development/Moose/Core/Settings.lua | 14 ++++++------- Moose Development/Moose/Core/Zone.lua | 12 +++++------ Moose Development/Moose/Functional/Fox.lua | 2 +- Moose Development/Moose/Functional/Range.lua | 6 +++--- .../Moose/Functional/Scoring.lua | 4 ++-- .../Moose/Functional/ZoneCaptureCoalition.lua | 2 +- Moose Development/Moose/Sound/RadioSpeech.lua | 2 +- Moose Development/Moose/Sound/SRS.lua | 2 +- .../Moose/Tasking/Task_Cargo_CSAR.lua | 4 ++-- 23 files changed, 41 insertions(+), 71 deletions(-) diff --git a/Moose Development/Moose/AI/AI_A2A_Gci.lua b/Moose Development/Moose/AI/AI_A2A_Gci.lua index e3e7adb04..e0f9a77ec 100644 --- a/Moose Development/Moose/AI/AI_A2A_Gci.lua +++ b/Moose Development/Moose/AI/AI_A2A_Gci.lua @@ -53,8 +53,6 @@ -- -- ## 2. AI_A2A_GCI is a FSM -- --- ![Process](..\Presentations\AI_GCI\Dia2.JPG) --- -- ### 2.1 AI_A2A_GCI States -- -- * **None** ( Group ): The process is not started yet. diff --git a/Moose Development/Moose/AI/AI_A2G_SEAD.lua b/Moose Development/Moose/AI/AI_A2G_SEAD.lua index 2a4e8856c..72182ae13 100644 --- a/Moose Development/Moose/AI/AI_A2G_SEAD.lua +++ b/Moose Development/Moose/AI/AI_A2G_SEAD.lua @@ -14,47 +14,31 @@ --- @type AI_A2G_SEAD --- @extends AI.AI_A2G_Patrol#AI_AIR_PATROL +-- @extends AI.Air_Patrol#AI_AIR_PATROL --- Implements the core functions to SEAD intruders. Use the Engage trigger to intercept intruders. -- --- ![Process](..\Presentations\AI_GCI\Dia3.JPG) --- -- The AI_A2G_SEAD is assigned a @{Wrapper.Group} and this must be done before the AI_A2G_SEAD process can be started using the **Start** event. -- --- ![Process](..\Presentations\AI_GCI\Dia4.JPG) --- -- The AI will fly towards the random 3D point within the patrol zone, using a random speed within the given altitude and speed limits. -- Upon arrival at the 3D point, a new random 3D point will be selected within the patrol zone using the given limits. -- --- ![Process](..\Presentations\AI_GCI\Dia5.JPG) --- -- This cycle will continue. -- --- ![Process](..\Presentations\AI_GCI\Dia6.JPG) --- -- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event. --- --- ![Process](..\Presentations\AI_GCI\Dia9.JPG) -- -- When enemies are detected, the AI will automatically engage the enemy. -- --- ![Process](..\Presentations\AI_GCI\Dia10.JPG) --- -- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB. -- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land. -- --- ![Process](..\Presentations\AI_GCI\Dia13.JPG) --- -- ## 1. AI_A2G_SEAD constructor -- -- * @{#AI_A2G_SEAD.New}(): Creates a new AI_A2G_SEAD object. -- -- ## 3. Set the Range of Engagement -- --- ![Range](..\Presentations\AI_GCI\Dia11.JPG) --- -- An optional range can be set in meters, -- that will define when the AI will engage with the detected airborne enemy targets. -- The range can be beyond or smaller than the range of the Patrol Zone. @@ -63,8 +47,6 @@ -- -- ## 4. Set the Zone of Engagement -- --- ![Zone](..\Presentations\AI_GCI\Dia12.JPG) --- -- An optional @{Core.Zone} can be set, -- that will define when the AI will engage with the detected airborne enemy targets. -- Use the method @{AI.AI_CAP#AI_CAP_ZONE.SetEngageZone}() to define that Zone. -- TODO: Documentation. Check that this is actually correct. The originally referenced class does not exist. diff --git a/Moose Development/Moose/AI/AI_Air_Dispatcher.lua b/Moose Development/Moose/AI/AI_Air_Dispatcher.lua index 39fdf17f5..b422ac03e 100644 --- a/Moose Development/Moose/AI/AI_Air_Dispatcher.lua +++ b/Moose Development/Moose/AI/AI_Air_Dispatcher.lua @@ -292,8 +292,6 @@ do -- AI_AIR_DISPATCHER -- -- ## 1. AI\_AIR\_DISPATCHER constructor: -- - -- ![Banner Image](..\Presentations\AI_AIR_DISPATCHER\AI_AIR_DISPATCHER-ME_1.JPG) - -- -- -- The @{#AI_AIR_DISPATCHER.New}() method creates a new AI_AIR_DISPATCHER instance. -- @@ -306,8 +304,6 @@ do -- AI_AIR_DISPATCHER -- A reconnaissance network, is used to detect enemy ground targets, -- potentially group them into areas, and to understand the position, level of threat of the enemy. -- - -- ![Banner Image](..\Presentations\AI_AIR_DISPATCHER\Dia5.JPG) - -- -- As explained in the introduction, depending on the type of mission you want to achieve, different types of units can be applied to detect ground enemy targets. -- Ground based units are very useful to act as a reconnaissance, but they lack sometimes the visibility to detect targets at greater range. -- Recce are very useful to acquire the position of enemy ground targets when spread out over the battlefield at strategic positions. @@ -673,8 +669,6 @@ do -- AI_AIR_DISPATCHER -- -- Use the method @{#AI_AIR_DISPATCHER.SetSquadronGrouping}() to set the grouping of aircraft when spawned in. -- - -- ![Banner Image](..\Presentations\AI_AIR_DISPATCHER\Dia12.JPG) - -- -- In the case of **on call** engagement, the @{#AI_AIR_DISPATCHER.SetSquadronGrouping}() method has additional behaviour. -- When there aren't enough patrol flights airborne, a on call will be initiated for the remaining -- targets to be engaged. Depending on the grouping parameter, the spawned flights for on call aircraft are grouped into this setting. @@ -688,8 +682,6 @@ do -- AI_AIR_DISPATCHER -- The effectiveness can be set with the **overhead parameter**. This is a number that is used to calculate the amount of Units that dispatching command will allocate to GCI in surplus of detected amount of units. -- The **default value** of the overhead parameter is 1.0, which means **equal balance**. -- - -- ![Banner Image](..\Presentations\AI_AIR_DISPATCHER\Dia11.JPG) - -- -- However, depending on the (type of) aircraft (strength and payload) in the squadron and the amount of resources available, this parameter can be changed. -- -- The @{#AI_AIR_DISPATCHER.SetSquadronOverhead}() method can be used to tweak the defense strength, @@ -835,8 +827,6 @@ do -- AI_AIR_DISPATCHER -- -- For example, the following setup will set the default refuel tanker to "Tanker": -- - -- ![Banner Image](..\Presentations\AI_AIR_DISPATCHER\AI_AIR_DISPATCHER-ME_11.JPG) - -- -- -- Define the CAP -- A2ADispatcher:SetSquadron( "Sochi", AIRBASE.Caucasus.Sochi_Adler, { "SQ CCCP SU-34" }, 20 ) -- A2ADispatcher:SetSquadronCap( "Sochi", ZONE:New( "PatrolZone" ), 4000, 8000, 600, 800, 1000, 1300 ) diff --git a/Moose Development/Moose/AI/AI_Air_Engage.lua b/Moose Development/Moose/AI/AI_Air_Engage.lua index f75f48240..f5a7b2d44 100644 --- a/Moose Development/Moose/AI/AI_Air_Engage.lua +++ b/Moose Development/Moose/AI/AI_Air_Engage.lua @@ -14,7 +14,7 @@ --- @type AI_AIR_ENGAGE --- @extends AI.AI_AIR#AI_AIR +-- @extends AI.AI_Air#AI_AIR --- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders. diff --git a/Moose Development/Moose/AI/AI_BAI.lua b/Moose Development/Moose/AI/AI_BAI.lua index 58b33e14f..e1fc59bbf 100644 --- a/Moose Development/Moose/AI/AI_BAI.lua +++ b/Moose Development/Moose/AI/AI_BAI.lua @@ -22,7 +22,7 @@ -- ### Author: **FlightControl** -- ### Contributions: -- --- * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision. +-- * **Gunterlund**: Test case revision. -- -- === -- diff --git a/Moose Development/Moose/AI/AI_Balancer.lua b/Moose Development/Moose/AI/AI_Balancer.lua index 14eba62c6..290dca57f 100644 --- a/Moose Development/Moose/AI/AI_Balancer.lua +++ b/Moose Development/Moose/AI/AI_Balancer.lua @@ -20,7 +20,7 @@ -- ### Author: **FlightControl** -- ### Contributions: -- --- * **[Dutch_Baron](https://forums.eagle.ru/member.php?u=112075)**: Working together with James has resulted in the creation of the AI_BALANCER class. James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-) +-- * **Dutch_Baron**: Working together with James has resulted in the creation of the AI_BALANCER class. James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-) -- -- === -- @@ -40,7 +40,7 @@ -- -- The parent class @{Core.Fsm#FSM_SET} manages the functionality to control the Finite State Machine (FSM). -- The mission designer can tailor the behaviour of the AI_BALANCER, by defining event and state transition methods. --- An explanation about state and event transition methods can be found in the @{FSM} module documentation. +-- An explanation about state and event transition methods can be found in the @{Core.Fsm} module documentation. -- -- The mission designer can tailor the AI_BALANCER behaviour, by implementing a state or event handling method for the following: -- @@ -52,7 +52,7 @@ -- -- ## 2. AI_BALANCER is a FSM -- --- ![Process](..\Presentations\AI_Balancer\Dia13.JPG) +-- ![Process](..\Presentations\AI_BALANCER\Dia13.JPG) -- -- ### 2.1. AI_BALANCER States -- diff --git a/Moose Development/Moose/AI/AI_CAS.lua b/Moose Development/Moose/AI/AI_CAS.lua index f4bcd5b27..7c748b5a6 100644 --- a/Moose Development/Moose/AI/AI_CAS.lua +++ b/Moose Development/Moose/AI/AI_CAS.lua @@ -22,9 +22,9 @@ -- ### Author: **FlightControl** -- ### Contributions: -- --- * **[Quax](https://forums.eagle.ru/member.php?u=90530)**: Concept, Advice & Testing. --- * **[Pikey](https://forums.eagle.ru/member.php?u=62835)**: Concept, Advice & Testing. --- * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision. +-- * **Quax**: Concept, Advice & Testing. +-- * **Pikey**: Concept, Advice & Testing. +-- * **Gunterlund**: Test case revision. -- -- === -- diff --git a/Moose Development/Moose/Actions/Act_Account.lua b/Moose Development/Moose/Actions/Act_Account.lua index 0fe2d6eb6..5b809af44 100644 --- a/Moose Development/Moose/Actions/Act_Account.lua +++ b/Moose Development/Moose/Actions/Act_Account.lua @@ -142,7 +142,7 @@ end -- ACT_ACCOUNT do -- ACT_ACCOUNT_DEADS - --- # @{#ACT_ACCOUNT_DEADS} FSM class, extends @{Core.Fsm.Account#ACT_ACCOUNT} + --- # @{#ACT_ACCOUNT_DEADS} FSM class, extends @{#ACT_ACCOUNT} -- -- The ACT_ACCOUNT_DEADS class accounts (detects, counts and reports) successful kills of DCS units. -- The process is given a @{Core.Set} of units that will be tracked upon successful destruction. diff --git a/Moose Development/Moose/Actions/Act_Assist.lua b/Moose Development/Moose/Actions/Act_Assist.lua index e7017ce90..45bb4d804 100644 --- a/Moose Development/Moose/Actions/Act_Assist.lua +++ b/Moose Development/Moose/Actions/Act_Assist.lua @@ -48,7 +48,7 @@ -- -- === -- --- # 1) @{#ACT_ASSIST_SMOKE_TARGETS_ZONE} class, extends @{Core.Fsm.Route#ACT_ASSIST} +-- # 1) @{#ACT_ASSIST_SMOKE_TARGETS_ZONE} class, extends @{#ACT_ASSIST} -- -- The ACT_ASSIST_SMOKE_TARGETS_ZONE class implements the core functions to smoke targets in a @{Core.Zone}. -- The targets are smoked within a certain range around each target, simulating a realistic smoking behaviour. diff --git a/Moose Development/Moose/Core/Database.lua b/Moose Development/Moose/Core/Database.lua index 2eeb2d244..180bd5b5a 100644 --- a/Moose Development/Moose/Core/Database.lua +++ b/Moose Development/Moose/Core/Database.lua @@ -681,7 +681,7 @@ do -- cargo --- Finds an CARGO based on the CargoName. -- @param #DATABASE self -- @param #string CargoName - -- @return Wrapper.Cargo#CARGO The found CARGO. + -- @return Cargo.Cargo#CARGO The found CARGO. function DATABASE:FindCargo( CargoName ) local CargoFound = self.CARGOS[CargoName] diff --git a/Moose Development/Moose/Core/Menu.lua b/Moose Development/Moose/Core/Menu.lua index 8a6edf657..fc9a75394 100644 --- a/Moose Development/Moose/Core/Menu.lua +++ b/Moose Development/Moose/Core/Menu.lua @@ -513,7 +513,7 @@ do -- MENU_COALITION --- @type MENU_COALITION -- @extends Core.Menu#MENU_BASE - --- Manages the main menus for @{DCS.coalition}s. + --- Manages the main menus for DCS.coalition. -- -- You can add menus with the @{#MENU_COALITION.New} method, which constructs a MENU_COALITION object and returns you the object reference. -- Using this object reference, you can then remove ALL the menus and submenus underlying automatically with @{#MENU_COALITION.Remove}. diff --git a/Moose Development/Moose/Core/Message.lua b/Moose Development/Moose/Core/Message.lua index 005850ec1..4d1d5d501 100644 --- a/Moose Development/Moose/Core/Message.lua +++ b/Moose Development/Moose/Core/Message.lua @@ -73,7 +73,7 @@ MESSAGE.Type = { Detailed = "Detailed Report", } ---- Creates a new MESSAGE object. Note that these MESSAGE objects are not yet displayed on the display panel. You must use the functions @{ToClient} or @{ToCoalition} or @{ToAll} to send these Messages to the respective recipients. +--- Creates a new MESSAGE object. Note that these MESSAGE objects are not yet displayed on the display panel. You must use the functions @{#MESSAGE.ToClient} or @{#MESSAGE.ToCoalition} or @{#MESSAGE.ToAll} to send these Messages to the respective recipients. -- @param self -- @param #string MessageText is the text of the Message. -- @param #number MessageDuration is a number in seconds of how long the MESSAGE should be shown on the display panel. @@ -379,7 +379,7 @@ end --- Sends a MESSAGE to a Coalition if the given Condition is true. -- @param #MESSAGE self --- @param CoalitionSide needs to be filled out by the defined structure of the standard scripting engine @{coalition.side}. +-- @param CoalitionSide needs to be filled out by the defined structure of the standard scripting engine @{#DCS.coalition.side}. -- @param #boolean Condition Sends the message only if the condition is true. -- @return #MESSAGE self function MESSAGE:ToCoalitionIf( CoalitionSide, Condition ) diff --git a/Moose Development/Moose/Core/Pathline.lua b/Moose Development/Moose/Core/Pathline.lua index b9b8b08f2..7cbb48552 100644 --- a/Moose Development/Moose/Core/Pathline.lua +++ b/Moose Development/Moose/Core/Pathline.lua @@ -199,7 +199,7 @@ end --- Get points of pathline. Not that points are tables, that contain more information as just the 2D or 3D position but also the surface type etc. -- @param #PATHLINE self --- @return #PATHLINE.Point List of points. +-- @return #list <#PATHLINE.Point> List of points. function PATHLINE:GetPoints() return self.points end diff --git a/Moose Development/Moose/Core/Scheduler.lua b/Moose Development/Moose/Core/Scheduler.lua index 36804e2ab..231157a5d 100644 --- a/Moose Development/Moose/Core/Scheduler.lua +++ b/Moose Development/Moose/Core/Scheduler.lua @@ -52,7 +52,7 @@ -- -- A SCHEDULER can manage **multiple** (repeating) schedules. Each planned or executing schedule has a unique **ScheduleID**. -- The ScheduleID is returned when the method @{#SCHEDULER.Schedule}() is called. --- It is recommended to store the ScheduleID in a variable, as it is used in the methods @{SCHEDULER.Start}() and @{SCHEDULER.Stop}(), +-- It is recommended to store the ScheduleID in a variable, as it is used in the methods @{#SCHEDULER.Start}() and @{#SCHEDULER.Stop}(), -- which can start and stop specific repeating schedules respectively within a SCHEDULER object. -- -- ## SCHEDULER constructor diff --git a/Moose Development/Moose/Core/Settings.lua b/Moose Development/Moose/Core/Settings.lua index 4a97a35eb..e24527798 100644 --- a/Moose Development/Moose/Core/Settings.lua +++ b/Moose Development/Moose/Core/Settings.lua @@ -91,7 +91,7 @@ -- -- Will customize which display format is used to indicate A2G coordinates in text as part of the Command Center communications. -- --- - A2G BR: [Bearing Range](https://en.wikipedia.org/wiki/Bearing_(navigation)). +-- - A2G BR: [Bearing Range](https://en.wikipedia.org/wiki/Bearing_\(navigation\)). -- - A2G MGRS: The [Military Grid Reference System](https://en.wikipedia.org/wiki/Military_Grid_Reference_System). The accuracy can also be adapted. -- - A2G LL DMS: Latitude Longitude [Degrees Minutes Seconds](https://en.wikipedia.org/wiki/Geographic_coordinate_conversion). The accuracy can also be adapted. -- - A2G LL DDM: Latitude Longitude [Decimal Degrees Minutes](https://en.wikipedia.org/wiki/Decimal_degrees). The accuracy can also be adapted. @@ -105,9 +105,9 @@ -- There are different methods that can be used to change the **System settings** using the \_SETTINGS object. -- -- - @{#SETTINGS.SetA2G_BR}(): Enable the BR display formatting by default. --- - @{#SETTINGS.SetA2G_MGRS}(): Enable the MGRS display formatting by default. Use @{SETTINGS.SetMGRS_Accuracy}() to adapt the accuracy of the MGRS formatting. --- - @{#SETTINGS.SetA2G_LL_DMS}(): Enable the LL DMS display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting. --- - @{#SETTINGS.SetA2G_LL_DDM}(): Enable the LL DDM display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting. +-- - @{#SETTINGS.SetA2G_MGRS}(): Enable the MGRS display formatting by default. Use @{#SETTINGS.SetMGRS_Accuracy}() to adapt the accuracy of the MGRS formatting. +-- - @{#SETTINGS.SetA2G_LL_DMS}(): Enable the LL DMS display formatting by default. Use @{#SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting. +-- - @{#SETTINGS.SetA2G_LL_DDM}(): Enable the LL DDM display formatting by default. Use @{#SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting. -- -- ### 3.1.4) A2G coordinates setting - additional notes -- @@ -135,9 +135,9 @@ -- There are different methods that can be used to change the **System settings** using the \_SETTINGS object. -- -- - @{#SETTINGS.SetA2A_BRAA}(): Enable the BR display formatting by default. --- - @{#SETTINGS.SetA2A_MGRS}(): Enable the MGRS display formatting by default. Use @{SETTINGS.SetMGRS_Accuracy}() to adapt the accuracy of the MGRS formatting. --- - @{#SETTINGS.SetA2A_LL_DMS}(): Enable the LL DMS display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting. --- - @{#SETTINGS.SetA2A_LL_DDM}(): Enable the LL DDM display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting. +-- - @{#SETTINGS.SetA2A_MGRS}(): Enable the MGRS display formatting by default. Use @{#SETTINGS.SetMGRS_Accuracy}() to adapt the accuracy of the MGRS formatting. +-- - @{#SETTINGS.SetA2A_LL_DMS}(): Enable the LL DMS display formatting by default. Use @{#SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting. +-- - @{#SETTINGS.SetA2A_LL_DDM}(): Enable the LL DDM display formatting by default. Use @{#SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting. -- - @{#SETTINGS.SetA2A_BULLS}(): Enable the BULLSeye display formatting by default. -- -- ### 3.2.4) A2A coordinates settings - additional notes diff --git a/Moose Development/Moose/Core/Zone.lua b/Moose Development/Moose/Core/Zone.lua index e4fb13558..648249020 100644 --- a/Moose Development/Moose/Core/Zone.lua +++ b/Moose Development/Moose/Core/Zone.lua @@ -570,7 +570,7 @@ end --- Start watching if the Object or Objects move into or out of a zone. -- @param #ZONE_BASE self --- @param Wrappe.Controllable#CONTROLLABLE Objects Object or Objects to watch, can be of type UNIT, GROUP, CLIENT, or SET\_UNIT, SET\_GROUP, SET\_CLIENT +-- @param Wrapper.Controllable#CONTROLLABLE Objects Object or Objects to watch, can be of type UNIT, GROUP, CLIENT, or SET\_UNIT, SET\_GROUP, SET\_CLIENT -- @return #ZONE_BASE self -- @usage -- -- Create a new zone and start watching it every 5 secs for a defined GROUP entering or leaving @@ -2749,11 +2749,11 @@ end --- Scan the zone for the presence of units of the given ObjectCategories. Does **not** scan for scenery at the moment. -- Note that **only after** a zone has been scanned, the zone can be evaluated by: -- --- * @{ZONE_POLYGON.IsAllInZoneOfCoalition}(): Scan the presence of units in the zone of a coalition. --- * @{ZONE_POLYGON.IsAllInZoneOfOtherCoalition}(): Scan the presence of units in the zone of an other coalition. --- * @{ZONE_POLYGON.IsSomeInZoneOfCoalition}(): Scan if there is some presence of units in the zone of the given coalition. --- * @{ZONE_POLYGON.IsNoneInZoneOfCoalition}(): Scan if there isn't any presence of units in the zone of an other coalition than the given one. --- * @{ZONE_POLYGON.IsNoneInZone}(): Scan if the zone is empty. +-- * @{Core.Zone#ZONE_POLYGON.IsAllInZoneOfCoalition}(): Scan the presence of units in the zone of a coalition. +-- * @{Core.Zone#ZONE_POLYGON.IsAllInZoneOfOtherCoalition}(): Scan the presence of units in the zone of an other coalition. +-- * @{Core.Zone#ZONE_POLYGON.IsSomeInZoneOfCoalition}(): Scan if there is some presence of units in the zone of the given coalition. +-- * @{Core.Zone#ZONE_POLYGON.IsNoneInZoneOfCoalition}(): Scan if there isn't any presence of units in the zone of an other coalition than the given one. +-- * @{Core.Zone#ZONE_POLYGON.IsNoneInZone}(): Scan if the zone is empty. -- @param #ZONE_POLYGON self -- @param ObjectCategories An array of categories of the objects to find in the zone. E.g. `{Object.Category.UNIT}` -- @param UnitCategories An array of unit categories of the objects to find in the zone. E.g. `{Unit.Category.GROUND_UNIT,Unit.Category.SHIP}` diff --git a/Moose Development/Moose/Functional/Fox.lua b/Moose Development/Moose/Functional/Fox.lua index 4d5a418e0..0c9c81b67 100644 --- a/Moose Development/Moose/Functional/Fox.lua +++ b/Moose Development/Moose/Functional/Fox.lua @@ -58,7 +58,7 @@ -- -- # The FOX Concept -- --- As you probably know [Fox](https://en.wikipedia.org/wiki/Fox_(code_word)) is a NATO brevity code for launching air-to-air munition. Therefore, the class name is not 100% accurate as this +-- As you probably know [Fox](https://en.wikipedia.org/wiki/Fox_\(code_word\)) is a NATO brevity code for launching air-to-air munition. Therefore, the class name is not 100% accurate as this -- script handles air-to-air but also surface-to-air missiles. -- -- # Basic Script diff --git a/Moose Development/Moose/Functional/Range.lua b/Moose Development/Moose/Functional/Range.lua index ab44ef3cd..18630e30b 100644 --- a/Moose Development/Moose/Functional/Range.lua +++ b/Moose Development/Moose/Functional/Range.lua @@ -4,7 +4,7 @@ -- -- The RANGE class enables easy set up of bombing and strafing ranges within DCS World. -- --- Implementation is based on the [Simple Range Script](https://forums.eagle.ru/showthread.php?t=157991) by [Ciribob](https://forums.eagle.ru/member.php?u=112175), which itself was motivated +-- Implementation is based on the [Simple Range Script](https://forums.eagle.ru/showthread.php?t=157991) by Ciribob, which itself was motivated -- by a script by SNAFU [see here](https://forums.eagle.ru/showthread.php?t=109174). -- -- [476th - Air Weapons Range Objects mod](http://www.476vfightergroup.com/downloads.php?do=file&id=287) is highly recommended for this class. @@ -42,9 +42,9 @@ -- -- === -- --- ### Author: **[funkyfranky](https://forums.eagle.ru/member.php?u=115026)** +-- ### Author: **funkyfranky** -- --- ### Contributions: [FlightControl](https://forums.eagle.ru/member.php?u=89536), [Ciribob](https://forums.eagle.ru/member.php?u=112175) +-- ### Contributions: FlightControl, Ciribob -- ### SRS Additions: Applevangelist -- -- === diff --git a/Moose Development/Moose/Functional/Scoring.lua b/Moose Development/Moose/Functional/Scoring.lua index a7093f8c1..1c86d5812 100644 --- a/Moose Development/Moose/Functional/Scoring.lua +++ b/Moose Development/Moose/Functional/Scoring.lua @@ -27,7 +27,7 @@ -- and creates a CSV file logging the scoring events and results for use at team or squadron websites. -- -- SCORING automatically calculates the threat level of the objects hit and destroyed by players, --- which can be @{Wrapper.Unit}, @{Static) and @{Scenery} objects. +-- which can be @{Wrapper.Unit}, @{Wrapper.Static) and @{Scenery} objects. -- -- Positive score points are granted when enemy or neutral targets are destroyed. -- Negative score points or penalties are given when a friendly target is hit or destroyed. @@ -81,7 +81,7 @@ -- -- * **Wingthor (TAW)**: Testing & Advice. -- * **Dutch-Baron (TAW)**: Testing & Advice. --- * **[Whisper](http://forums.eagle.ru/member.php?u=3829): Testing and Advice. +-- * **Whisper**: Testing and Advice. -- -- === -- diff --git a/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua b/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua index 3215b9a12..8dbf6f659 100644 --- a/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua +++ b/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua @@ -363,7 +363,7 @@ do -- ZONE_CAPTURE_COALITION --- ZONE_CAPTURE_COALITION Constructor. -- @param #ZONE_CAPTURE_COALITION self - -- @param Core.Zone#ZONE Zone A @{Core.Zone} object with the goal to be achieved. Alternatively, can be handed as the name of late activated group describing a @{ZONE_POLYGON} with its waypoints. + -- @param Core.Zone#ZONE Zone A @{Core.Zone} object with the goal to be achieved. Alternatively, can be handed as the name of late activated group describing a @{Core.Zone#ZONE_POLYGON} with its waypoints. -- @param DCSCoalition.DCSCoalition#coalition Coalition The initial coalition owning the zone. -- @param #table UnitCategories Table of unit categories. See [DCS Class Unit](https://wiki.hoggitworld.com/view/DCS_Class_Unit). Default {Unit.Category.GROUND_UNIT}. -- @param #table ObjectCategories Table of unit categories. See [DCS Class Object](https://wiki.hoggitworld.com/view/DCS_Class_Object). Default {Object.Category.UNIT, Object.Category.STATIC}, i.e. all UNITS and STATICS. diff --git a/Moose Development/Moose/Sound/RadioSpeech.lua b/Moose Development/Moose/Sound/RadioSpeech.lua index 8f18e9d53..88caaf34c 100644 --- a/Moose Development/Moose/Sound/RadioSpeech.lua +++ b/Moose Development/Moose/Sound/RadioSpeech.lua @@ -25,7 +25,7 @@ -- -- -- @type RADIOSPEECH --- @extends Core.RadioQueue#RADIOQUEUE +-- @extends Sound.RadioQueue#RADIOQUEUE RADIOSPEECH = { ClassName = "RADIOSPEECH", Vocabulary = { diff --git a/Moose Development/Moose/Sound/SRS.lua b/Moose Development/Moose/Sound/SRS.lua index 70dd2adb6..eda0e8504 100644 --- a/Moose Development/Moose/Sound/SRS.lua +++ b/Moose Development/Moose/Sound/SRS.lua @@ -769,7 +769,7 @@ end --- Play sound file (ogg or mp3) via SRS. -- @param #MSRS self --- @param Sound.SoundFile#SOUNDFILE Soundfile Sound file to play. +-- @param Sound.SoundOutput#SOUNDFILE Soundfile Sound file to play. -- @param #number Delay Delay in seconds, before the sound file is played. -- @return #MSRS self function MSRS:PlaySoundFile(Soundfile, Delay) diff --git a/Moose Development/Moose/Tasking/Task_Cargo_CSAR.lua b/Moose Development/Moose/Tasking/Task_Cargo_CSAR.lua index 290ebc7f3..ddafed89f 100644 --- a/Moose Development/Moose/Tasking/Task_Cargo_CSAR.lua +++ b/Moose Development/Moose/Tasking/Task_Cargo_CSAR.lua @@ -73,7 +73,7 @@ do -- TASK_CARGO_CSAR --- @type TASK_CARGO_CSAR - -- @extends Tasking.Task_Cargo#TASK_CARGO + -- @extends Tasking.Task_CARGO#TASK_CARGO --- Orchestrates the task for players to execute CSAR for downed pilots. -- @@ -137,7 +137,7 @@ do -- TASK_CARGO_CSAR -- -- The cargoset "CargoSet" will embed all defined cargo of type "Pilots" (prefix) into its set. -- local CargoGroup = CARGO_GROUP:New( PilotGroup, "Pilots", "Downed Pilot", 500 ) -- - -- What is also needed, is to have a set of @{Core.Group}s defined that contains the clients of the players. + -- What is also needed, is to have a set of @{#Core.Group}s defined that contains the clients of the players. -- -- -- Allocate the Transport, which are the helicopter to retrieve the pilot, that can be manned by players. -- local GroupSet = SET_GROUP:New():FilterPrefixes( "Transport" ):FilterStart() From 77f97211024dc03555b1f7ee203ff9c7b3bff849 Mon Sep 17 00:00:00 2001 From: Frank Date: Tue, 31 Oct 2023 11:44:45 +0100 Subject: [PATCH 6/6] AI - Fixed various `@extends` errors pointing to non-existing classes for AI_* --- Moose Development/Moose/AI/AI_A2A_Cap.lua | 2 +- Moose Development/Moose/AI/AI_A2A_Gci.lua | 2 +- Moose Development/Moose/AI/AI_A2A_Patrol.lua | 2 +- Moose Development/Moose/AI/AI_A2G_BAI.lua | 5 +++-- Moose Development/Moose/AI/AI_A2G_CAS.lua | 5 +++-- Moose Development/Moose/AI/AI_A2G_SEAD.lua | 5 +++-- Moose Development/Moose/AI/AI_Escort.lua | 7 ------- Moose Development/Moose/AI/AI_Formation.lua | 9 --------- 8 files changed, 12 insertions(+), 25 deletions(-) diff --git a/Moose Development/Moose/AI/AI_A2A_Cap.lua b/Moose Development/Moose/AI/AI_A2A_Cap.lua index 2b82e6d6c..7a19505c9 100644 --- a/Moose Development/Moose/AI/AI_A2A_Cap.lua +++ b/Moose Development/Moose/AI/AI_A2A_Cap.lua @@ -123,7 +123,7 @@ function AI_A2A_CAP:New2( AICap, EngageMinSpeed, EngageMaxSpeed, EngageFloorAlti -- Multiple inheritance ... :-) local AI_Air = AI_AIR:New( AICap ) - local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AICap, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) -- #AI_AIR_PATROL + local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AICap, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) local AI_Air_Engage = AI_AIR_ENGAGE:New( AI_Air_Patrol, AICap, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType ) local self = BASE:Inherit( self, AI_Air_Engage ) --#AI_A2A_CAP diff --git a/Moose Development/Moose/AI/AI_A2A_Gci.lua b/Moose Development/Moose/AI/AI_A2A_Gci.lua index e0f9a77ec..14b605479 100644 --- a/Moose Development/Moose/AI/AI_A2A_Gci.lua +++ b/Moose Development/Moose/AI/AI_A2A_Gci.lua @@ -14,7 +14,7 @@ --- @type AI_A2A_GCI --- @extends AI.AI_A2A#AI_A2A +-- @extends AI.AI_Air_Engage#AI_AIR_ENGAGE --- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders. diff --git a/Moose Development/Moose/AI/AI_A2A_Patrol.lua b/Moose Development/Moose/AI/AI_A2A_Patrol.lua index 0c882a39a..866827ac4 100644 --- a/Moose Development/Moose/AI/AI_A2A_Patrol.lua +++ b/Moose Development/Moose/AI/AI_A2A_Patrol.lua @@ -11,7 +11,7 @@ --- @type AI_A2A_PATROL --- @extends AI.AI_A2A#AI_A2A +-- @extends AI.AI_Air_Patrol#AI_AIR_PATROL --- Implements the core functions to patrol a @{Core.Zone} by an AI @{Wrapper.Group} or @{Wrapper.Group}. -- diff --git a/Moose Development/Moose/AI/AI_A2G_BAI.lua b/Moose Development/Moose/AI/AI_A2G_BAI.lua index 330110cca..5737873f2 100644 --- a/Moose Development/Moose/AI/AI_A2G_BAI.lua +++ b/Moose Development/Moose/AI/AI_A2G_BAI.lua @@ -12,7 +12,8 @@ -- @image AI_Air_To_Ground_Engage.JPG --- @type AI_A2G_BAI --- @extends AI.AI_A2A_Engage#AI_A2A_Engage -- TODO: Documentation. This class does not exist, unable to determine what it extends. +-- @extends AI.AI_Air_Patrol#AI_AIR_PATROL +-- @extends AI.AI_Air_Engage#AI_AIR_ENGAGE --- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders. -- @@ -46,7 +47,7 @@ AI_A2G_BAI = { function AI_A2G_BAI:New2( AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) local AI_Air = AI_AIR:New( AIGroup ) - local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) -- #AI_AIR_PATROL + local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) local AI_Air_Engage = AI_AIR_ENGAGE:New( AI_Air_Patrol, AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType ) local self = BASE:Inherit( self, AI_Air_Engage ) diff --git a/Moose Development/Moose/AI/AI_A2G_CAS.lua b/Moose Development/Moose/AI/AI_A2G_CAS.lua index cc16cc187..85175a628 100644 --- a/Moose Development/Moose/AI/AI_A2G_CAS.lua +++ b/Moose Development/Moose/AI/AI_A2G_CAS.lua @@ -12,7 +12,8 @@ -- @image AI_Air_To_Ground_Engage.JPG --- @type AI_A2G_CAS --- @extends AI.AI_A2G_Patrol#AI_AIR_PATROL TODO: Documentation. This class does not exist, unable to determine what it extends. +-- @extends AI.AI_Air_Patrol#AI_AIR_PATROL +-- @extends AI.AI_Air_Engage#AI_AIR_ENGAGE --- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders. -- @@ -46,7 +47,7 @@ AI_A2G_CAS = { function AI_A2G_CAS:New2( AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) local AI_Air = AI_AIR:New( AIGroup ) - local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) -- #AI_AIR_PATROL + local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) local AI_Air_Engage = AI_AIR_ENGAGE:New( AI_Air_Patrol, AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType ) local self = BASE:Inherit( self, AI_Air_Engage ) diff --git a/Moose Development/Moose/AI/AI_A2G_SEAD.lua b/Moose Development/Moose/AI/AI_A2G_SEAD.lua index 72182ae13..274db3530 100644 --- a/Moose Development/Moose/AI/AI_A2G_SEAD.lua +++ b/Moose Development/Moose/AI/AI_A2G_SEAD.lua @@ -14,7 +14,8 @@ --- @type AI_A2G_SEAD --- @extends AI.Air_Patrol#AI_AIR_PATROL +-- @extends AI.AI_Air_Patrol#AI_AIR_PATROL +-- @extends AI.AI_Air_Engage#AI_AIR_ENGAGE --- Implements the core functions to SEAD intruders. Use the Engage trigger to intercept intruders. @@ -81,7 +82,7 @@ AI_A2G_SEAD = { function AI_A2G_SEAD:New2( AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) local AI_Air = AI_AIR:New( AIGroup ) - local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) -- #AI_AIR_PATROL + local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) local AI_Air_Engage = AI_AIR_ENGAGE:New( AI_Air_Patrol, AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType ) local self = BASE:Inherit( self, AI_Air_Engage ) diff --git a/Moose Development/Moose/AI/AI_Escort.lua b/Moose Development/Moose/AI/AI_Escort.lua index adf56bcbc..46569b613 100644 --- a/Moose Development/Moose/AI/AI_Escort.lua +++ b/Moose Development/Moose/AI/AI_Escort.lua @@ -199,13 +199,6 @@ AI_ESCORT = { -- @field Functional.Detection#DETECTION_AREAS AI_ESCORT.Detection = nil ---- MENUPARAM type --- @type MENUPARAM --- @field #AI_ESCORT ParamSelf --- @field #Distance ParamDistance --- @field #function ParamFunction --- @field #string ParamMessage - --- AI_ESCORT class constructor for an AI group -- @param #AI_ESCORT self -- @param Wrapper.Client#CLIENT EscortUnit The client escorted by the EscortGroup. diff --git a/Moose Development/Moose/AI/AI_Formation.lua b/Moose Development/Moose/AI/AI_Formation.lua index 06b14d271..bea05f9f9 100644 --- a/Moose Development/Moose/AI/AI_Formation.lua +++ b/Moose Development/Moose/AI/AI_Formation.lua @@ -164,15 +164,6 @@ AI_FORMATION.__Enum.ReportType = { Ground = "G", } - - ---- MENUPARAM type --- @type MENUPARAM --- @field #AI_FORMATION ParamSelf --- @field #number ParamDistance --- @field #function ParamFunction --- @field #string ParamMessage - --- AI_FORMATION class constructor for an AI group -- @param #AI_FORMATION self -- @param Wrapper.Unit#UNIT FollowUnit The UNIT leading the FolllowGroupSet.