mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2026-07-27 00:03:44 +00:00
Frank
326 lines
11 KiB
Lua
326 lines
11 KiB
Lua
--- **Core** - Spawn statics.
|
|
--
|
|
-- ===
|
|
--
|
|
-- ## Features:
|
|
--
|
|
-- * Spawn new statics from a static already defined using the mission editor.
|
|
-- * Spawn new statics from a given template.
|
|
-- * Spawn with a custom heading and location.
|
|
-- * Spawn within a zone.
|
|
--
|
|
-- ===
|
|
--
|
|
-- # Demo Missions
|
|
--
|
|
-- ### [SPAWNSTATIC Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/SPS - Spawning Statics)
|
|
--
|
|
-- ### [SPAWNSTATIC Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/SPS%20-%20Spawning%20Statics)
|
|
--
|
|
-- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases)
|
|
--
|
|
-- ===
|
|
--
|
|
-- # YouTube Channel
|
|
--
|
|
-- ### [SPAWNSTATIC YouTube Channel]()
|
|
--
|
|
-- ===
|
|
--
|
|
-- ### Author: **FlightControl**
|
|
-- ### Contributions: **funkyfranky**
|
|
--
|
|
-- ===
|
|
--
|
|
-- @module Core.SpawnStatic
|
|
-- @image Core_Spawnstatic.JPG
|
|
|
|
|
|
|
|
--- @type SPAWNSTATIC
|
|
-- @field #string SpawnTemplatePrefix Name of the template group.
|
|
-- @field #number CountryID Country ID.
|
|
-- @field #number CoalitionID Coalition ID.
|
|
-- @field #number CategoryID Category ID.
|
|
-- @field #number SpawnIndex Running number increased with each new Spawn.
|
|
-- @field Wrapper.Unit#UNIT InitLinkUnit The unit the static is liked to.
|
|
-- @field #number InitOffsetX Link offset X coordinate.
|
|
-- @field #number InitOffsetY Link offset Y coordinate.
|
|
-- @field #number InitOffsetAngle Link offset angle in degrees.
|
|
-- @field #number InitLivery Livery for aircraft.
|
|
--
|
|
-- @extends Core.Base#BASE
|
|
|
|
|
|
--- Allows to spawn dynamically new @{Static}s.
|
|
-- Through creating a copy of an existing static object template as defined in the Mission Editor (ME),
|
|
-- SPAWNSTATIC can retireve the properties of the defined static object template (like type, category etc), and "copy"
|
|
-- these properties to create a new static object and place it at the desired coordinate.
|
|
--
|
|
-- New spawned @{Static}s get **the same name** as the name of the template Static,
|
|
-- or gets the given name when a new name is provided at the Spawn method.
|
|
-- By default, spawned @{Static}s will follow a naming convention 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}():
|
|
--
|
|
-- * @{#SPAWNSTATIC.NewFromStatic}(): Creates a new SPAWNSTATIC object given a name that is used as the base of the naming of each spawned Static.
|
|
--
|
|
-- ## **Spawn** methods
|
|
--
|
|
-- Groups can be spawned at different times and methods:
|
|
--
|
|
-- * @{#SPAWNSTATIC.SpawnFromPointVec2}(): Spawn a new group from a POINT_VEC2 coordinate.
|
|
-- (The group will be spawned at land height ).
|
|
-- * @{#SPAWNSTATIC.SpawnFromZone}(): Spawn a new group in a @{Zone}.
|
|
--
|
|
-- @field #SPAWNSTATIC SPAWNSTATIC
|
|
--
|
|
SPAWNSTATIC = {
|
|
ClassName = "SPAWNSTATIC",
|
|
}
|
|
|
|
--- Creates the main object to spawn a @{Static} defined in the mission editor (ME).
|
|
-- @param #SPAWNSTATIC self
|
|
-- @param #string SpawnTemplateName Name of the static object in the ME. Each new static will have the name starting with SpawnTemplatePrefix.
|
|
-- @param DCS#country.id SpawnCountryID (Optional) The ID of the country.
|
|
-- @param DCS#coalition.side SpawnCoalitionID (Optional) The ID of the coalition.
|
|
-- @return #SPAWNSTATIC self
|
|
function SPAWNSTATIC:NewFromStatic(SpawnTemplateName, SpawnCountryID)
|
|
|
|
local self = BASE:Inherit( self, BASE:New() ) -- #SPAWNSTATIC
|
|
self:F( { SpawnTemplatePrefix } )
|
|
|
|
local TemplateStatic, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( SpawnTemplatePrefix )
|
|
|
|
if TemplateStatic then
|
|
self.SpawnTemplatePrefix = SpawnTemplatePrefix
|
|
self.TemplateStaticUnit = UTILS.DeepCopy(TemplateStatic.units[1])
|
|
self.CountryID = SpawnCountryID or CountryID
|
|
self.CategoryID = CategoryID
|
|
self.CoalitionID = SpawnCoalitionID or CoalitionID
|
|
self.SpawnIndex = 0
|
|
else
|
|
error( "SPAWNSTATIC:New: There is no static declared in the mission editor with SpawnTemplatePrefix = '" .. SpawnTemplatePrefix .. "'" )
|
|
end
|
|
|
|
self:SetEventPriority( 5 )
|
|
|
|
return self
|
|
end
|
|
|
|
--- Init link to a unit.
|
|
-- @param #SPAWNSTATIC self
|
|
-- @param #number Heading (Optional) The heading of the static, which is a number in degrees from 0 to 360. Default is the heading of the template.
|
|
-- @param #string NewName (Optional) The name of the new static.
|
|
-- @return #SPAWNSTATIC
|
|
function SPAWNSTATIC:InitLinkToUnit(Unit, OffsetX, OffsetY, OffsetAngle)
|
|
|
|
self.InitLinkUnit=Unit
|
|
self.InitOffsetX=OffsetX or 0
|
|
self.InitOffsetY=OffsetX or 0
|
|
self.InitOffsetAngle=OffsetAngle or 0
|
|
|
|
end
|
|
|
|
--- Spawn a new STATIC object.
|
|
-- @param #SPAWNSTATIC self
|
|
-- @param #number Heading (Optional) The heading of the static, which is a number in degrees from 0 to 360. Default is the heading of the template.
|
|
-- @param #string NewName (Optional) The name of the new static.
|
|
-- @return #SPAWNSTATIC
|
|
function SPAWNSTATIC:Spawn( Heading, NewName ) --R2.3
|
|
self:F( { Heading, NewName } )
|
|
|
|
local StaticTemplate, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( self.SpawnTemplatePrefix )
|
|
|
|
if StaticTemplate then
|
|
|
|
local StaticUnitTemplate = StaticTemplate.units[1]
|
|
|
|
StaticTemplate.name = NewName or string.format("%s#%05d", self.SpawnTemplatePrefix, self.SpawnIndex )
|
|
|
|
StaticTemplate.heading=Heading and math.rad(Heading) or StaticTemplate.heading
|
|
|
|
_DATABASE:_RegisterStaticTemplate( StaticTemplate, CoalitionID, CategoryID, CountryID )
|
|
|
|
local Static = coalition.addStaticObject( self.CountryID or CountryID, StaticTemplate.units[1] )
|
|
|
|
self.SpawnIndex = self.SpawnIndex + 1
|
|
|
|
return _DATABASE:FindStatic(Static:getName())
|
|
end
|
|
|
|
return nil
|
|
end
|
|
|
|
--- Spawns a new static using a given template. Additionally, the country ID needs to be specified, which also determines the coalition of the spawned static.
|
|
-- @param #SPAWNSTATIC self
|
|
-- @param #table Template Spawn unit template.
|
|
-- @param #number CountryID The
|
|
-- @return #SPAWNSTATIC
|
|
function SPAWNSTATIC:_SpawnFromTemplate(Template, CountryID)
|
|
|
|
local StaticTemplate, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( self.SpawnTemplatePrefix )
|
|
|
|
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 ) --R2.1
|
|
self:F( { PointVec2, Heading, NewName } )
|
|
|
|
local StaticTemplate, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( self.SpawnTemplatePrefix )
|
|
|
|
if StaticTemplate then
|
|
|
|
local StaticUnitTemplate = StaticTemplate.units[1]
|
|
|
|
StaticUnitTemplate.x = PointVec2.x
|
|
StaticUnitTemplate.y = PointVec2.z
|
|
|
|
StaticTemplate.route = nil
|
|
StaticTemplate.groupId = nil
|
|
|
|
StaticTemplate.name = NewName or string.format("%s#%05d", self.SpawnTemplatePrefix, self.SpawnIndex )
|
|
StaticUnitTemplate.name = StaticTemplate.name
|
|
StaticUnitTemplate.heading = ( Heading / 180 ) * math.pi
|
|
|
|
_DATABASE:_RegisterStaticTemplate( StaticTemplate, CoalitionID, CategoryID, CountryID)
|
|
|
|
self:F({StaticTemplate = StaticTemplate})
|
|
|
|
local Static = coalition.addStaticObject( self.CountryID or CountryID, StaticTemplate.units[1] )
|
|
|
|
self.SpawnIndex = self.SpawnIndex + 1
|
|
|
|
return _DATABASE:FindStatic(Static:getName())
|
|
end
|
|
|
|
return nil
|
|
end
|
|
|
|
|
|
--- Creates a new @{Static} from a COORDINATE.
|
|
-- @param #SPAWNSTATIC self
|
|
-- @param Core.Point#COORDINATE Coordinate The 3D coordinate where to spawn the static.
|
|
-- @param #number Heading (Optional) Heading The heading of the static, which is a number in degrees from 0 to 360. Default is 0 degrees.
|
|
-- @param #string NewName (Optional) The name of the new static.
|
|
-- @return Wrapper.Static#STATIC The spawned STATIC object.
|
|
function SPAWNSTATIC:SpawnFromCoordinate(Coordinate, Heading, NewName) --R2.4
|
|
self:F( { PointVec2, Heading, NewName } )
|
|
|
|
local StaticTemplate, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( self.SpawnTemplatePrefix )
|
|
|
|
if StaticTemplate then
|
|
|
|
Heading=Heading or 0
|
|
|
|
local StaticUnitTemplate = StaticTemplate.units[1]
|
|
|
|
StaticUnitTemplate.x = Coordinate.x
|
|
StaticUnitTemplate.y = Coordinate.z
|
|
StaticUnitTemplate.alt = Coordinate.y
|
|
|
|
StaticTemplate.route = nil
|
|
StaticTemplate.groupId = nil
|
|
|
|
StaticTemplate.name = NewName or string.format("%s#%05d", self.SpawnTemplatePrefix, self.SpawnIndex )
|
|
StaticUnitTemplate.name = StaticTemplate.name
|
|
StaticUnitTemplate.heading = ( Heading / 180 ) * math.pi
|
|
|
|
_DATABASE:_RegisterStaticTemplate( StaticTemplate, CoalitionID, CategoryID, CountryID)
|
|
|
|
self:F({StaticTemplate = StaticTemplate})
|
|
|
|
local Static = coalition.addStaticObject( self.CountryID or CountryID, StaticTemplate.units[1] )
|
|
|
|
self.SpawnIndex = self.SpawnIndex + 1
|
|
|
|
return _DATABASE:FindStatic(Static:getName())
|
|
end
|
|
|
|
return nil
|
|
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 NewName (optional) The name of the new static.
|
|
-- @return #SPAWNSTATIC
|
|
function SPAWNSTATIC:SpawnFromZone( Zone, Heading, NewName ) --R2.1
|
|
self:F( { Zone, Heading, NewName } )
|
|
|
|
local Static = self:SpawnFromPointVec2( Zone:GetPointVec2(), Heading, NewName )
|
|
|
|
return Static
|
|
end
|
|
|
|
--- Respawns the original @{Static}.
|
|
-- @param #SPAWNSTATIC self
|
|
-- @param #number delay Delay before respawn in seconds.
|
|
-- @return #SPAWNSTATIC
|
|
function SPAWNSTATIC:ReSpawn(delay)
|
|
|
|
if delay and delay>0 then
|
|
self:ScheduleOnce(delay, SPAWNSTATIC.ReSpawn, self)
|
|
else
|
|
|
|
local StaticTemplate, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( self.SpawnTemplatePrefix )
|
|
|
|
if StaticTemplate then
|
|
|
|
local StaticUnitTemplate = StaticTemplate.units[1]
|
|
StaticTemplate.route = nil
|
|
StaticTemplate.groupId = nil
|
|
|
|
local Static = coalition.addStaticObject( self.CountryID or CountryID, StaticTemplate.units[1] )
|
|
|
|
return _DATABASE:FindStatic(Static:getName())
|
|
end
|
|
|
|
return nil
|
|
end
|
|
|
|
return self
|
|
end
|
|
|
|
|
|
--- Creates the original @{Static} at a POINT_VEC2.
|
|
-- @param #SPAWNSTATIC self
|
|
-- @param Core.Point#COORDINATE Coordinate 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.
|
|
-- @return #SPAWNSTATIC
|
|
function SPAWNSTATIC:ReSpawnAt( Coordinate, Heading )
|
|
|
|
local StaticTemplate, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( self.SpawnTemplatePrefix )
|
|
|
|
if StaticTemplate then
|
|
|
|
local StaticUnitTemplate = StaticTemplate.units[1]
|
|
|
|
StaticUnitTemplate.x = Coordinate.x
|
|
StaticUnitTemplate.y = Coordinate.z
|
|
|
|
StaticUnitTemplate.heading = Heading and ( ( Heading / 180 ) * math.pi ) or StaticTemplate.heading
|
|
|
|
local Static = coalition.addStaticObject( self.CountryID or CountryID, StaticTemplate.units[1] )
|
|
|
|
return _DATABASE:FindStatic(Static:getName())
|
|
end
|
|
|
|
return nil
|
|
end
|
|
|