From d92d2d07c590b14546195c71e08f759729e5f7c6 Mon Sep 17 00:00:00 2001 From: kaltokri Date: Tue, 31 Oct 2023 15:21:15 +0100 Subject: [PATCH] Fixed broken links --- Moose Development/Moose/AI/AI_Air_Engage.lua | 22 ++----------------- Moose Development/Moose/Cargo/Cargo.lua | 4 ++-- Moose Development/Moose/Core/Message.lua | 2 +- Moose Development/Moose/Core/Zone.lua | 10 ++++----- .../Moose/Functional/Suppression.lua | 4 ++-- .../Moose/Functional/ZoneGoalCargo.lua | 2 +- Moose Development/Moose/Sound/SRS.lua | 4 ++-- Moose Development/Moose/Tasking/Task.lua | 2 +- .../Moose/Tasking/Task_Capture_Dispatcher.lua | 2 +- .../Moose/Tasking/Task_Cargo_Dispatcher.lua | 6 ++--- .../Moose/Wrapper/Controllable.lua | 6 ++--- .../Moose/Wrapper/Positionable.lua | 8 +++---- Moose Development/Moose/Wrapper/Storage.lua | 2 +- 13 files changed, 28 insertions(+), 46 deletions(-) diff --git a/Moose Development/Moose/AI/AI_Air_Engage.lua b/Moose Development/Moose/AI/AI_Air_Engage.lua index f5a7b2d44..7fcc68075 100644 --- a/Moose Development/Moose/AI/AI_Air_Engage.lua +++ b/Moose Development/Moose/AI/AI_Air_Engage.lua @@ -19,42 +19,26 @@ --- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders. -- --- ![Process](..\Presentations\AI_GCI\Dia3.JPG) --- -- The AI_AIR_ENGAGE is assigned a @{Wrapper.Group} and this must be done before the AI_AIR_ENGAGE 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_AIR_ENGAGE constructor -- -- * @{#AI_AIR_ENGAGE.New}(): Creates a new AI_AIR_ENGAGE 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. @@ -62,10 +46,8 @@ -- Use the method @{AI.AI_GCI#AI_AIR_ENGAGE.SetEngageRange}() to define that range. -- -- ## 4. Set the Zone of Engagement --- --- ![Zone](..\Presentations\AI_GCI\Dia12.JPG) --- --- An optional @{Core.Zone} can be set, +-- +-- 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_AIR_ENGAGE.SetEngageZone}() to define that Zone. -- diff --git a/Moose Development/Moose/Cargo/Cargo.lua b/Moose Development/Moose/Cargo/Cargo.lua index 462259b86..23c5fbce1 100644 --- a/Moose Development/Moose/Cargo/Cargo.lua +++ b/Moose Development/Moose/Cargo/Cargo.lua @@ -86,7 +86,7 @@ -- There are also dispatchers that make AI work together to transport cargo automatically!!! -- -- - @{AI.AI_Cargo_Dispatcher_APC} derived classes will create for your dynamic cargo handlers controlled by AI ground vehicle groups (APCs) to transport cargo between sites. --- - @{AI.AI_Cargo_Dispatcher_Helicopters} derived classes will create for your dynamic cargo handlers controlled by AI helicopter groups to transport cargo between sites. +-- - @{AI.AI_Cargo_Dispatcher_Helicopter} derived classes will create for your dynamic cargo handlers controlled by AI helicopter groups to transport cargo between sites. -- -- ## 3.3) Cargo transportation tasking. -- @@ -398,7 +398,7 @@ do -- CARGO -- -- * AI Armoured Personnel Carriers to transport cargo and engage in battles, using the @{AI.AI_Cargo_APC#AI_CARGO_APC} class. -- * AI Helicopters to transport cargo, using the @{AI.AI_Cargo_Helicopter#AI_CARGO_HELICOPTER} class. - -- * AI Planes to transport cargo, using the @{AI.AI_Cargo_Plane#AI_CARGO_PLANE} class. + -- * AI Planes to transport cargo, using the @{AI.AI_Cargo_Airplane#AI_CARGO_AIRPLANE} class. -- * AI Ships is planned. -- -- The above cargo classes are also used by the TASK\_CARGO\_ classes to allow human players to transport cargo as part of a tasking: diff --git a/Moose Development/Moose/Core/Message.lua b/Moose Development/Moose/Core/Message.lua index 4d1d5d501..5bedc8fa8 100644 --- a/Moose Development/Moose/Core/Message.lua +++ b/Moose Development/Moose/Core/Message.lua @@ -127,7 +127,7 @@ end --- Creates a new MESSAGE object of a certain type. -- 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. +-- You must use the functions @{Core.Message#ToClient} or @{Core.Message#ToCoalition} or @{Core.Message#ToAll} to send these Messages to the respective recipients. -- The message display times are automatically defined based on the timing settings in the @{Core.Settings} menu. -- @param self -- @param #string MessageText is the text of the Message. diff --git a/Moose Development/Moose/Core/Zone.lua b/Moose Development/Moose/Core/Zone.lua index 175e3c660..1760a1f76 100644 --- a/Moose Development/Moose/Core/Zone.lua +++ b/Moose Development/Moose/Core/Zone.lua @@ -1057,11 +1057,11 @@ end --- Scan the zone for the presence of units of the given ObjectCategories. -- Note that **only after** a zone has been scanned, the zone can be evaluated by: -- --- * @{ZONE_RADIUS.IsAllInZoneOfCoalition}(): Scan the presence of units in the zone of a coalition. --- * @{ZONE_RADIUS.IsAllInZoneOfOtherCoalition}(): Scan the presence of units in the zone of an other coalition. --- * @{ZONE_RADIUS.IsSomeInZoneOfCoalition}(): Scan if there is some presence of units in the zone of the given coalition. --- * @{ZONE_RADIUS.IsNoneInZoneOfCoalition}(): Scan if there isn't any presence of units in the zone of an other coalition than the given one. --- * @{ZONE_RADIUS.IsNoneInZone}(): Scan if the zone is empty. +-- * @{Core.Zone#ZONE_RADIUS.IsAllInZoneOfCoalition}(): Scan the presence of units in the zone of a coalition. +-- * @{Core.Zone#ZONE_RADIUS.IsAllInZoneOfOtherCoalition}(): Scan the presence of units in the zone of an other coalition. +-- * @{Core.Zone#ZONE_RADIUS.IsSomeInZoneOfCoalition}(): Scan if there is some presence of units in the zone of the given coalition. +-- * @{Core.Zone#ZONE_RADIUS.IsNoneInZoneOfCoalition}(): Scan if there isn't any presence of units in the zone of an other coalition than the given one. +-- * @{Core.Zone#ZONE_RADIUS.IsNoneInZone}(): Scan if the zone is empty. -- @param #ZONE_RADIUS 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/Suppression.lua b/Moose Development/Moose/Functional/Suppression.lua index 8c6b88a93..d93959990 100644 --- a/Moose Development/Moose/Functional/Suppression.lua +++ b/Moose Development/Moose/Functional/Suppression.lua @@ -33,9 +33,9 @@ -- -- === -- --- ### Author: **[funkyfranky](https://forums.eagle.ru/member.php?u=115026)** +-- ### Author: **funkyfranky** -- --- ### Contributions: [FlightControl](https://forums.eagle.ru/member.php?u=89536) +-- ### Contributions: FlightControl -- -- === -- diff --git a/Moose Development/Moose/Functional/ZoneGoalCargo.lua b/Moose Development/Moose/Functional/ZoneGoalCargo.lua index d957130da..bc9f8c003 100644 --- a/Moose Development/Moose/Functional/ZoneGoalCargo.lua +++ b/Moose Development/Moose/Functional/ZoneGoalCargo.lua @@ -61,7 +61,7 @@ do -- ZoneGoal --- ZONE_GOAL_CARGO Constructor. -- @param #ZONE_GOAL_CARGO self -- @param Core.Zone#ZONE Zone A @{Core.Zone} object with the goal to be achieved. - -- @param DCSCoalition.DCSCoalition#coalition Coalition The initial coalition owning the zone. + -- @param #number Coalition The initial coalition owning the zone. -- @return #ZONE_GOAL_CARGO function ZONE_GOAL_CARGO:New( Zone, Coalition ) diff --git a/Moose Development/Moose/Sound/SRS.lua b/Moose Development/Moose/Sound/SRS.lua index eda0e8504..b16bc01c9 100644 --- a/Moose Development/Moose/Sound/SRS.lua +++ b/Moose Development/Moose/Sound/SRS.lua @@ -797,7 +797,7 @@ end --- Play a SOUNDTEXT text-to-speech object. -- @param #MSRS self --- @param Sound.SoundFile#SOUNDTEXT SoundText Sound text. +-- @param Sound.SoundOutput#SOUNDTEXT SoundText Sound text. -- @param #number Delay Delay in seconds, before the sound file is played. -- @return #MSRS self function MSRS:PlaySoundText(SoundText, Delay) @@ -1435,7 +1435,7 @@ end --- Replacement function for @{#MSRS.PlaySoundText} -- @param #MSRS self --- @param Sound.SoundFile#SOUNDTEXT SoundText Sound text. +-- @param Sound.SoundOutput#SOUNDTEXT SoundText Sound text. -- @param #number Delay Delay in seconds, before the sound file is played. -- @return #MSRS self MSRS_BACKEND_DCSGRPC.Functions.PlaySoundText = function (self, SoundText, Delay) diff --git a/Moose Development/Moose/Tasking/Task.lua b/Moose Development/Moose/Tasking/Task.lua index ad760d83d..abaabf286 100644 --- a/Moose Development/Moose/Tasking/Task.lua +++ b/Moose Development/Moose/Tasking/Task.lua @@ -1773,7 +1773,7 @@ do -- Links --- Set detection of a task -- @param #TASK self - -- @param Function.Detection#DETECTION_BASE Detection + -- @param Functional.Detection#DETECTION_BASE Detection -- @param DetectedItem -- @return #TASK function TASK:SetDetection( Detection, DetectedItem ) diff --git a/Moose Development/Moose/Tasking/Task_Capture_Dispatcher.lua b/Moose Development/Moose/Tasking/Task_Capture_Dispatcher.lua index 1cf999b8c..d458c6100 100644 --- a/Moose Development/Moose/Tasking/Task_Capture_Dispatcher.lua +++ b/Moose Development/Moose/Tasking/Task_Capture_Dispatcher.lua @@ -245,7 +245,7 @@ do -- TASK_CAPTURE_DISPATCHER -- @param #string TaskPrefix (optional) The prefix of the capture zone task. -- If no TaskPrefix is given, then "Capture" will be used as the TaskPrefix. -- The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPrefix already exists in the task collection. - -- @param Functional.CaptureZoneCoalition#ZONE_CAPTURE_COALITION CaptureZone The zone of the coalition to be captured as the task goal. + -- @param Functional.ZoneCaptureCoalition#ZONE_CAPTURE_COALITION CaptureZone The zone of the coalition to be captured as the task goal. -- @param #string Briefing The briefing of the task to be shown to the player. -- @return Tasking.Task_Capture_Zone#TASK_CAPTURE_ZONE -- @usage diff --git a/Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua b/Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua index 09623e79f..abe4ff439 100644 --- a/Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua +++ b/Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua @@ -144,7 +144,7 @@ do -- TASK_CARGO_DISPATCHER -- -- Note that the name of the cargo is "Engineer Team 1". -- local CargoGroup = CARGO_GROUP:New( PilotGroup, "Workmaterials", "Engineer Team 1", 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 @{Wrapper.Group}s defined that contains the clients of the players. -- -- -- Allocate the Transport, which are the helicopters to retrieve the pilot, that can be manned by players. -- -- The name of these helicopter groups containing one client begins with "Transport", as modelled within the mission editor. @@ -214,7 +214,7 @@ do -- TASK_CARGO_DISPATCHER -- -- The method will create a new CSAR task, and will generate the pilots cargo itself, at the specified coordinate. -- - -- What is first needed, is to have a set of @{Core.Group}s defined that contains the clients of the players. + -- What is first needed, is to have a set of @{Wrapper.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() @@ -686,7 +686,7 @@ do -- TASK_CARGO_DISPATCHER -- @param #string TaskPrefix (optional) The prefix of the transport task. -- This prefix will be appended with a . + a number of 3 digits. -- If no TaskPrefix is given, then "Transport" will be used as the prefix. - -- @param Core.SetCargo#SET_CARGO SetCargo The SetCargo to be transported. + -- @param Core.Set#SET_CARGO SetCargo The SetCargo to be transported. -- @param #string Briefing The briefing of the task transport to be shown to the player. -- @param #boolean Silent If true don't send a message that a new task is available. -- @return Tasking.Task_Cargo_Transport#TASK_CARGO_TRANSPORT diff --git a/Moose Development/Moose/Wrapper/Controllable.lua b/Moose Development/Moose/Wrapper/Controllable.lua index f54f0bfd8..ded42ebfd 100644 --- a/Moose Development/Moose/Wrapper/Controllable.lua +++ b/Moose Development/Moose/Wrapper/Controllable.lua @@ -489,7 +489,7 @@ end --- Return a Combo Task taking an array of Tasks. -- @param #CONTROLLABLE self --- @param DCS#TaskArray DCSTasks Array of @{DCSTasking.Task#Task} +-- @param DCS#TaskArray DCSTasks Array of DCSTasking.Task#Task -- @return DCS#Task function CONTROLLABLE:TaskCombo( DCSTasks ) @@ -2739,7 +2739,7 @@ do -- Route methods -- @param Core.Zone#ZONE Zone The zone where to route to. -- @param #boolean Randomize Defines whether to target point gets randomized within the Zone. -- @param #number Speed The speed in m/s. Default is 5.555 m/s = 20 km/h. - -- @param Base#FORMATION Formation The formation string. + -- @param Core.Base#FORMATION Formation The formation string. function CONTROLLABLE:TaskRouteToZone( Zone, Randomize, Speed, Formation ) self:F2( Zone ) @@ -2799,7 +2799,7 @@ do -- Route methods -- @param #CONTROLLABLE self -- @param DCS#Vec2 Vec2 The Vec2 where to route to. -- @param #number Speed The speed in m/s. Default is 5.555 m/s = 20 km/h. - -- @param Base#FORMATION Formation The formation string. + -- @param Core.Base#FORMATION Formation The formation string. function CONTROLLABLE:TaskRouteToVec2( Vec2, Speed, Formation ) local DCSControllable = self:GetDCSObject() diff --git a/Moose Development/Moose/Wrapper/Positionable.lua b/Moose Development/Moose/Wrapper/Positionable.lua index 57e50c7be..f181cbd23 100644 --- a/Moose Development/Moose/Wrapper/Positionable.lua +++ b/Moose Development/Moose/Wrapper/Positionable.lua @@ -1684,7 +1684,7 @@ do -- Cargo --- Add cargo. -- @param #POSITIONABLE self - -- @param Core.Cargo#CARGO Cargo + -- @param Cargo.Cargo#CARGO Cargo -- @return #POSITIONABLE function POSITIONABLE:AddCargo( Cargo ) self.__.Cargo[Cargo] = Cargo @@ -1700,7 +1700,7 @@ do -- Cargo --- Remove cargo. -- @param #POSITIONABLE self - -- @param Core.Cargo#CARGO Cargo + -- @param Cargo.Cargo#CARGO Cargo -- @return #POSITIONABLE function POSITIONABLE:RemoveCargo( Cargo ) self.__.Cargo[Cargo] = nil @@ -1709,7 +1709,7 @@ do -- Cargo --- Returns if carrier has given cargo. -- @param #POSITIONABLE self - -- @return Core.Cargo#CARGO Cargo + -- @return Cargo.Cargo#CARGO Cargo function POSITIONABLE:HasCargo( Cargo ) return self.__.Cargo[Cargo] end @@ -1733,7 +1733,7 @@ do -- Cargo --- Get cargo item count. -- @param #POSITIONABLE self - -- @return Core.Cargo#CARGO Cargo + -- @return Cargo.Cargo#CARGO Cargo function POSITIONABLE:CargoItemCount() local ItemCount = 0 for CargoName, Cargo in pairs( self.__.Cargo ) do diff --git a/Moose Development/Moose/Wrapper/Storage.lua b/Moose Development/Moose/Wrapper/Storage.lua index be07bb477..4ffc505da 100644 --- a/Moose Development/Moose/Wrapper/Storage.lua +++ b/Moose Development/Moose/Wrapper/Storage.lua @@ -8,7 +8,7 @@ -- -- ## Example Missions: -- --- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/Wrapper%20-%20Storage). +-- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/Wrapper/Storage). -- -- === --