#clarifications

This commit is contained in:
Applevangelist 2023-12-03 15:34:39 +01:00
parent f6d3e01a9f
commit 1f4721b10e
2 changed files with 19 additions and 3 deletions

View File

@ -1065,6 +1065,13 @@ do
self:FilterActive( false ) self:FilterActive( false )
return self return self
--- Filter the set once
-- @function [parent=#SET_GROUP] FilterOnce
-- @param #SET_GROUP self
-- @return #SET_GROUP self
end end
--- Get a *new* set that only contains alive groups. --- Get a *new* set that only contains alive groups.
@ -1976,6 +1983,7 @@ do
--- Get the closest group of the set with respect to a given reference coordinate. Optionally, only groups of given coalitions are considered in the search. --- Get the closest group of the set with respect to a given reference coordinate. Optionally, only groups of given coalitions are considered in the search.
-- @param #SET_GROUP self -- @param #SET_GROUP self
-- @param Core.Point#COORDINATE Coordinate Reference Coordinate from which the closest group is determined. -- @param Core.Point#COORDINATE Coordinate Reference Coordinate from which the closest group is determined.
-- @param #table Coalitions (Optional) Table of coalition #number entries to filter for.
-- @return Wrapper.Group#GROUP The closest group (if any). -- @return Wrapper.Group#GROUP The closest group (if any).
-- @return #number Distance in meters to the closest group. -- @return #number Distance in meters to the closest group.
function SET_GROUP:GetClosestGroup(Coordinate, Coalitions) function SET_GROUP:GetClosestGroup(Coordinate, Coalitions)

View File

@ -1234,7 +1234,7 @@ function RANGE:SetSRS(PathToSRS, Port, Coalition, Frequency, Modulation, Volume,
return self return self
end end
--- (SRS) Set range control frequency and voice. --- (SRS) Set range control frequency and voice. Use `RANGE:SetSRS()` once first before using this function.
-- @param #RANGE self -- @param #RANGE self
-- @param #number frequency Frequency in MHz. Default 256 MHz. -- @param #number frequency Frequency in MHz. Default 256 MHz.
-- @param #number modulation Modulation, defaults to radio.modulation.AM. -- @param #number modulation Modulation, defaults to radio.modulation.AM.
@ -1244,6 +1244,10 @@ end
-- @param #string relayunitname Name of the unit used for transmission location. -- @param #string relayunitname Name of the unit used for transmission location.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetSRSRangeControl( frequency, modulation, voice, culture, gender, relayunitname ) function RANGE:SetSRSRangeControl( frequency, modulation, voice, culture, gender, relayunitname )
if not self.instructmsrs then
self:E(self.lid.."Use myrange:SetSRS() once first before using myrange:SetSRSRangeControl!")
return self
end
self.rangecontrolfreq = frequency or 256 self.rangecontrolfreq = frequency or 256
self.controlmsrs:SetFrequencies(self.rangecontrolfreq) self.controlmsrs:SetFrequencies(self.rangecontrolfreq)
self.controlmsrs:SetModulations(modulation or radio.modulation.AM) self.controlmsrs:SetModulations(modulation or radio.modulation.AM)
@ -1259,7 +1263,7 @@ function RANGE:SetSRSRangeControl( frequency, modulation, voice, culture, gender
return self return self
end end
--- (SRS) Set range instructor frequency and voice. --- (SRS) Set range instructor frequency and voice. Use `RANGE:SetSRS()` once first before using this function.
-- @param #RANGE self -- @param #RANGE self
-- @param #number frequency Frequency in MHz. Default 305 MHz. -- @param #number frequency Frequency in MHz. Default 305 MHz.
-- @param #number modulation Modulation, defaults to radio.modulation.AM. -- @param #number modulation Modulation, defaults to radio.modulation.AM.
@ -1269,6 +1273,10 @@ end
-- @param #string relayunitname Name of the unit used for transmission location. -- @param #string relayunitname Name of the unit used for transmission location.
-- @return #RANGE self -- @return #RANGE self
function RANGE:SetSRSRangeInstructor( frequency, modulation, voice, culture, gender, relayunitname ) function RANGE:SetSRSRangeInstructor( frequency, modulation, voice, culture, gender, relayunitname )
if not self.instructmsrs then
self:E(self.lid.."Use myrange:SetSRS() once first before using myrange:SetSRSRangeInstructor!")
return self
end
self.instructorfreq = frequency or 305 self.instructorfreq = frequency or 305
self.instructmsrs:SetFrequencies(self.instructorfreq) self.instructmsrs:SetFrequencies(self.instructorfreq)
self.instructmsrs:SetModulations(modulation or radio.modulation.AM) self.instructmsrs:SetModulations(modulation or radio.modulation.AM)