Update Set.lua (#1663)

Additional minor code formatting and typo fixes.
This commit is contained in:
TommyC81 2021-12-13 19:52:01 +04:00 committed by GitHub
parent f29da39dff
commit 058c750bc6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1981,7 +1981,6 @@ do -- SET_UNIT
}, },
} }
--- Get the first unit from the set. --- Get the first unit from the set.
-- @function [parent=#SET_UNIT] GetFirst -- @function [parent=#SET_UNIT] GetFirst
-- @param #SET_UNIT self -- @param #SET_UNIT self
@ -2555,9 +2554,9 @@ do -- SET_UNIT
return UnitThreatLevels return UnitThreatLevels
end end
--- Calculate the maxium A2G threat level of the SET_UNIT. --- Calculate the maximum A2G threat level of the SET_UNIT.
-- @param #SET_UNIT self -- @param #SET_UNIT self
-- @return #number The maximum threatlevel -- @return #number The maximum threat level
function SET_UNIT:CalculateThreatLevelA2G() function SET_UNIT:CalculateThreatLevelA2G()
local MaxThreatLevelA2G = 0 local MaxThreatLevelA2G = 0
@ -3558,7 +3557,7 @@ do -- SET_STATIC
end end
--- Calculate the maxium A2G threat level of the SET_STATIC. --- Calculate the maximum A2G threat level of the SET_STATIC.
-- @param #SET_STATIC self -- @param #SET_STATIC self
-- @return #number The maximum threatlevel -- @return #number The maximum threatlevel
function SET_STATIC:CalculateThreatLevelA2G() function SET_STATIC:CalculateThreatLevelA2G()
@ -3762,7 +3761,6 @@ do -- SET_CLIENT
}, },
} }
--- Creates a new SET_CLIENT object, building a set of clients belonging to a coalitions, categories, countries, types or with defined prefix names. --- Creates a new SET_CLIENT object, building a set of clients belonging to a coalitions, categories, countries, types or with defined prefix names.
-- @param #SET_CLIENT self -- @param #SET_CLIENT self
-- @return #SET_CLIENT -- @return #SET_CLIENT
@ -4986,7 +4984,6 @@ do -- SET_CARGO
-- * @{#SET_CARGO.ForEachCargo}: Calls a function for each cargo it finds within the SET_CARGO. -- * @{#SET_CARGO.ForEachCargo}: Calls a function for each cargo it finds within the SET_CARGO.
-- --
-- @field #SET_CARGO SET_CARGO -- @field #SET_CARGO SET_CARGO
--
SET_CARGO = { SET_CARGO = {
ClassName = "SET_CARGO", ClassName = "SET_CARGO",
Cargos = {}, Cargos = {},
@ -5413,7 +5410,8 @@ do -- SET_ZONE
Filter = { Filter = {
Prefixes = nil, Prefixes = nil,
}, },
FilterMeta = {}, FilterMeta = {
},
} }
--- Creates a new SET_ZONE object, building a set of zones. --- Creates a new SET_ZONE object, building a set of zones.
@ -5674,7 +5672,7 @@ do -- SET_ZONE
end end
--- Validate if a coordinate is in one of the zones in the set. --- Validate if a coordinate is in one of the zones in the set.
-- Returns the ZONE object where the coordiante is located. -- Returns the ZONE object where the coordinate is located.
-- If zones overlap, the first zone that validates the test is returned. -- If zones overlap, the first zone that validates the test is returned.
-- @param #SET_ZONE self -- @param #SET_ZONE self
-- @param Core.Point#COORDINATE Coordinate The coordinate to be searched. -- @param Core.Point#COORDINATE Coordinate The coordinate to be searched.
@ -6346,7 +6344,7 @@ do -- SET_OPSGROUP
return self return self
end end
--- Builds a set of groups out of aicraft category (planes and helicopters). --- Builds a set of groups out of aircraft category (planes and helicopters).
-- @param #SET_OPSGROUP self -- @param #SET_OPSGROUP self
-- @return #SET_OPSGROUP self -- @return #SET_OPSGROUP self
function SET_OPSGROUP:FilterCategoryAircraft() function SET_OPSGROUP:FilterCategoryAircraft()