Grimes at 00:12, 4 January 2021

2021-01-04T00:12:17Z

← Older revision		Revision as of 00:12, 4 January 2021
Line 5:		Line 5:
	\|vNum = Mist 1.0		\|vNum = Mist 1.0

	\|desc= Returns a table of ~~units~~ from the table unit_names that are inside any of the zones listed in the table of zone_names. \|		\|desc= Returns a table of unit objects from the table unit_names that are inside any of the zones listed in the table of zone_names. \|

	\|rtnType= table		\|rtnType= table
Line 37:		Line 37:


	\|rtnExamples= ~~unitNameTable~~		\|rtnExamples=
	~~\|example~~= ~~<code>~~		{ [1] = { ["id_"] = 16779264,} ,[2] = { ["id_"] = 16780032,} ,[3] = { ["id_"] = 16780288,} ,[4] = { ["id_"] = 16780544,} ,}
	~~-- With a zone on the map named~~ "~~KutaisiBattle~~"

	~~-- Get total number~~ of units in the zone		\|example= Returns a table of units within the zone KutasiBattle and builds table of units index by the country each unit belongs to.

	u = mist.getUnitsInZones(mist.makeUnitTable({'[all]'}), {'KutaisiBattle'})		local u = mist.getUnitsInZones(mist.makeUnitTable({'[all]'}), {'KutaisiBattle'})
			local countries = {}
			for i = 1, #u do
			local cntry = Unit.getCountry(u[i])
			if not countries[cntry] then
			countries[cntry] = {}
			end
			table.insert(countries[cntry], u[i])
			end

	~~env.info(#u)~~

	~~</code>~~

	\|notes= Is called by and is related to [[Units in zones]]		\|notes= Is called by and is related to [[Units in zones]]

Grimes at 23:00, 13 April 2018

2018-04-13T23:00:55Z

New page

{{Mission Scripting

|fName= mist.getUnitsInZones|

|vNum = Mist 1.0

|desc= Returns a table of units from the table unit_names that are inside any of the zones listed in the table of zone_names. |

|rtnType= table

|reqType1= UnitNameTable

|reqName1= unit_names

|reqType2= table

|reqName2= zone_names

|reqType3=

|optType1= string

|optName1= zone_type

|optType2=

|varExamples=

[[ExampleUnitNameTable]]

<pre>zone_names = {'zone1', 'zone2'}</pre>

zone_type =

'cylinder' - cylindrical shaped zone extending to +/- infinity in altitude.
'sphere' - spherical zone

|rtnExamples= unitNameTable
|example= <code>
-- With a zone on the map named "KutaisiBattle"

-- Get total number of units in the zone

u = mist.getUnitsInZones(mist.makeUnitTable({'[all]'}), {'KutaisiBattle'})

env.info(#u)

</code>

|notes= Is called by and is related to [[Units in zones]]

|funcs= {{listOfMistGeneralPurposeFuncs}}

}}
[[Category: MIST|getUnitsInZones]]

MIST getUnitsInZones - Revision history

Grimes at 00:12, 4 January 2021

Grimes at 23:00, 13 April 2018