Wrapper Contact
Retreiving the Contact details
Wrapper Doctrine
Retreiving the mission doctrine object
local d = ScenEdit_GetDoctrine( { side='united states', mission='AEW East' } )
print(d)
local d = ScenEdit_GetDoctrine({side='united states',mission='AEW East',actual='yes'})
print(d)
Wrapper DoctrineWRA
Retreiving a Doctrine WRA
There is a WRA_??? item for each weapon system in the LEVEL selected, in this case a unit, and for the type of target selected ( 2000 = 'Aircraft_Unspecified').
It can be filtered by using the weapon DBID in which case the WEAPON_DBID and WEAPON_NAME (from WRA) will be shown on the parent side with LEVEL and TARGET_TYPE.
local a = local a = ScenEdit_GetDoctrineWRA({guid='a1a52edf-3541-4b55-bea4-58d4e1ab11dc',target_type=2000})
print(a)
Wrapper Event
1. Showing the full attributes of the event
local a = ScenEdit_GetEvent( "Aircraft entering ship's exclusion zone" )
for k,v in pairs(a.fields) do
if string.find(k,'property_') ~= nil then -- is a property
local vt = {}
local i = 0
for w in string.gmatch(v,'%g+[^, ]') do
vt[i] = w
i=i+1
end
print("\r\n[object] = " .. string.sub(vt[0],2) ) -- property name
if vt[3] == 'True' then
print( a[ string.sub(vt[0],2) ] ) -- value of property
else
print( 'no get function' ) -- value of property
end
end
end
2. Retreiving some details from the Event
local f = ScenEdit_EventX() -- the event that has triggered
print("EventID: " .. string.format('%s (\'%s\')',f.description, f.guid))
print("Active: " .. string.format('%s',f.isActive))
print("Shown: " .. string.format('%s',f.isShown))
print("Repeats: " .. string.format('%s',f.isRepeatable))
print("Trigger(s):")
print(f.triggers)
print("Conditions(s):")
print(f.conditions)
print("Action(s):")
print(f.actions)
The active event has one trigger (UnitDestroyed) and one action (update points).
Wrapper Group
Retreiving the Group details
local u = ScenEdit_GetUnit({name='CVN BG', guid='9506a165-6e44-40dd-b721-f9c07e056bdb'})
print("Group [" .. u.group.name .. "] \r\n" .. " Lead ship is " .. ScenEdit_GetUnit({ guid= u.group.lead}).name)
-- group contains units
local s = "Group units:" .. "\r\n"
for k,v in pairs(u.group.unitlist) do
if v ~= u.group.lead then
s = s .. k .. " - " .. ScenEdit_GetUnit({ guid= v}).name .. "\r\n"
end
end
print(s)
Wrapper LoadOut
Retreiving the Group details
local u = ScenEdit_GetLoadout({name='MiG-31BM Foxhound', unitname='NZZYVJ-0HM0G1F7MPTLQ'}
print("Loadout [" .. u.name .. "] \r\n" )
--print(u.weapons)
local s = "Weapon load:" .. "\r\n"
for k,v in pairs(u.weapons) do
print( v)
s = s .. k .. " - " .. v.wpn_name
s = s .. "\t(Carrying " .. v.wpn_current .. " of " .. v.wpn_maxcap .. ")\r\n"
u:setExactWeaponQuantity(v.wpn_guid, v.wpn_maxcap) -- set the current load back to full if any have been expended
end
print(s)
Wrapper Magazine
Retreiving the Magazine details
local u = ScenEdit_GetUnit({name='LST 4001 Osumi', guid='8269b881-20ce-4f2e-baa0-6823e46d55a4'})
print( "Unit Magazines " .. "\r\n")
for k,v in pairs(u.magazines) do
local s = ''
local m = u:getUnitMagazine(v.mag_guid) -- details on magazine
s = s .. k .. " - " .. m.name .. "with capacity of " .. m.capacity .. ' units\r\n'
s = s .. "\t[Armor rating = " .. m.armor .. ", ROF = " .. m.rof .. ", containing " .. #m.weapons .. " weapon(s)]\r\n"
for k,v in pairs(m.weapons) do
s = s .. "\t\t" .. v.wpn_name .. " with load " .. v.wpn_current .. " of " .. v.wpn_default .. '\r\n'
m:setExactWeaponQuantity(v.wpn_guid, v.wpn_default) -- set the current load back to full if any have been expended
end
print(s)
end
Wrapper Mission
Retreiving the Mission details
Wrapper Mount
Retreiving the Mount details
local u = ScenEdit_GetUnit({name='LST 4001 Osumi', guid='8269b881-20ce-4f2e-baa0-6823e46d55a4'})
print( "Unit Mounts " )
for k,v in pairs(u.mounts) do
local s = ''
local m = u:getUnitMount(v.mount_guid) -- details on mount
s = s .. k .. " - " .. m.name .. " [ " .. v.mount_status .. ' ]\r\n'
s = s .. "\t[ containing " .. #m.weapons .. " weapon(s) ]\r\n"
for k,v in pairs(m.weapons) do
s = s .. "\t\t" .. v.wpn_name .. " with load " .. v.wpn_current .. " of " .. v.wpn_default .. '\r\n'
--m:setExactWeaponQuantity(v.wpn_guid, v.wpn_default) -- set the current load back to full if any have been expended
end
print(s)
end
Wrapper Reference Point
Retreiving the RP details
Wrapper Scenario
Retreiving the Scenario details
Wrapper Side
Retreiving the Side details
Find units in an area
local u = side:unitsInArea({Area = { 'RP-3137', 'RP-3139', 'RP-3136', 'RP-3138'},
TargetFilter = { TargetType = 'Ship' } })
Find units on side by a filter
local u = side:side:unitsBy('Ship') -- all ships
u = side:unitsBy('Ship', 2002, 3003) -- ships fitered for 'Surface combatant' and 'BBC'
Wrapper Special Action
Retreiving the SA details
Wrapper Unit
Retreiving the Unit details
Update the orbit for a satellite by specifying a TLE
theSat = ScenEdit_GetUnit({guid='56f830c1-d0e2-430a-985e-0e301cc01eff'})
theTLE = 'Resurs P1\n1 39186U 13030A 17013.12537468 .00000446 00000-0 16942-4 0 9992\n2 39186 97.3847 79.3911 0015157 247.7411 195.8488 15.31966970198820'
theSat:updateorbit({TLE=theTLE})
Change the type of waypoint
au = ScenEdit_GetUnit({name='AGM-158A JASSM [Penetrator] #967', guid='46skox-0hmf72m6q6bdj'})
print(au.course)
wp = au:getwaypoint({GUID='46SKOX-0HMF72M6Q6L64'})
wp.type = 0 -- This changes the waypoint type, in this case to manual plotted-course waypoint
print(wp.type)
Change group's formation - reposition individual units - via teleport (transpose = true)
1. to 'line abreast' (one of the pre-defined formations)
local a = ScenEdit_GetUnit( { guid='9506a165-6e44-40dd-b721-f9c07e056bdb' } )
a.formation = {name='line', spacing_unit = 1, transpose='true'}
2. to a customised formation
local a = ScenEdit_GetUnit( { guid='9506a165-6e44-40dd-b721-f9c07e056bdb' } )
a.formation = {name='Custom:\t0\t2\t1\t135\t1\t1\t225\t1', spacing_unit = 1, transpose='true'}
Change unit's location in group's formation
local a = ScenEdit_GetUnit( { guid='9506a165-6e44-40dd-b721-f9c07e056bdb' } )
a.formation = {type='fixed', sprint=false, bearing=45, distance=5}
Retrieve the noise level of ship (as appears on map)
local u = ScenEdit_GetUnit({name='SS 583 Harushio', guid='3a5f2a57-36e2-48f6-9352-00b819789a18'})
--print(u.noiseLevel)
print '----Noise Level----------'
print("Front: " .. tostring(u.noiseLevel.front))
print("Side: " .. tostring(u.noiseLevel.side))
print("Rear: " .. tostring(u.noiseLevel.rear))
Retrieve the signature profile of aircraft with loadout
local u = ScenEdit_GetUnit({name='MiG-31BM Foxhound', guid='NZZYVJ-0HM0G1F7MPTLQ'})
print(u.signature)
local sigs = u.signature
if sigs.loadout ~= nil then
print("A/c Loadout id = " .. sigs.loadout)
end
print '----Signatures----------'
for k,v in pairs(sigs) do
if k ~= 'loadout' then
print("Type: " .. tostring(v.type) .. " / " .. v.typeN) -- type of device related to signature. Both text and number are supplied
-- the text string similar to DB viewer
print("Front: " .. tostring(v.text.front))
print("Side: " .. tostring(v.text.side))
print("Rear: " .. tostring(v.text.rear))
--print(v.text)
-- the RCS values
print("RCS: " )
print("Front: " .. tostring(v.rcs.front))
print("Side: " .. tostring(v.rcs.side))
print("Rear: " .. tostring(v.rcs.rear))
--print(v.rcs)
if v.sqm ~= nil then
-- the square metre values
print("SQM: " )
print("Front: " .. tostring(v.sqm.front))
print("Side: " .. tostring(v.sqm.side))
print("Rear: " .. tostring(v.sqm.rear))
--print(v.rcs)
end
print '---------------'
end
end
Wrapper Zone (non-navigation and exclusion)
Retreiving the Zone details
local a = VP_GetSide({Side ='side1'})
local z = a.nonavzones
--List Of no-nav zones For the side If you need To find it
For i, zone in ipairs(z) do
print("Zone #" .. i)
print(zone)
local n = a : getnonavzone(z[i].guid) print('Details: ' .. n.description .. ' Active: ' .. tostring(n.isactive) )
n.area = {'rp-9','rp-10', 'rp-8' n.area = {
name='area test rp0', latitude='35.5480335331354', longitude='15.8184476823186', highlighted=true, bearingtype=1, relativeto='Tracking #1', hidden = false,
name='area test rp1', latitude='35.5480335331354', longitude='16.8184476823186', highlighted=true,,
name='area test rp2', latitude='38.5480335331354', longitude='18.8184476823186', highlighted=false, End
Wrapper WayPoint
Retreiving the WP details
Wrapper Weapon
Retreiving the Weapon details
