Lua UnitDefs - Revision history

Raaar: moved min/mid/max properties of the model inside the model subtable and name, type and path being outside of it to match what's available on recent versions

2023-12-29T16:38:39Z

moved min/mid/max properties of the model inside the model subtable and name, type and path being outside of it to match what's available on recent versions

← Older revision		Revision as of 17:38, 29 December 2023
Line 215:		Line 215:
	maxWaterDepth = 35,		maxWaterDepth = 35,
	maxWeaponRange = 300,		maxWeaponRange = 300,
	~~maxx = 17.423709869385,~~
	~~maxy = 48.386325836182,~~
	~~maxz = 14.10532283783,~~
	metalCost = 2667,		metalCost = 2667,
	metalMake = 1.5,		metalMake = 1.5,
	metalStorage = 0,		metalStorage = 0,
	metalUpkeep = 0,		metalUpkeep = 0,
	~~midx = 0.66120779514313,~~
	~~midy = 19,~~
	~~midz = 1.7122877836227,~~
	minAirBasePower = 0,		minAirBasePower = 0,
	minCollisionSpeed = 1,		minCollisionSpeed = 1,
	minWaterDepth = -10000000,		minWaterDepth = -10000000,
	~~minx~~ = ~~-16~~.~~537784576416~~,		modelname = "CORCOM.s3o",
	~~miny~~ = 0.~~058725833892822~~,		modelpath = "objects3d/CORCOM.s3o",
	~~minz~~ = ~~-9.709508895874~~,		modeltype = "s3o",
	moveState = -1,		moveState = -1,
	myGravity = 0.40000000596046,		myGravity = 0.40000000596046,
