mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-10-29 16:58:06 +00:00
* Documentation fixes. * Update Airboss.lua Escape links. Co-authored-by: TommyC81 <tommyc81@gmail.com>
This commit is contained in:
parent
8fb66ed329
commit
2b3363de40
@ -27,17 +27,17 @@
|
|||||||
-- **Supported Carriers:**
|
-- **Supported Carriers:**
|
||||||
--
|
--
|
||||||
-- * [USS John C. Stennis](https://en.wikipedia.org/wiki/USS_John_C._Stennis) (CVN-74)
|
-- * [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 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 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 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 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]
|
-- * [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) [**WIP**]
|
-- * [HMS Hermes](https://en.wikipedia.org/wiki/HMS_Hermes_(R12\)) (R12) [**WIP**]
|
||||||
-- * [HMS Invincible](https://en.wikipedia.org/wiki/HMS_Invincible_(R05) (R05) [**WIP**]
|
-- * [HMS Invincible](https://en.wikipedia.org/wiki/HMS_Invincible_(R05\)) (R05) [**WIP**]
|
||||||
-- * [USS Tarawa](https://en.wikipedia.org/wiki/USS_Tarawa_(LHA-1)) (LHA-1) [**WIP**]
|
-- * [USS Tarawa](https://en.wikipedia.org/wiki/USS_Tarawa_(LHA-1\)) (LHA-1) [**WIP**]
|
||||||
-- * [USS America](https://en.wikipedia.org/wiki/USS_America_(LHA-6)) (LHA-6) [**WIP**]
|
-- * [USS America](https://en.wikipedia.org/wiki/USS_America_(LHA-6\)) (LHA-6) [**WIP**]
|
||||||
-- * [Juan Carlos I](https://en.wikipedia.org/wiki/Spanish_amphibious_assault_ship_Juan_Carlos_I) (L61) [**WIP**]
|
-- * [Juan Carlos I](https://en.wikipedia.org/wiki/Spanish_amphibious_assault_ship_Juan_Carlos_I) (L61) [**WIP**]
|
||||||
-- * [HMAS Canberra](https://en.wikipedia.org/wiki/HMAS_Canberra_(L02)) (L02) [**WIP**]
|
-- * [HMAS Canberra](https://en.wikipedia.org/wiki/HMAS_Canberra_(L02\)) (L02) [**WIP**]
|
||||||
--
|
--
|
||||||
-- **Supported Aircraft:**
|
-- **Supported Aircraft:**
|
||||||
--
|
--
|
||||||
@ -143,7 +143,7 @@
|
|||||||
-- @field Wrapper.Airbase#AIRBASE airbase Carrier airbase object.
|
-- @field Wrapper.Airbase#AIRBASE airbase Carrier airbase object.
|
||||||
-- @field #table waypoints Waypoint coordinates of carrier.
|
-- @field #table waypoints Waypoint coordinates of carrier.
|
||||||
-- @field #number currentwp Current waypoint, i.e. the one that has been passed last.
|
-- @field #number currentwp Current waypoint, i.e. the one that has been passed last.
|
||||||
-- @field Core.Radio#BEACON beacon Carrier beacon for TACAN and ICLS.
|
-- @field Core.Beacon#BEACON beacon Carrier beacon for TACAN and ICLS.
|
||||||
-- @field #boolean TACANon Automatic TACAN is activated.
|
-- @field #boolean TACANon Automatic TACAN is activated.
|
||||||
-- @field #number TACANchannel TACAN channel.
|
-- @field #number TACANchannel TACAN channel.
|
||||||
-- @field #string TACANmode TACAN mode, i.e. "X" or "Y".
|
-- @field #string TACANmode TACAN mode, i.e. "X" or "Y".
|
||||||
|
|||||||
@ -9,13 +9,13 @@
|
|||||||
-- What are radio communications in DCS?
|
-- What are radio communications in DCS?
|
||||||
--
|
--
|
||||||
-- * Radio transmissions consist of **sound files** that are broadcasted on a specific **frequency** (e.g. 115MHz) and **modulation** (e.g. AM),
|
-- * Radio transmissions consist of **sound files** that are broadcasted on a specific **frequency** (e.g. 115MHz) and **modulation** (e.g. AM),
|
||||||
-- * They can be **subtitled** for a specific **duration**, the **power** in Watts of the transmiter's antenna can be set, and the transmission can be **looped**.
|
-- * They can be **subtitled** for a specific **duration**, the **power** in Watts of the transmitter's antenna can be set, and the transmission can be **looped**.
|
||||||
--
|
--
|
||||||
-- How to supply DCS my own Sound Files?
|
-- How to supply DCS my own Sound Files?
|
||||||
--
|
--
|
||||||
-- * Your sound files need to be encoded in **.ogg** or .wav,
|
-- * Your sound files need to be encoded in **.ogg** or .wav,
|
||||||
-- * Your sound files should be **as tiny as possible**. It is suggested you encode in .ogg with low bitrate and sampling settings,
|
-- * Your sound files should be **as tiny as possible**. It is suggested you encode in .ogg with low bitrate and sampling settings,
|
||||||
-- * They need to be added in .\l10n\DEFAULT\ in you .miz file (wich can be decompressed like a .zip file),
|
-- * They need to be added in .\l10n\DEFAULT\ in you .miz file (which can be decompressed like a .zip file),
|
||||||
-- * For simplicity sake, you can **let DCS' Mission Editor add the file** itself, by creating a new Trigger with the action "Sound to Country", and choosing your sound file and a country you don't use in your mission.
|
-- * For simplicity sake, you can **let DCS' Mission Editor add the file** itself, by creating a new Trigger with the action "Sound to Country", and choosing your sound file and a country you don't use in your mission.
|
||||||
--
|
--
|
||||||
-- Due to weird DCS quirks, **radio communications behave differently** if sent by a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP} or by any other @{Wrapper.Positionable#POSITIONABLE}
|
-- Due to weird DCS quirks, **radio communications behave differently** if sent by a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP} or by any other @{Wrapper.Positionable#POSITIONABLE}
|
||||||
@ -26,7 +26,7 @@
|
|||||||
-- Note that obviously, the **frequency** and the **modulation** of the transmission are important only if the players are piloting an **Advanced System Modelling** enabled aircraft,
|
-- Note that obviously, the **frequency** and the **modulation** of the transmission are important only if the players are piloting an **Advanced System Modelling** enabled aircraft,
|
||||||
-- like the A10C or the Mirage 2000C. They will **hear the transmission** if they are tuned on the **right frequency and modulation** (and if they are close enough - more on that below).
|
-- like the A10C or the Mirage 2000C. They will **hear the transmission** if they are tuned on the **right frequency and modulation** (and if they are close enough - more on that below).
|
||||||
-- If an FC3 aircraft is used, it will **hear every communication, whatever the frequency and the modulation** is set to. The same is true for TACAN beacons. If your aircraft isn't compatible,
|
-- If an FC3 aircraft is used, it will **hear every communication, whatever the frequency and the modulation** is set to. The same is true for TACAN beacons. If your aircraft isn't compatible,
|
||||||
-- you won't hear/be able to use the TACAN beacon informations.
|
-- you won't hear/be able to use the TACAN beacon information.
|
||||||
--
|
--
|
||||||
-- ===
|
-- ===
|
||||||
--
|
--
|
||||||
@ -103,7 +103,7 @@ RADIO = {
|
|||||||
function RADIO:New(Positionable)
|
function RADIO:New(Positionable)
|
||||||
|
|
||||||
-- Inherit base
|
-- Inherit base
|
||||||
local self = BASE:Inherit( self, BASE:New() ) -- Core.Radio#RADIO
|
local self = BASE:Inherit( self, BASE:New() ) -- Sound.Radio#RADIO
|
||||||
self:F(Positionable)
|
self:F(Positionable)
|
||||||
|
|
||||||
if Positionable:GetPointVec2() then -- It's stupid, but the only way I found to make sure positionable is valid
|
if Positionable:GetPointVec2() then -- It's stupid, but the only way I found to make sure positionable is valid
|
||||||
@ -375,7 +375,7 @@ end
|
|||||||
|
|
||||||
|
|
||||||
--- Stops a transmission
|
--- Stops a transmission
|
||||||
-- This function is especially usefull to stop the broadcast of looped transmissions
|
-- This function is especially useful to stop the broadcast of looped transmissions
|
||||||
-- @param #RADIO self
|
-- @param #RADIO self
|
||||||
-- @return #RADIO self
|
-- @return #RADIO self
|
||||||
function RADIO:StopBroadcast()
|
function RADIO:StopBroadcast()
|
||||||
|
|||||||
@ -627,8 +627,8 @@ end
|
|||||||
-- For specific beacons like TACAN use the more convenient @{#BEACON} class.
|
-- For specific beacons like TACAN use the more convenient @{#BEACON} class.
|
||||||
-- Note that a controllable can only have one beacon activated at a time with the execption of ICLS.
|
-- Note that a controllable can only have one beacon activated at a time with the execption of ICLS.
|
||||||
-- @param #CONTROLLABLE self
|
-- @param #CONTROLLABLE self
|
||||||
-- @param Core.Radio#BEACON.Type Type Beacon type (VOR, DME, TACAN, RSBN, ILS etc).
|
-- @param Core.Beacon#BEACON.Type Type Beacon type (VOR, DME, TACAN, RSBN, ILS etc).
|
||||||
-- @param Core.Radio#BEACON.System System Beacon system (VOR, DME, TACAN, RSBN, ILS etc).
|
-- @param Core.Beacon#BEACON.System System Beacon system (VOR, DME, TACAN, RSBN, ILS etc).
|
||||||
-- @param #number Frequency Frequency in Hz the beacon is running on. Use @{#UTILS.TACANToFrequency} to generate a frequency for TACAN beacons.
|
-- @param #number Frequency Frequency in Hz the beacon is running on. Use @{#UTILS.TACANToFrequency} to generate a frequency for TACAN beacons.
|
||||||
-- @param #number UnitID The ID of the unit the beacon is attached to. Useful if more units are in one group.
|
-- @param #number UnitID The ID of the unit the beacon is attached to. Useful if more units are in one group.
|
||||||
-- @param #number Channel Channel the beacon is using. For, e.g. TACAN beacons.
|
-- @param #number Channel Channel the beacon is using. For, e.g. TACAN beacons.
|
||||||
|
|||||||
@ -11,7 +11,7 @@
|
|||||||
-- @module Wrapper.Positionable
|
-- @module Wrapper.Positionable
|
||||||
-- @image Wrapper_Positionable.JPG
|
-- @image Wrapper_Positionable.JPG
|
||||||
|
|
||||||
--- @type POSITIONABLE.__ Methods which are not intended for mission designers, but which are used interally by the moose designer :-)
|
--- @type POSITIONABLE.__ Methods which are not intended for mission designers, but which are used internally by the moose designer :-)
|
||||||
-- @extends Wrapper.Identifiable#IDENTIFIABLE
|
-- @extends Wrapper.Identifiable#IDENTIFIABLE
|
||||||
|
|
||||||
--- @type POSITIONABLE
|
--- @type POSITIONABLE
|
||||||
@ -1366,24 +1366,24 @@ function POSITIONABLE:Message( Message, Duration, Name )
|
|||||||
return nil
|
return nil
|
||||||
end
|
end
|
||||||
|
|
||||||
--- Create a @{Core.Radio#RADIO}, to allow radio transmission for this POSITIONABLE.
|
--- Create a @{Sound.Radio#RADIO}, to allow radio transmission for this POSITIONABLE.
|
||||||
-- Set parameters with the methods provided, then use RADIO:Broadcast() to actually broadcast the message
|
-- Set parameters with the methods provided, then use RADIO:Broadcast() to actually broadcast the message
|
||||||
-- @param #POSITIONABLE self
|
-- @param #POSITIONABLE self
|
||||||
-- @return Core.Radio#RADIO Radio
|
-- @return Sound.Radio#RADIO Radio
|
||||||
function POSITIONABLE:GetRadio()
|
function POSITIONABLE:GetRadio()
|
||||||
self:F2( self )
|
self:F2( self )
|
||||||
return RADIO:New( self )
|
return RADIO:New( self )
|
||||||
end
|
end
|
||||||
|
|
||||||
--- Create a @{Core.Radio#BEACON}, to allow this POSITIONABLE to broadcast beacon signals
|
--- Create a @{Core.Beacon#BEACON}, to allow this POSITIONABLE to broadcast beacon signals.
|
||||||
-- @param #POSITIONABLE self
|
-- @param #POSITIONABLE self
|
||||||
-- @return Core.Radio#RADIO Radio
|
-- @return Core.Beacon#BEACON Beacon
|
||||||
function POSITIONABLE:GetBeacon()
|
function POSITIONABLE:GetBeacon()
|
||||||
self:F2( self )
|
self:F2( self )
|
||||||
return BEACON:New( self )
|
return BEACON:New( self )
|
||||||
end
|
end
|
||||||
|
|
||||||
--- Start Lasing a POSITIONABLE
|
--- Start Lasing a POSITIONABLE.
|
||||||
-- @param #POSITIONABLE self
|
-- @param #POSITIONABLE self
|
||||||
-- @param #POSITIONABLE Target The target to lase.
|
-- @param #POSITIONABLE Target The target to lase.
|
||||||
-- @param #number LaserCode Laser code or random number in [1000, 9999].
|
-- @param #number LaserCode Laser code or random number in [1000, 9999].
|
||||||
@ -1424,7 +1424,7 @@ function POSITIONABLE:LaseCoordinate( Coordinate, LaserCode, Duration )
|
|||||||
return self.Spot
|
return self.Spot
|
||||||
end
|
end
|
||||||
|
|
||||||
--- Stop Lasing a POSITIONABLE
|
--- Stop Lasing a POSITIONABLE.
|
||||||
-- @param #POSITIONABLE self
|
-- @param #POSITIONABLE self
|
||||||
-- @return #POSITIONABLE
|
-- @return #POSITIONABLE
|
||||||
function POSITIONABLE:LaseOff()
|
function POSITIONABLE:LaseOff()
|
||||||
@ -1438,7 +1438,7 @@ function POSITIONABLE:LaseOff()
|
|||||||
return self
|
return self
|
||||||
end
|
end
|
||||||
|
|
||||||
--- Check if the POSITIONABLE is lasing a target
|
--- Check if the POSITIONABLE is lasing a target.
|
||||||
-- @param #POSITIONABLE self
|
-- @param #POSITIONABLE self
|
||||||
-- @return #boolean true if it is lasing a target
|
-- @return #boolean true if it is lasing a target
|
||||||
function POSITIONABLE:IsLasing()
|
function POSITIONABLE:IsLasing()
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user