Merge pull request #417 from FlightControl-Master/master-enh-327-spawnstatic

Master enh 327 spawnstatic

SPAWNSTATIC is ADDED....

Try the new mission SPS-100 in the MOOSE_MISSIONS repository. Open the SPS-100 - Simple Spawning.lua and check the code (I listed it here):

local ZonePosition = ZONE:New( "Position" )

local SpawnBuilding = SPAWNSTATIC:NewFromStatic( "Building", country.id.GERMANY )
local SpawnBarrack = SPAWNSTATIC:NewFromStatic( "Barrack", country.id.GERMANY )

local ZonePointVec2 = ZonePosition:GetPointVec2()

local Building = SpawnBuilding:SpawnFromZone( ZonePosition, 0 )

for Heading = 0, 360,60 do
  local Radial = Heading * ( math.pi*2 ) / 360
  local x = ZonePointVec2:GetLat() + math.cos( Radial ) * 150
  local y = ZonePointVec2:GetLon() + math.sin( Radial ) * 150
  SpawnBarrack:SpawnFromPointVec2( POINT_VEC2:New( x, y ), Heading + 90 )
end

What this code does is:

    It identifies the Zone "Position" where to do the spawning.
    It creates two SPAWNSTATIC objects, one for a building and one for barracks.
    A building is created in the center of the Zone.
    Barracks are created around the center of the Zone.