Line 334:		Line 328:
	},		},
	model = {		model = {
	~~name~~ = ~~"CORCOM~~.~~s3o"~~,		minx = -16.537784576416,
	~~path~~ = ~~"objects3d/CORCOM~~.~~s3o"~~,		miny = 0.058725833892822,
	~~type~~ = ~~"s3o"~~,		minz = -9.709508895874,
			midx = 0.66120779514313,
			midy = 19,
			midz = 1.7122877836227,
			maxx = 17.423709869385,
			maxy = 48.386325836182,
			maxz = 14.10532283783,
	textures = {		textures = {
	tex1 = "Core_color.dds",		tex1 = "Core_color.dds",

Forboding angel: Add helpful "are you lost?" to page so that perhaps people who end up on the wrong page will figure it out sooner rather than later.

2020-02-14T02:57:44Z

Add helpful "are you lost?" to page so that perhaps people who end up on the wrong page will figure it out sooner rather than later.

← Older revision		Revision as of 03:57, 14 February 2020
Line 1:		Line 1:
	[[Engine_Development\|Development]] < [[Lua_Scripting\|Lua Scripting]] < {{FULLPAGENAME}}		[[Engine_Development\|Development]] < [[Lua_Scripting\|Lua Scripting]] < {{FULLPAGENAME}}

			'''Were you looking for the unitDefs page for Game Developers?''' ([[Gamedev:UnitDefs]])

	==What is this==		==What is this==

Gajop at 17:50, 10 November 2018

2018-11-10T17:50:54Z

← Older revision		Revision as of 18:50, 10 November 2018
Line 3:		Line 3:
	==What is this==		==What is this==
	The '''UnitDefs[]''' table holds information about the unit'''types''' used in the game. It is indexed by a number, and normally refered to as unitDefID. It is read-only. To access its tags you write, for example,		The '''UnitDefs[]''' table holds information about the unit'''types''' used in the game. It is indexed by a number, and normally refered to as unitDefID. It is read-only. To access its tags you write, for example,
	<~~code~~>		<pre>
	UnitDefs[unitDefID].name		UnitDefs[unitDefID].name
	</~~code~~>		</pre>

	'''Note:'''<br>		'''Note:'''<br>
Line 13:		Line 13:
	==UnitDefs reverse lookup: UnitDefNames==		==UnitDefs reverse lookup: UnitDefNames==
	The '''UnitDefNames[]''' table holds the unitdefs and can be used to get the unitdef table for a known unitname:		The '''UnitDefNames[]''' table holds the unitdefs and can be used to get the unitdef table for a known unitname:
	<~~code~~>		<pre>
	local unitDef = UnitDefNames["supertank"]		local unitDef = UnitDefNames["supertank"]
	</~~code~~>		</pre>

	==Print all unitDefs==		==Print all unitDefs==
	This example code prints all unitdefs, with all keys and their values (but not their subtables).		This example code prints all unitdefs, with all keys and their values (but not their subtables).
	<~~code~~>		<pre>
	for id,unitDef in pairs(UnitDefs) do		for id,unitDef in pairs(UnitDefs) do
	for name,param in unitDef:pairs() do		for name,param in unitDef:pairs() do
Line 25:		Line 25:
	end		end
	end		end
	</~~code~~>		</pre>
	Note that unitDef is a metatable, and requires the special iterator unitDef:pairs()		Note that unitDef is a metatable, and requires the special iterator unitDef:pairs()

Line 38:		Line 38:

	To read [[Gamedev:UnitDefs#customParams\|custom parameters]] use:		To read [[Gamedev:UnitDefs#customParams\|custom parameters]] use:
	<~~code~~>		<pre>
	local myCustomParameters = UnitDefs[unitDefID].customParams		local myCustomParameters = UnitDefs[unitDefID].customParams
	if (myCustomParameters) then		if (myCustomParameters) then
	blub = myCustomParameters.blubfactor		blub = myCustomParameters.blubfactor
	end		end
	</~~code~~>		</pre>
	Key-names of the customParams table written must be lowercase and their values can only be strings.		Key-names of the customParams table written must be lowercase and their values can only be strings.

Line 68:		Line 68:
	In the form of key = value, where UnitDefs[unitDefID].key = value, with subtables at the bottom.		In the form of key = value, where UnitDefs[unitDefID].key = value, with subtables at the bottom.

	~~<code>~~
	<pre>		<pre>
	activateWhenBuilt = true,		activateWhenBuilt = true,
Line 395:		Line 394:
	},		},
	</pre>		</pre>
	~~</code>~~

	==Unit/Weapon damages and armor classes==		==Unit/Weapon damages and armor classes==

	For details on how to extract which units/weapons target/damage which units, see https://springrts.com/phpbb/viewtopic.php?f=44&t=34382&p=575738#p575738 (~~todo~~: migrate info to wiki).		For details on how to extract which units/weapons target/damage which units, see https://springrts.com/phpbb/viewtopic.php?f=44&t=34382&p=575738#p575738 (TODO: migrate info to wiki).

	==How to save unitDef tables to file==		==How to save unitDef tables to file==
	To save all unitDefs to a file, including all tables, you can use		To save all unitDefs to a file, including all tables, you can use
	<~~code~~>		<pre>
	local unitDef = UnitDefs[unitDefID]		local unitDef = UnitDefs[unitDefID]
	local t = {}		local t = {}
Line 410:		Line 408:
	end		end
	table.save(t, "lua_unitDef_" .. unitDef.name .. ".lua", "-- generated by table.save")		table.save(t, "lua_unitDef_" .. unitDef.name .. ".lua", "-- generated by table.save")
	</~~code~~>		</pre>
	The special iterator is needed because metatables. See https://springrts.com/phpbb/viewtopic.php?f=67&t=33778 for a widget to regenerate the example defs.		The special iterator is needed because metatables. See https://springrts.com/phpbb/viewtopic.php?f=67&t=33778 for a widget to regenerate the example defs.

Silentwings: remove outdated

2016-03-15T17:03:35Z

remove outdated

@@ Line 396: / Line 396: @@
 </pre>
 </code>
 ==Unit/Weapon damages and armor classes==

Silentwings: add a link to a helpful forum post i just wrote

2016-02-10T11:12:50Z

add a link to a helpful forum post i just wrote

← Older revision		Revision as of 12:12, 10 February 2016
Line 411:		Line 411:

	<span class="warning">ADD MORE</span>		<span class="warning">ADD MORE</span>

			==Unit/Weapon damages and armor classes==

			For details on how to extract which units/weapons target/damage which units, see https://springrts.com/phpbb/viewtopic.php?f=44&t=34382&p=575738#p575738 (todo: migrate info to wiki).

	==How to save unitDef tables to file==		==How to save unitDef tables to file==

Silentwings: /* Print all unitDefs */

2015-08-12T13:32:19Z

Print all unitDefs

← Older revision		Revision as of 14:32, 12 August 2015
Line 26:		Line 26:
	end		end
	</code>		</code>
			Note that unitDef is a metatable, and requires the special iterator unitDef:pairs()

	==Useful keys/snippets==		==Useful keys/snippets==

Silentwings: /* Example UnitDef table */

2015-08-12T11:45:41Z

Example UnitDef table

← Older revision		Revision as of 12:45, 12 August 2015
Line 65:		Line 65:

	==Example UnitDef table==		==Example UnitDef table==
	In the form of key = value, where UnitDefs[unitDefID].key = value, with subtables ~~are~~ at the bottom.		In the form of key = value, where UnitDefs[unitDefID].key = value, with subtables at the bottom.

	<code>		<code>
Line 395:		Line 395:
	</pre>		</pre>
	</code>		</code>


	==Notes==		==Notes==

Silentwings: /* How to save unitDef tables to file */

2015-08-12T11:43:26Z

How to save unitDef tables to file

← Older revision		Revision as of 12:43, 12 August 2015
Line 422:		Line 422:
	table.save(t, "lua_unitDef_" .. unitDef.name .. ".lua", "-- generated by table.save")		table.save(t, "lua_unitDef_" .. unitDef.name .. ".lua", "-- generated by table.save")
	</code>		</code>
	The special iterator is needed because metatables. See https://springrts.com/phpbb/viewtopic.php?f=67&t=33778 for a widget to ~~regenerated~~ the example defs.		The special iterator is needed because metatables. See https://springrts.com/phpbb/viewtopic.php?f=67&t=33778 for a widget to regenerate the example defs.

Silentwings: /* How to save unitDef tables to file */ add generation widget

2015-08-12T11:43:15Z

How to save unitDef tables to file: add generation widget

← Older revision		Revision as of 12:43, 12 August 2015
Line 422:		Line 422:
	table.save(t, "lua_unitDef_" .. unitDef.name .. ".lua", "-- generated by table.save")		table.save(t, "lua_unitDef_" .. unitDef.name .. ".lua", "-- generated by table.save")
	</code>		</code>
	The special iterator is needed because metatables.		The special iterator is needed because metatables. See https://springrts.com/phpbb/viewtopic.php?f=67&t=33778 for a widget to regenerated the example defs.

Silentwings: /* Useful keys/snippets */ add note about custom params

2015-08-12T10:53:14Z

Useful keys/snippets: add note about custom params

← Older revision		Revision as of 11:53, 12 August 2015
Line 43:		Line 43:
	end		end
	</code>		</code>
			Key-names of the customParams table written must be lowercase and their values can only be strings.

	===Types of Units===		===Types of Units===