FlightControl-Master/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-10-29 16:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
FlightControl 2018-09-22 09:55:40 +02:00
parent 6e67da1672
commit d86419f893
4 changed files with 50 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
Moose Development/Moose/AI/AI_Cargo_Dispatcher.lua
View File

@ -1,6 +1,6 @@
--- **AI** -- (R2.4) - Models the intelligent transportation of infantry and other cargo. --- **AI** -- (R2.4) - Models the intelligent transportation of infantry and other cargo.
-- --
-- **Features:** -- ## Features:
-- --
-- * AI_CARGO_DISPATCHER is the **base class** for: -- * AI_CARGO_DISPATCHER is the **base class** for:
-- --
@ -12,6 +12,17 @@
-- * Dispatches transport tasks to a common set of cargo transporting groups. -- * Dispatches transport tasks to a common set of cargo transporting groups.
-- * Different options can be setup to tweak the cargo transporation behaviour. -- * Different options can be setup to tweak the cargo transporation behaviour.
-- --
-- ===
--
-- ## Test Missions:
--
-- Test missions can be located on the main GITHUB site.
--
-- [FlightControl-Master/MOOSE_MISSIONS/AID - AI Dispatching/AID-CGO - AI Cargo Dispatching/]
-- (https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/AID%20-%20AI%20Dispatching/AID-CGO%20-%20AI%20Cargo%20Dispatching)
--
-- ===
--
-- ## The dispatcher concept -- ## The dispatcher concept
-- --
-- Carrier equipment can be mobilized to intelligently transport infantry and other cargo within the simulation. -- Carrier equipment can be mobilized to intelligently transport infantry and other cargo within the simulation.
@ -20,13 +31,15 @@
-- @{Cargo.Cargo} must be declared within the mission to make the AI_CARGO_DISPATCHER object recognize the cargo. -- @{Cargo.Cargo} must be declared within the mission to make the AI_CARGO_DISPATCHER object recognize the cargo.
-- Please consult the @{Cargo.Cargo} module for more information. -- Please consult the @{Cargo.Cargo} module for more information.
-- --
-- # Why cargo dispatching? --
-- ## Why cargo dispatching?
-- --
-- It provides a realistic way of distributing your army forces around the battlefield, and to provide a quick means of cargo transportation. -- It provides a realistic way of distributing your army forces around the battlefield, and to provide a quick means of cargo transportation.
-- Instead of having troops or cargo to "appear" suddenly at certain locations, the dispatchers will pickup the cargo and transport it. -- Instead of having troops or cargo to "appear" suddenly at certain locations, the dispatchers will pickup the cargo and transport it.
-- It also allows to enforce or retreat your army from certain zones when needed, using helicopters or APCs. -- It also allows to enforce or retreat your army from certain zones when needed, using helicopters or APCs.
-- Airplanes can transport cargo over larger distances between the airfields. -- Airplanes can transport cargo over larger distances between the airfields.
-- --
--
-- ## What is a cargo object then? -- ## What is a cargo object then?
-- --
-- In order to make use of the MOOSE cargo system, you need to **declare** the DCS objects as MOOSE cargo objects! -- In order to make use of the MOOSE cargo system, you need to **declare** the DCS objects as MOOSE cargo objects!
@ -44,12 +57,14 @@
-- For more information, please consult the @{Cargo.Cargo} module documentation. Please read through it, because it will explain how to setup the cargo objects for use -- For more information, please consult the @{Cargo.Cargo} module documentation. Please read through it, because it will explain how to setup the cargo objects for use
-- within your dispatchers. -- within your dispatchers.
-- --
--
-- ## Do I need to do a lot of coding to setup a dispatcher? -- ## Do I need to do a lot of coding to setup a dispatcher?
-- --
-- No! It requires a bit of studying to set it up, but once you understand the different components that use the cargo dispatcher, it becomes very easy. -- No! It requires a bit of studying to set it up, but once you understand the different components that use the cargo dispatcher, it becomes very easy.
-- Also, the dispatchers work in a true dynamic environment. The carriers and cargo, pickup and deploy zones can be created dynamically in your mission, -- Also, the dispatchers work in a true dynamic environment. The carriers and cargo, pickup and deploy zones can be created dynamically in your mission,
-- and will automatically be recognized by the dispatcher. -- and will automatically be recognized by the dispatcher.
-- --
--
-- ## Is the dispatcher causing a lot of CPU overhead? -- ## Is the dispatcher causing a lot of CPU overhead?
-- --
-- A little yes, but once the cargo is properly loaded into the carrier, the CPU consumption is very little. -- A little yes, but once the cargo is properly loaded into the carrier, the CPU consumption is very little.
@ -59,6 +74,7 @@
-- without any performance impact. The amount of helicopters that are active and flying in your simulation influences more the performance than the dispatchers. -- without any performance impact. The amount of helicopters that are active and flying in your simulation influences more the performance than the dispatchers.
-- It really comes down to trying it out and getting experienced with what is possible and what is not (or too much). -- It really comes down to trying it out and getting experienced with what is possible and what is not (or too much).
-- --
--
-- ## Are the dispatchers a "black box" in terms of the logic? -- ## Are the dispatchers a "black box" in terms of the logic?
-- --
-- No. You can tailor the dispatcher mechanisms using event handlers, and create additional logic to enhance the behaviour and dynamism in your own mission. -- No. You can tailor the dispatcher mechanisms using event handlers, and create additional logic to enhance the behaviour and dynamism in your own mission.
@ -69,6 +85,7 @@
-- --
-- * When a carrier is picking up cargo, the *Pickup** event is triggered, and you can inform the coalition of this event, -- * When a carrier is picking up cargo, the *Pickup** event is triggered, and you can inform the coalition of this event,
-- because it is an indication that troops are planned to join. -- because it is an indication that troops are planned to join.
--
-- --
-- ## Are there options that you can set to modify the behaviour of the carries? -- ## Are there options that you can set to modify the behaviour of the carries?
-- --
@ -79,6 +96,7 @@
-- * the height for airborne carriers when they fly to and from pickup and deploy zones. -- * the height for airborne carriers when they fly to and from pickup and deploy zones.
-- * the speed of the carriers. This is an important parameter, because depending on the tactication situation, speed will influence the detection by radars. -- * the speed of the carriers. This is an important parameter, because depending on the tactication situation, speed will influence the detection by radars.
-- --
--
-- ## Can the zones be of any zone type? -- ## Can the zones be of any zone type?
-- --
-- Yes, please ensure that the zones are declared using the @{Core.Zone} classes. -- Yes, please ensure that the zones are declared using the @{Core.Zone} classes.
@ -86,12 +104,6 @@
-- --
-- === -- ===
-- --
-- ### Test Missions
--
-- [AI Cargo Dispatcher test missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/AID%20-%20AI%20Dispatching/AID-CGO%20-%20AI%20Cargo%20Dispatching)
--
-- ===
--
-- ### Author: **FlightControl** -- ### Author: **FlightControl**
-- --
-- === -- ===

