MIST makeUnitTable - Revision history

Grimes at 10:44, 24 August 2021

2021-08-24T10:44:50Z

← Older revision		Revision as of 10:44, 24 August 2021
Line 79:		Line 79:
	}}		}}
	[[Category: MIST\|makeUnitTable]]		[[Category: MIST\|makeUnitTable]]
			[[Category: Functions With UnitNameTables]]

Grimes at 09:10, 18 November 2020

2020-11-18T09:10:50Z

← Older revision		Revision as of 09:10, 18 November 2020
Line 5:		Line 5:
	\|vNum = Mist 1.0		\|vNum = Mist 1.0

	\|desc= This function accepts table t (which must be indexed sequentially starting at 1), applies the UnitNameTable short-cut rules, and returns a new table of unit names. Also, this function adds the table key and value processed = true to the returned table, indicating that the table has already been “run through” the UnitNameTable processing/shortcuts (useful for self-rescheduling functions- obviously, you only need to apply the UnitNameTable rules the first time a self-rescheduling function is run!). \|		\|desc= This function accepts table t (which must be indexed sequentially starting at 1), applies the UnitNameTable short-cut rules, and returns a new table of unit names. Also, this function adds the table key and value processed = true to the returned table, indicating that the table has already been “run through” the UnitNameTable processing/shortcuts (useful for self-rescheduling functions- obviously, you only need to apply the UnitNameTable rules the first time a self-rescheduling function is run!).


			Optional value "exclude" is used to exclude a certain category of unit object. Accepts lower case string or table of strings. Valid entries are:
			'plane', helicopter', 'vehicle', 'ship', 'static'

	~~\|vars= true~~

	\|rtnType= table		\|rtnType= table
Line 31:		Line 34:
	\|reqName5=		\|reqName5=

	\|optType1=		\|optType1= string/table

	\|optName1=		\|optName1= exclude

	\|optName2=		\|optName2=
Line 54:		Line 57:


	\|rtnExamples= [[~~exampleUnitNameTable\|Example unitNameTable~~]]		\|rtnExamples=
			{
	~~\|example~~= ~~The following code will deploy a smoke marker randomly inside a zone~~.		[1] = "Unit1',
			[2] = "Unit2',
			[3] = "Unit3',
			[4] = "Unit4',
			processed = 235.542,
			}

	~~<code>~~		\|example=
	do		The following would return a list of all objects except for statics.

	end		do
	~~</code>~~		local units = mist.makeUnitTable({'[all]'}, 'static')
			end
	\|notes= See [[unitNameTables]]		\|notes= See [[unitNameTables]]

	\|funcs= ~~list~~ of ~~funcs using~~ unitNameTables		\|funcs= List of functions that use unitNameTables:
			[[MIST makeUnitTable\|makeUnitTable]], [[MIST units_in_zones\|units_in_zones]], [[MIST units_in_moving_zones\|units_in_moving_zones]], [[MIST units_in_polygon\|units_in_polygon]], [[MIST units_LOS\|units_LOS]], [[MIST getUnitsInZones\|getUnitsInZones]], [[MIST getUnitsInMovingZones\|getUnitsInMovingZones]], [[MIST pointInPolygon\|pointInPolygon]], [[MIST getUnitsInPoly\|getUnitsInPolygon]], [[MIST getUnitsLOS\|getUnitsLOS]]

	}}		}}
	[[Category: MIST\|makeUnitTable]]		[[Category: MIST\|makeUnitTable]]

Grimes at 23:21, 13 April 2018

2018-04-13T23:21:17Z

New page

{{Mission Scripting

|fName= mist.makeUnitTable|

|vNum = Mist 1.0

|desc= This function accepts table t (which must be indexed sequentially starting at 1), applies the UnitNameTable short-cut rules, and returns a new table of unit names. Also, this function adds the table key and value processed = true to the returned table, indicating that the table has already been “run through” the UnitNameTable processing/shortcuts (useful for self-rescheduling functions- obviously, you only need to apply the UnitNameTable rules the first time a self-rescheduling function is run!). |

|vars= true

|rtnType= table

|reqType1= table

|reqName1= t

|reqType2=

|reqName2=

|reqType3=

|reqName3=

|reqType4=

|reqName4=

|reqType5=

|reqName5=

|optType1=

|optName1=

|optName2=

|optType2=

|optType3=

|optName3=

|optType4=

|optName4=

|optType5=

|optName5=

|varExamples= See [[unitNameTables]]

|rtnExamples= [[exampleUnitNameTable|Example unitNameTable]]

|example= The following code will deploy a smoke marker randomly inside a zone.

<code>
do

end
</code>
|notes= See [[unitNameTables]]

|funcs= list of funcs using unitNameTables

}}
[[Category: MIST|makeUnitTable]]