mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
Fixed case problem for pictures in documentation.
This commit is contained in:
FlightControl
parent
02fe5f6104
commit
0a2cdf999d
@ -1,42 +1,42 @@
|
|||||||
--- Single-Player:**Yes** / Mulit-Player:**Yes** / AI:**Yes** / Human:**No** / Types:**Air** -- **Execute Combat Air Patrol (CAP).**
|
--- Single-Player:**Yes** / Mulit-Player:**Yes** / AI:**Yes** / Human:**No** / Types:**Air** -- **Execute Combat Air Patrol (CAP).**
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
--
|
--
|
||||||
-- ===
|
-- ===
|
||||||
--
|
--
|
||||||
-- # 1) @{#AI_CAP_ZONE} class, extends @{AI.AI_Cap#AI_PATROL_ZONE}
|
-- # 1) @{#AI_CAP_ZONE} class, extends @{AI.AI_CAP#AI_PATROL_ZONE}
|
||||||
--
|
--
|
||||||
-- The @{#AI_CAP_ZONE} class implements the core functions to patrol a @{Zone} by an AI @{Controllable} or @{Group}
|
-- The @{#AI_CAP_ZONE} class implements the core functions to patrol a @{Zone} by an AI @{Controllable} or @{Group}
|
||||||
-- and automatically engage any airborne enemies that are within a certain range or within a certain zone.
|
-- and automatically engage any airborne enemies that are within a certain range or within a certain zone.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- The AI_CAP_ZONE is assigned a @{Group} and this must be done before the AI_CAP_ZONE process can be started using the **Start** event.
|
-- The AI_CAP_ZONE is assigned a @{Group} and this must be done before the AI_CAP_ZONE process can be started using the **Start** event.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- The AI will fly towards the random 3D point within the patrol zone, using a random speed within the given altitude and speed limits.
|
-- 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.
|
-- Upon arrival at the 3D point, a new random 3D point will be selected within the patrol zone using the given limits.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- This cycle will continue.
|
-- This cycle will continue.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
|
-- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- When enemies are detected, the AI will automatically engage the enemy.
|
-- When enemies are detected, the AI will automatically engage the enemy.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
|
-- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
|
||||||
-- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
|
-- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- ## 1.1) AI_CAP_ZONE constructor
|
-- ## 1.1) AI_CAP_ZONE constructor
|
||||||
--
|
--
|
||||||
@ -44,7 +44,7 @@
|
|||||||
--
|
--
|
||||||
-- ## 1.2) AI_CAP_ZONE is a FSM
|
-- ## 1.2) AI_CAP_ZONE is a FSM
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- ### 1.2.1) AI_CAP_ZONE States
|
-- ### 1.2.1) AI_CAP_ZONE States
|
||||||
--
|
--
|
||||||
@ -65,17 +65,17 @@
|
|||||||
--
|
--
|
||||||
-- ## 1.3) Set the Range of Engagement
|
-- ## 1.3) Set the Range of Engagement
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- An optional range can be set in meters,
|
-- An optional range can be set in meters,
|
||||||
-- that will define when the AI will engage with the detected airborne enemy targets.
|
-- 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.
|
-- The range can be beyond or smaller than the range of the Patrol Zone.
|
||||||
-- The range is applied at the position of the AI.
|
-- The range is applied at the position of the AI.
|
||||||
-- Use the method @{AI.AI_Cap#AI_CAP_ZONE.SetEngageRange}() to define that range.
|
-- Use the method @{AI.AI_CAP#AI_CAP_ZONE.SetEngageRange}() to define that range.
|
||||||
--
|
--
|
||||||
-- ## 1.4) Set the Zone of Engagement
|
-- ## 1.4) Set the Zone of Engagement
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- An optional @{Zone} can be set,
|
-- An optional @{Zone} can be set,
|
||||||
-- that will define when the AI will engage with the detected airborne enemy targets.
|
-- that will define when the AI will engage with the detected airborne enemy targets.
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
--- Single-Player:**Yes** / Mulit-Player:**Yes** / AI:**Yes** / Human:**No** / Types:**Air** -- **Provide Close Air Support to friendly ground troops.**
|
--- Single-Player:**Yes** / Mulit-Player:**Yes** / AI:**Yes** / Human:**No** / Types:**Air** -- **Provide Close Air Support to friendly ground troops.**
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
--
|
--
|
||||||
-- ===
|
-- ===
|
||||||
@ -12,35 +12,35 @@
|
|||||||
-- The @{#AI_CAS_ZONE} class implements the core functions to provide Close Air Support in an Engage @{Zone} by an AIR @{Controllable} or @{Group}.
|
-- The @{#AI_CAS_ZONE} class implements the core functions to provide Close Air Support in an Engage @{Zone} by an AIR @{Controllable} or @{Group}.
|
||||||
-- The AI_CAS_ZONE runs a process. It holds an AI in a Patrol Zone and when the AI is commanded to engage, it will fly to an Engage Zone.
|
-- The AI_CAS_ZONE runs a process. It holds an AI in a Patrol Zone and when the AI is commanded to engage, it will fly to an Engage Zone.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- The AI_CAS_ZONE is assigned a @{Group} and this must be done before the AI_CAS_ZONE process can be started through the **Start** event.
|
-- The AI_CAS_ZONE is assigned a @{Group} and this must be done before the AI_CAS_ZONE process can be started through the **Start** event.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- Upon started, The AI will **Route** itself towards the random 3D point within a patrol zone,
|
-- Upon started, The AI will **Route** itself towards the random 3D point within a patrol zone,
|
||||||
-- using a random speed within the given altitude and speed limits.
|
-- 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.
|
-- Upon arrival at the 3D point, a new random 3D point will be selected within the patrol zone using the given limits.
|
||||||
-- This cycle will continue until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
|
-- This cycle will continue until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- When the AI is commanded to provide Close Air Support (through the event **Engage**), the AI will fly towards the Engage Zone.
|
-- When the AI is commanded to provide Close Air Support (through the event **Engage**), the AI will fly towards the Engage Zone.
|
||||||
-- Any target that is detected in the Engage Zone will be reported and will be destroyed by the AI.
|
-- Any target that is detected in the Engage Zone will be reported and will be destroyed by the AI.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- The AI will detect the targets and will only destroy the targets within the Engage Zone.
|
-- The AI will detect the targets and will only destroy the targets within the Engage Zone.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- Every target that is destroyed, is reported< by the AI.
|
-- Every target that is destroyed, is reported< by the AI.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- Note that the AI does not know when the Engage Zone is cleared, and therefore will keep circling in the zone.
|
-- Note that the AI does not know when the Engage Zone is cleared, and therefore will keep circling in the zone.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- Until it is notified through the event **Accomplish**, which is to be triggered by an observing party:
|
-- Until it is notified through the event **Accomplish**, which is to be triggered by an observing party:
|
||||||
--
|
--
|
||||||
@ -50,18 +50,18 @@
|
|||||||
-- * a condition
|
-- * a condition
|
||||||
-- * others ...
|
-- * others ...
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- When the AI has accomplished the CAS, it will fly back to the Patrol Zone.
|
-- When the AI has accomplished the CAS, it will fly back to the Patrol Zone.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- It will keep patrolling there, until it is notified to RTB or move to another CAS Zone.
|
-- It will keep patrolling there, until it is notified to RTB or move to another CAS Zone.
|
||||||
-- It can be notified to go RTB through the **RTB** event.
|
-- It can be notified to go RTB through the **RTB** event.
|
||||||
--
|
--
|
||||||
-- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
|
-- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- # 1.1) AI_CAS_ZONE constructor
|
-- # 1.1) AI_CAS_ZONE constructor
|
||||||
--
|
--
|
||||||
@ -69,7 +69,7 @@
|
|||||||
--
|
--
|
||||||
-- ## 1.2) AI_CAS_ZONE is a FSM
|
-- ## 1.2) AI_CAS_ZONE is a FSM
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- ### 1.2.1) AI_CAS_ZONE States
|
-- ### 1.2.1) AI_CAS_ZONE States
|
||||||
--
|
--
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
--- Single-Player:**Yes** / Mulit-Player:**Yes** / AI:**Yes** / Human:**No** / Types:**Air** -- **Air Patrolling or Staging.**
|
--- Single-Player:**Yes** / Mulit-Player:**Yes** / AI:**Yes** / Human:**No** / Types:**Air** -- **Air Patrolling or Staging.**
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
--
|
--
|
||||||
-- ===
|
-- ===
|
||||||
@ -9,34 +9,34 @@
|
|||||||
--
|
--
|
||||||
-- The @{#AI_PATROL_ZONE} class implements the core functions to patrol a @{Zone} by an AI @{Controllable} or @{Group}.
|
-- The @{#AI_PATROL_ZONE} class implements the core functions to patrol a @{Zone} by an AI @{Controllable} or @{Group}.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- The AI_PATROL_ZONE is assigned a @{Group} and this must be done before the AI_PATROL_ZONE process can be started using the **Start** event.
|
-- The AI_PATROL_ZONE is assigned a @{Group} and this must be done before the AI_PATROL_ZONE process can be started using the **Start** event.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- The AI will fly towards the random 3D point within the patrol zone, using a random speed within the given altitude and speed limits.
|
-- 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.
|
-- Upon arrival at the 3D point, a new random 3D point will be selected within the patrol zone using the given limits.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- This cycle will continue.
|
-- This cycle will continue.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
|
-- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
---- Note that the enemy is not engaged! To model enemy engagement, either tailor the **Detected** event, or
|
---- Note that the enemy is not engaged! To model enemy engagement, either tailor the **Detected** event, or
|
||||||
-- use derived AI_ classes to model AI offensive or defensive behaviour.
|
-- use derived AI_ classes to model AI offensive or defensive behaviour.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
|
-- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
|
||||||
-- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
|
-- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- ## 1.1) AI_PATROL_ZONE constructor
|
-- ## 1.1) AI_PATROL_ZONE constructor
|
||||||
--
|
--
|
||||||
@ -44,7 +44,7 @@
|
|||||||
--
|
--
|
||||||
-- ## 1.2) AI_PATROL_ZONE is a FSM
|
-- ## 1.2) AI_PATROL_ZONE is a FSM
|
||||||
--
|
--
|
||||||
-- 
|
-- 
|
||||||
--
|
--
|
||||||
-- ### 1.2.1) AI_PATROL_ZONE States
|
-- ### 1.2.1) AI_PATROL_ZONE States
|
||||||
--
|
--
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user