11
Moose Development/Moose/AI/AI_Cargo_Dispatcher_APC.lua
View File

@ -1,6 +1,6 @@
--- **AI** -- (2.4) - Models the intelligent transportation of infantry and other cargo using APCs. --- **AI** -- (2.4) - Models the intelligent transportation of infantry and other cargo using APCs.
-- --
-- **Features:** -- ## Features:
-- --
-- * Quickly transport cargo to various deploy zones using ground vehicles (APCs, trucks ...). -- * Quickly transport cargo to various deploy zones using ground vehicles (APCs, trucks ...).
-- * Various @{Cargo.Cargo#CARGO} types can be transported. These are infantry groups and crates. -- * Various @{Cargo.Cargo#CARGO} types can be transported. These are infantry groups and crates.
@ -14,6 +14,15 @@
-- --
-- === -- ===
-- --
-- ## Test Missions:
--
-- Test missions can be located on the main GITHUB site.
--
-- [FlightControl-Master/MOOSE_MISSIONS/AID - AI Dispatching/AID-CGO - AI Cargo Dispatching/]
-- (https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/AID%20-%20AI%20Dispatching/AID-CGO%20-%20AI%20Cargo%20Dispatching)
--
-- ===
--
-- ### Author: **FlightControl** -- ### Author: **FlightControl**
-- --
-- === -- ===

11
Moose Development/Moose/AI/AI_Cargo_Dispatcher_Airplane.lua
View File

@ -1,12 +1,21 @@
--- **AI** -- (R2.4) - Models the intelligent transportation of infantry and other cargo using Planes. --- **AI** -- (R2.4) - Models the intelligent transportation of infantry and other cargo using Planes.
-- --
-- **Features:** -- ## Features:
-- --
-- * The airplanes will fly towards the pickup airbases to pickup the cargo. -- * The airplanes will fly towards the pickup airbases to pickup the cargo.
-- * The airplanes will fly towards the deploy airbases to deploy the cargo. -- * The airplanes will fly towards the deploy airbases to deploy the cargo.
-- --
-- === -- ===
-- --
-- ## Test Missions:
--
-- Test missions can be located on the main GITHUB site.
--
-- [FlightControl-Master/MOOSE_MISSIONS/AID - AI Dispatching/AID-CGO - AI Cargo Dispatching/]
-- (https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/AID%20-%20AI%20Dispatching/AID-CGO%20-%20AI%20Cargo%20Dispatching)
--
-- ===
--
-- ### Author: **FlightControl** -- ### Author: **FlightControl**
-- --
-- === -- ===

11
Moose Development/Moose/AI/AI_Cargo_Dispatcher_Helicopter.lua
View File

@ -1,6 +1,6 @@
--- **AI** -- (2.4) - Models the intelligent transportation of infantry and other cargo using Helicopters. --- **AI** -- (2.4) - Models the intelligent transportation of infantry and other cargo using Helicopters.
-- --
-- **Features:** -- ## Features:
-- --
-- * The helicopters will fly towards the pickup locations to pickup the cargo. -- * The helicopters will fly towards the pickup locations to pickup the cargo.
-- * The helicopters will fly towards the deploy zones to deploy the cargo. -- * The helicopters will fly towards the deploy zones to deploy the cargo.
@ -9,6 +9,15 @@
-- --
-- === -- ===
-- --
-- ## Test Missions:
--
-- Test missions can be located on the main GITHUB site.
--
-- [FlightControl-Master/MOOSE_MISSIONS/AID - AI Dispatching/AID-CGO - AI Cargo Dispatching/]
-- (https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/AID%20-%20AI%20Dispatching/AID-CGO%20-%20AI%20Cargo%20Dispatching)
--
-- ===
--
-- ### Author: **FlightControl** -- ### Author: **FlightControl**
-- --
-- === -- ===