weyne/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-08-15 10:47:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into issue437

Browse Source
This commit is contained in:
Grey-Echo
2017-04-22 15:21:43 +02:00
parent f1a9029bc6 cb50facd9a
commit 7bb60f51bb
23 changed files with 1056 additions and 240 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
Moose Development/Moose/Core/Set.lua
View File

@@ -2619,7 +2619,7 @@ end
--- @type SET_CARGO
-- @extends Core.Set#SET_BASE
--- # SET_CARGO class, extends @{Set#SET_BASE}
--- # (R2.1) SET_CARGO class, extends @{Set#SET_BASE}
--
-- Mission designers can use the @{Set#SET_CARGO} class to build sets of cargos optionally belonging to certain:
--
@@ -2681,7 +2681,7 @@ SET_CARGO = {
}
--- Creates a new SET_CARGO object, building a set of cargos belonging to a coalitions and categories.
--- (R2.1) Creates a new SET_CARGO object, building a set of cargos belonging to a coalitions and categories.
-- @param #SET_CARGO self
-- @return #SET_CARGO self
-- @usage
@@ -2694,7 +2694,7 @@ function SET_CARGO:New()
return self
end
--- Add CARGOs to SET_CARGO.
--- (R2.1) Add CARGOs to SET_CARGO.
-- @param Core.Set#SET_CARGO self
-- @param #string AddCargoNames A single name or an array of CARGO names.
-- @return self
@@ -2709,7 +2709,7 @@ function SET_CARGO:AddCargosByName( AddCargoNames )
return self
end
--- Remove CARGOs from SET_CARGO.
--- (R2.1) Remove CARGOs from SET_CARGO.
-- @param Core.Set#SET_CARGO self
-- @param Wrapper.Cargo#CARGO RemoveCargoNames A single name or an array of CARGO names.
-- @return self
@@ -2725,7 +2725,7 @@ function SET_CARGO:RemoveCargosByName( RemoveCargoNames )
end
--- Finds a Cargo based on the Cargo Name.
--- (R2.1) Finds a Cargo based on the Cargo Name.
-- @param #SET_CARGO self
-- @param #string CargoName
-- @return Wrapper.Cargo#CARGO The found Cargo.
@@ -2737,7 +2737,7 @@ end
--- Builds a set of cargos of coalitions.
--- (R2.1) Builds a set of cargos of coalitions.
-- Possible current coalitions are red, blue and neutral.
-- @param #SET_CARGO self
-- @param #string Coalitions Can take the following values: "red", "blue", "neutral".
@@ -2755,7 +2755,7 @@ function SET_CARGO:FilterCoalitions( Coalitions )
return self
end
--- Builds a set of cargos of defined cargo types.
--- (R2.1) Builds a set of cargos of defined cargo types.
-- Possible current types are those types known within DCS world.
-- @param #SET_CARGO self
-- @param #string Types Can take those type strings known within DCS world.
@@ -2774,7 +2774,7 @@ function SET_CARGO:FilterTypes( Types )
end
--- Builds a set of cargos of defined countries.
--- (R2.1) Builds a set of cargos of defined countries.
-- Possible current countries are those known within DCS world.
-- @param #SET_CARGO self
-- @param #string Countries Can take those country strings known within DCS world.
@@ -2793,7 +2793,7 @@ function SET_CARGO:FilterCountries( Countries )
end
--- Builds a set of cargos of defined cargo prefixes.
--- (R2.1) Builds a set of cargos of defined cargo prefixes.
-- All the cargos starting with the given prefixes will be included within the set.
-- @param #SET_CARGO self
-- @param #string Prefixes The prefix of which the cargo name starts with.
@@ -2813,7 +2813,7 @@ end
--- Starts the filtering.
--- (R2.1) Starts the filtering.
-- @param #SET_CARGO self
-- @return #SET_CARGO self
function SET_CARGO:FilterStart()
@@ -2829,7 +2829,7 @@ function SET_CARGO:FilterStart()
end
--- Handles the Database to check on an event (birth) that the Object was added in the Database.
--- (R2.1) Handles the Database to check on an event (birth) that the Object was added in the Database.
-- This is required, because sometimes the _DATABASE birth event gets called later than the SET_BASE birth event!
-- @param #SET_CARGO self
-- @param Core.Event#EVENTDATA Event
@@ -2841,7 +2841,7 @@ function SET_CARGO:AddInDatabase( Event )
return Event.IniDCSUnitName, self.Database[Event.IniDCSUnitName]
end
--- Handles the Database to check on any event that Object exists in the Database.
--- (R2.1) Handles the Database to check on any event that Object exists in the Database.
-- This is required, because sometimes the _DATABASE event gets called later than the SET_BASE event or vise versa!
-- @param #SET_CARGO self
-- @param Core.Event#EVENTDATA Event
@@ -2853,7 +2853,7 @@ function SET_CARGO:FindInDatabase( Event )
return Event.IniDCSUnitName, self.Database[Event.IniDCSUnitName]
end
--- Iterate the SET_CARGO and call an interator function for each CARGO, providing the CARGO and optional parameters.
--- (R2.1) Iterate the SET_CARGO and call an interator function for each CARGO, providing the CARGO and optional parameters.
-- @param #SET_CARGO self
-- @param #function IteratorFunction The function that will be called when there is an alive CARGO in the SET_CARGO. The function needs to accept a CARGO parameter.
-- @return #SET_CARGO self
@@ -2865,7 +2865,7 @@ function SET_CARGO:ForEachCargo( IteratorFunction, ... )
return self
end
--- Iterate the SET_CARGO while identifying the nearest @{Cargo#CARGO} from a @{Point#POINT_VEC2}.
--- (R2.1) Iterate the SET_CARGO while identifying the nearest @{Cargo#CARGO} from a @{Point#POINT_VEC2}.
-- @param #SET_CARGO self
-- @param Core.Point#POINT_VEC2 PointVec2 A @{Point#POINT_VEC2} object from where to evaluate the closest @{Cargo#CARGO}.
-- @return Wrapper.Cargo#CARGO The closest @{Cargo#CARGO}.
@@ -2878,7 +2878,7 @@ end
---
--- (R2.1)
-- @param #SET_CARGO self
-- @param AI.AI_Cargo#AI_CARGO MCargo
-- @return #SET_CARGO self
@@ -2932,7 +2932,7 @@ function SET_CARGO:IsIncludeObject( MCargo )
return MCargoInclude
end
--- Handles the OnEventNewCargo event for the Set.
--- (R2.1) Handles the OnEventNewCargo event for the Set.
-- @param #SET_CARGO self
-- @param Core.Event#EVENTDATA EventData
function SET_CARGO:OnEventNewCargo( EventData )
@@ -2944,7 +2944,7 @@ function SET_CARGO:OnEventNewCargo( EventData )
end
end
--- Handles the OnDead or OnCrash event for alive units set.
--- (R2.1) Handles the OnDead or OnCrash event for alive units set.
-- @param #SET_CARGO self
-- @param Core.Event#EVENTDATA EventData
function SET_CARGO:OnEventDeleteCargo( EventData )