A couple of points I would like to ask you to consider:

    For simplicity, I think it is the best to have one SPAWNSTATIC object per Static you want to spawn. => Is this ok?
    The only SPAWNSTATIC constructor working at this moment is NewFromStatic. The other planned constructor is NewFromType, but this will need more work to make.
    Two Spawn methods are created: SpawnFromPointVec2() and SpawnFromZone(). => Is this sufficient???
    There won't be any Init methods... => Is this ok???
    There won't be any Respawn methods... => Is this ok???
    What other Spawn APIs would you like to see... => Please think of the process or things you want to do with Statics....
    The naming of the created statics is the TemplateName#nnnnn, where nnnnn is the index of the static spawned. In the Spawn methods, you can give optionally a new name of the Static, overriding the template name.
    There is a question on Country. Each Static has a country. I can set it for default at the constructor, and optionally, if you really want that, I can allow to give an override CountryID parameter when Spawning (not my preference though, because then you'll get two optional parameters in the Spawn methods, one for the new name, and one for the country => confusing ).
    I see Pikey is looking for an additional check of the ground. To be honest, not so easy to implement and also, what is the value if the MD defines a wrong position???

pls test and consider the questions...

Moose Development/Moose/Core/Database.lua

@@ -44,6 +44,7 @@ DATABASE = {
   Templates = {
     Units = {},
     Groups = {},
+    Statics = {},
     ClientsByName = {},
     ClientsByID = {},
   },
@@ -282,7 +283,7 @@ function DATABASE:Spawn( SpawnTemplate )
   SpawnTemplate.CountryID = nil
   SpawnTemplate.CategoryID = nil
 
-  self:_RegisterTemplate( SpawnTemplate, SpawnCoalitionID, SpawnCategoryID, SpawnCountryID  )
+  self:_RegisterGroupTemplate( SpawnTemplate, SpawnCoalitionID, SpawnCategoryID, SpawnCountryID  )
 
   self:T3( SpawnTemplate )
   coalition.addGroup( SpawnCountryID, SpawnCategoryID, SpawnTemplate )
@@ -318,7 +319,7 @@ end
 -- @param #DATABASE self
 -- @param #table GroupTemplate
 -- @return #DATABASE self
-function DATABASE:_RegisterTemplate( GroupTemplate, CoalitionID, CategoryID, CountryID )
+function DATABASE:_RegisterGroupTemplate( GroupTemplate, CoalitionID, CategoryID, CountryID )
 
   local GroupTemplateName = env.getValueDictByKey(GroupTemplate.name)
   
@@ -396,6 +397,54 @@ function DATABASE:GetGroupTemplate( GroupName )
   return GroupTemplate
 end
 
+--- Private method that registers new Static Templates within the DATABASE Object.
+-- @param #DATABASE self
+-- @param #table GroupTemplate
+-- @return #DATABASE self
+function DATABASE:_RegisterStaticTemplate( StaticTemplate, CoalitionID, CategoryID, CountryID )
+
+  local TraceTable = {}
+
+  local StaticTemplateName = env.getValueDictByKey(StaticTemplate.name)
+  
+  self.Templates.Statics[StaticTemplateName] = self.Templates.Statics[StaticTemplateName] or {}
+  
+  StaticTemplate.CategoryID = CategoryID
+  StaticTemplate.CoalitionID = CoalitionID
+  StaticTemplate.CountryID = CountryID
+  
+  self.Templates.Statics[StaticTemplateName].StaticName = StaticTemplateName
+  self.Templates.Statics[StaticTemplateName].GroupTemplate = StaticTemplate
+  self.Templates.Statics[StaticTemplateName].UnitTemplate = StaticTemplate.units[1]
+  self.Templates.Statics[StaticTemplateName].CategoryID = CategoryID
+  self.Templates.Statics[StaticTemplateName].CoalitionID = CoalitionID
+  self.Templates.Statics[StaticTemplateName].CountryID = CountryID
+
+  
+  TraceTable[#TraceTable+1] = "Static"
+  TraceTable[#TraceTable+1] = self.Templates.Statics[StaticTemplateName].GroupName
+
+  TraceTable[#TraceTable+1] = "Coalition"
+  TraceTable[#TraceTable+1] = self.Templates.Statics[StaticTemplateName].CoalitionID
+  TraceTable[#TraceTable+1] = "Category"
+  TraceTable[#TraceTable+1] = self.Templates.Statics[StaticTemplateName].CategoryID
+  TraceTable[#TraceTable+1] = "Country"
+  TraceTable[#TraceTable+1] = self.Templates.Statics[StaticTemplateName].CountryID
+
+  self:E( TraceTable )
+end
+
+
+--- @param #DATABASE self
+function DATABASE:GetStaticUnitTemplate( StaticName )
+  local StaticTemplate = self.Templates.Statics[StaticName].UnitTemplate
+  StaticTemplate.SpawnCoalitionID = self.Templates.Statics[StaticName].CoalitionID
+  StaticTemplate.SpawnCategoryID = self.Templates.Statics[StaticName].CategoryID
+  StaticTemplate.SpawnCountryID = self.Templates.Statics[StaticName].CountryID
+  return StaticTemplate
+end
+
+
 function DATABASE:GetGroupNameFromUnitName( UnitName )
   return self.Templates.Units[UnitName].GroupName
 end
@@ -725,7 +774,7 @@ function DATABASE:ForEachClient( IteratorFunction, ... )
   return self
 end
 
-
+--- @param #DATABASE self
 function DATABASE:_RegisterTemplates()
   self:F2()
 
@@ -781,11 +830,18 @@ function DATABASE:_RegisterTemplates()
 
                   --self.Units[coa_name][countryName][category] = {}
 
-                  for group_num, GroupTemplate in pairs(obj_type_data.group) do
+                  for group_num, Template in pairs(obj_type_data.group) do
 
-                    if GroupTemplate and GroupTemplate.units and type(GroupTemplate.units) == 'table' then  --making sure again- this is a valid group
-                      self:_RegisterTemplate( 
-                        GroupTemplate, 
+                    if obj_type_name ~= "static" and Template and Template.units and type(Template.units) == 'table' then  --making sure again- this is a valid group
+                      self:_RegisterGroupTemplate( 
+                        Template, 
+                        CoalitionSide, 
+                        _DATABASECategory[string.lower(CategoryName)], 
+                        CountryID 
+                      )
+                    else
+                      self:_RegisterStaticTemplate( 
+                        Template, 
                         CoalitionSide, 
                         _DATABASECategory[string.lower(CategoryName)], 
                         CountryID 

Moose Development/Moose/Core/SpawnStatic.lua

@@ -0,0 +1,178 @@
+--- **Functional** -- Spawn dynamically new @{Static}s in your missions.
+--  
+-- ![Banner Image](..\Presentations\SPAWNSTATIC\SPAWNSTATIC.JPG)
+-- 
+-- ====
+-- 
+-- # Demo Missions
+-- 
+-- ### [SPAWNSTATIC Demo Missions source code]()
+-- 
+-- ### [SPAWNSTATIC Demo Missions, only for beta testers]()
+--
+-- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases)
+-- 
+-- ====
+-- 
+-- # YouTube Channel
+-- 
+-- ### [SPAWNSTATIC YouTube Channel]()
+-- 
+-- ====
+-- 
+-- # **API CHANGE HISTORY**
+-- 
+-- The underlying change log documents the API changes. Please read this carefully. The following notation is used:
+-- 
+--   * **Added** parts are expressed in bold type face.
+--   * _Removed_ parts are expressed in italic type face.
+-- 
+-- Hereby the change log:
+-- 
+-- ===
+-- 
+-- # **AUTHORS and CONTRIBUTIONS**
+-- 
+-- ### Contributions: 
+-- 
+-- ### Authors: 
+-- 
+--   * **FlightControl**: Design & Programming
+-- 
+-- @module SpawnStatic
+
+
+
+--- @type SPAWNSTATIC
+-- @extends Core.Base#BASE
+
+
+--- # SPAWNSTATIC class, extends @{Base#BASE}
+-- 
+-- The SPAWNSTATIC class allows to spawn dynamically new @{Static}s.
+-- 
+-- There are two modes how SPAWNSTATIC can spawn:
+-- 
+--   * Through creating a copy of an existing Template @{Static} as defined in the Mission Editor (ME).
+--   * Through the provision of the type name of the Static.  
+-- 
+-- Spawned @{Static}s get **the same name** as the name of the Template Static, 
+-- or gets the given name when a Static Type is used.  
+-- Newly spawned @{Static}s will get the following naming structure at run-time:
+-- 
+--   * Spawned @{Static}s will have the name _StaticName_#_nnn_, where _StaticName_ is the name of the **Template Static**, 
+--   and _nnn_ is a **counter from 0 to 99999**.
+-- 
+--   
+-- ## SPAWNSTATIC construction methods
+-- 
+-- Create a new SPAWNSTATIC object with the @{#SPAWNSTATIC.NewFromStatic}() or the @{#SPAWNSTATIC.NewFromType}() methods:
+-- 
+--   * @{#SPAWNSTATIC.NewFromStatic}(): Creates a new SPAWNSTATIC object given a name that is used as the base of the naming of each spawned Static.
+--   * @{#SPAWNSTATIC.NewFromType}(): Creates a new SPAWNSTATIC object given a type name and a name to be given when spawned.
+--
+-- ## SPAWNSTATIC **Spawn** methods
+-- 
+-- Groups can be spawned at different times and methods:
+-- 
+--   * @{#SPAWNSTATIC.SpawnInZone}(): Spawn a new group in a @{Zone}.
+--   * @{#SPAWNSTATIC.SpawnFromVec3}(): Spawn a new group from a Vec3 coordinate. (The group will can be spawned at a point in the air).
+--   * @{#SPAWNSTATIC.SpawnFromVec2}(): Spawn a new group from a Vec2 coordinate. (The group will be spawned at land height ).
+--   * @{#SPAWNSTATIC.SpawnFromStatic}(): Spawn a new group from a structure, taking the position of a @{Static}.
+--   * @{#SPAWNSTATIC.SpawnFromUnit}(): Spawn a new group taking the position of a @{Unit}.
+--  
+-- @field #SPAWNSTATIC SPAWNSTATIC
+-- 
+SPAWNSTATIC = {
+  ClassName = "SPAWNSTATIC",
+}
+
+
+--- @type SPAWNSTATIC.SpawnZoneTable
+-- @list <Core.Zone#ZONE_BASE> SpawnZone
+
+
+--- Creates the main object to spawn a @{Static} defined in the ME.
+-- @param #SPAWNSTATIC self
+-- @param #string SpawnTemplatePrefix is the name of the Group in the ME that defines the Template.  Each new group will have the name starting with SpawnTemplatePrefix.
+-- @return #SPAWNSTATIC
+function SPAWNSTATIC:NewFromStatic( SpawnTemplatePrefix, CountryID )
+	local self = BASE:Inherit( self, BASE:New() ) -- #SPAWNSTATIC
+	self:F( { SpawnTemplatePrefix } )
+  
+	local TemplateStatic = StaticObject.getByName( SpawnTemplatePrefix )
+	if TemplateStatic then
+		self.SpawnTemplatePrefix = SpawnTemplatePrefix
+    self.CountryID = CountryID
+		self.SpawnIndex = 0
+	else
+		error( "SPAWNSTATIC:New: There is no group declared in the mission editor with SpawnTemplatePrefix = '" .. SpawnTemplatePrefix .. "'" )
+	end
+
+  self:SetEventPriority( 5 )
+
+	return self
+end
+
+--- Creates the main object to spawn a @{Static} based on a type name.
+-- @param #SPAWNSTATIC self
+-- @param #string SpawnTypeName is the name of the type.
+-- @return #SPAWNSTATIC
+function SPAWNSTATIC:NewFromType( SpawnTypeName, SpawnShapeName, SpawnCategory, CountryID )
+  local self = BASE:Inherit( self, BASE:New() ) -- #SPAWNSTATIC
+  self:F( { SpawnTypeName } )
+  
+  self.SpawnTypeName = SpawnTypeName
+  self.CountryID = CountryID
+  self.SpawnIndex = 0
+
+  self:SetEventPriority( 5 )
+
+  return self
+end
+
+
+--- Creates a new @{Static} from a POINT_VEC2.
+-- @param #SPAWNSTATIC self
+-- @param Core.Point#POINT_VEC2 PointVec2 The 2D coordinate where to spawn the static.
+-- @param #number Heading The heading of the static, which is a number in degrees from 0 to 360.
+-- @param #string (optional) The name of the new static.
+-- @return #SPAWNSTATIC
+function SPAWNSTATIC:SpawnFromPointVec2( PointVec2, Heading, NewName )
+  self:F( { PointVec2, Heading, NewName  } )
+  
+  local CountryName = _DATABASE.COUNTRY_NAME[self.CountryID]
+  
+  local StaticTemplate = _DATABASE:GetStaticUnitTemplate( self.SpawnTemplatePrefix )
+  
+  StaticTemplate.x = PointVec2:GetLat()
+  StaticTemplate.y = PointVec2:GetLon()
+  
+  StaticTemplate.name = NewName or string.format("%s#%05d", self.SpawnTemplatePrefix, self.SpawnIndex )
+  StaticTemplate.heading = ( Heading / 180 ) * math.pi
+  
+  StaticTemplate.CountryID = nil
+  StaticTemplate.CoalitionID = nil
+  StaticTemplate.CategoryID = nil
+  
+  local Static = coalition.addStaticObject( self.CountryID, StaticTemplate )
+  
+  self.SpawnIndex = self.SpawnIndex + 1
+
+  return Static
+end
+
+--- Creates a new @{Static} from a @{Zone}.
+-- @param #SPAWNSTATIC self
+-- @param Core.Zone#ZONE_BASE Zone The Zone where to spawn the static.
+-- @param #number Heading The heading of the static, which is a number in degrees from 0 to 360.
+-- @param #string (optional) The name of the new static.
+-- @return #SPAWNSTATIC
+function SPAWNSTATIC:SpawnFromZone( Zone, Heading, NewName )
+  self:F( { Zone, Heading, NewName  } )
+
+  local Static = self:SpawnFromPointVec2( Zone:GetPointVec2(), Heading, NewName )
+  
+  return Static
+end
+

Moose Development/Moose/Core/Zone.lua

@@ -615,7 +615,7 @@ end
 
 
 
--- @type ZONE
+--- @type ZONE
 -- @extends Core.Zone#ZONE_RADIUS
 
 

Moose Mission Setup/Moose.files

@@ -13,6 +13,7 @@ Core/Point.lua
 Core/Message.lua
 Core/Fsm.lua
 Core/Radio.lua
+Core/SpawnStatic.lua
 
 Wrapper/Object.lua
 Wrapper/Identifiable.lua

Moose Mission Setup/Moose.lua

@@ -1,5 +1,5 @@
 env.info( '*** MOOSE DYNAMIC INCLUDE START *** ' )
-env.info( 'Moose Generation Timestamp: 20170405_0934' )
+env.info( 'Moose Generation Timestamp: 20170409_0720' )
 
 local base = _G
 
@@ -35,6 +35,7 @@ __Moose.Include( 'Core/Point.lua' )
 __Moose.Include( 'Core/Message.lua' )
 __Moose.Include( 'Core/Fsm.lua' )
 __Moose.Include( 'Core/Radio.lua' )
+__Moose.Include( 'Core/SpawnStatic.lua' )
 __Moose.Include( 'Wrapper/Object.lua' )
 __Moose.Include( 'Wrapper/Identifiable.lua' )
 __Moose.Include( 'Wrapper/Positionable.lua' )