Custom Unit Icons - Revision history

Flozi: Redirected page to Icontypes.lua

2011-04-02T20:42:22Z

← Older revision		Revision as of 21:42, 2 April 2011
Line 1:		Line 1:
	~~==Location==~~		#REDIRECT [[Icontypes.lua]]
	<code>icontypes.lua</code> is a file in the <code>Gamedata/</code> directory of a Spring Game. It defines the icons used to represent units on the minimap and rendered in place of 3d geometry when zoomed out.

	~~==Source==~~
	~~The engine source code which parses the data from this file is viewable here:~~
	~~https://github.com/spring/spring/blob/master/rts/Rendering/IconHandler.cpp~~

	~~==Details==~~

	Game developers can set icons for different types of units, (such as land, air, sea), or go so far as to give every unit its own icon. The different types icons will be shown for friendly units, and enemy units within Line Of Sight. For enemy units in radar range Spring will use the 'default' icon.

	~~===IconType Properties===~~
	* <code>bitmap</code> is the location of the custom icon bitmap. If it is missing or incorrect, Spring replaces it with the standard radar dot. The bitmap will get blended with the team color, so there is no special team color channel. In order to look nice, the bitmap will need to have an alpha channel for transparency.

	* <code>size</code> is a number that acts as multiplier for the icon size. The bigger the number, the bigger the icon will be. Default is 1.

	* <code>distance</code> is a number that acts as a multiplier for the distance at which the unit will show up as an icon. The bigger the number, the further away the camera has to be from the unit for it to turn into an icon. Default is 1.

	* <code>radiusadjust</code> is a boolean that tells Spring whether or not the icon should scale with the unit radius. Default is false.

	~~===Assigning IconTypes===~~
	~~To assign units to a specific icon type, set the <code>iconType</code> attribute of their UnitDef to the type name set in <code>icontypes.lua</code> (see~~ [[~~#Example]])~~

	~~<code><pre>~~
	...
	~~iconType = "circle",~~
	~~...~~
	~~</pre></code>~~

	If the <code>iconType</code> tag is missing, Spring sets it to the "default" icontype. If the "default" type is not specified, Spring will create it with the default values. Furthermore, enemy units that are within radar range, but not in your Line Of Sight, will be shown as the default icon. Thus if there is a bitmap specified for the "default" icon type it will override the standard radar blip.

	~~==Example==~~
	~~<code><pre>~~
	~~local iconTypes = {~~
	~~default = {~~
	~~size = 1,~~
	~~radiusadjust = true,~~
	},
	~~flag = {~~
	~~bitmap = "icons/flag.png",~~
	~~size = 6,~~
	~~radiusadjust = true,~~
	~~distance = 100,~~
	},
	~~circle = {~~
	~~bitmap = "icons/circle.png",~~
	~~size = 4,~~
	~~radiusadjust = true,~~
	~~distance = 100,~~
	},
	~~...~~
	}

	~~return iconTypes~~
	~~</pre></code>~~

	~~[[Category:Gamedata]]~~
	~~[[Category:Game development~~]]

Flozi at 20:38, 2 April 2011

2011-04-02T20:38:13Z

Show changes

Knorke: icontypes.lua example

2011-03-29T06:38:52Z

icontypes.lua example

← Older revision		Revision as of 07:38, 29 March 2011
Line 68:		Line 68:

	The screenshot above was taken using these icons.		The screenshot above was taken using these icons.

			====icontypes.lua====
			example of an icontypes.lua:
			<pre>
			local icontypes = {
			default = {
			size=1,
			radiusadjust=1,
			},
			flag = {
			bitmap = "icons/flag.png",
			size = 6,
			radiusadjust = 1,
			-- distance = 100,
			},
			circle = {
			bitmap = "icons/circle.png",
			size = 4,
			radiusadjust = 1,
			-- distance = 100,
			},
			circlecross = {
			bitmap = "icons/circlecross.png",
			size = 4,
			radiusadjust = 1,
			-- distance = 100,
			},
			square = {
			bitmap = "icons/square.png",
			size = 4,
			radiusadjust = 1,
			-- distance = 100,
			},
			circlepie = {
			bitmap = "icons/circlepie.png",
			size = 3,
			radiusadjust = 1,
			-- distance = 100,
			},
			}
			return icontypes
			</pre>


	[[Category:Game development]]		[[Category:Game development]]

Abma: /* Example files */

2010-12-05T01:06:05Z

Example files

← Older revision		Revision as of 02:06, 5 December 2010
Line 69:		Line 69:
	The screenshot above was taken using these icons.		The screenshot above was taken using these icons.

	[[~~category~~:~~Mod~~ development]]		[[Category:Game development]]

Koshi: fix category

2010-03-13T10:19:37Z

fix category

← Older revision		Revision as of 11:19, 13 March 2010
Line 69:		Line 69:
	The screenshot above was taken using these icons.		The screenshot above was taken using these icons.

	[[category:Mod ~~Development~~]]		[[category:Mod development]]

FoeOfTheBee: /* Example files */

2006-09-15T19:54:24Z

Example files

← Older revision		Revision as of 20:54, 15 September 2006
Line 69:		Line 69:
	The screenshot above was taken using these icons.		The screenshot above was taken using these icons.

	[[category:Mod ~~development~~]]		[[category:Mod Development]]

FoeOfTheBee: /* Example files */

2006-09-15T19:54:15Z

Example files

← Older revision		Revision as of 20:54, 15 September 2006
Line 68:		Line 68:

	The screenshot above was taken using these icons.		The screenshot above was taken using these icons.

			[[category:Mod development]]

Colorblind: /* About */

2006-08-23T10:53:07Z

About

← Older revision		Revision as of 11:53, 23 August 2006
Line 5:		Line 5:
	===About===		===About===

	On the minimap the units are displayed as icons, which also appear when you zoom out. ~~The default icon is~~ the ~~radar blip~~, ~~but mod developers have the ability~~ to ~~assign~~ different icons to units. ~~The custom~~ icon ~~information is stored in gamedata/icontypes.tdf~~.		On the minimap the units are displayed as icons, which also appear when you zoom out. Mod developers can set icons for different types of units (such as in the picture above, with different icons for land, air, sea, and commanders), or go so far as to give every unit its own icon.

			The different types icons will be shown for friendly units, and enemy units within Line Of Sight. For enemy units in radar range Spring will use the 'default' icon.

	===How to specify different types of icons===		===How to specify different types of icons===

Colorblind: /* About */

2006-08-11T11:42:20Z

About

← Older revision		Revision as of 12:42, 11 August 2006
Line 5:		Line 5:
	===About===		===About===

	~~When~~ you zoom out ~~in Spring, units will get replaced with icons~~. The default icon is the radar blip, but mod developers have the ability to assign different icons to units. The custom icon information is stored in gamedata/icontypes.tdf.		On the minimap the units are displayed as icons, which also appear when you zoom out. The default icon is the radar blip, but mod developers have the ability to assign different icons to units. The custom icon information is stored in gamedata/icontypes.tdf.

	===How to specify different types of icons===		===How to specify different types of icons===

Colorblind at 11:30, 11 August 2006

2006-08-11T11:30:42Z

← Older revision		Revision as of 12:30, 11 August 2006
Line 1:		Line 1:
	==Custom Unit Icons==		==Custom Unit Icons==

			[[Image:Minimap icons.jpg]]

	===About===		===About===
Line 63:		Line 65:
	as a starting set for unit icons.		as a starting set for unit icons.

	~~Here's how it might look on the minimap:~~		The screenshot above was taken using these icons.

	~~[[Image:Minimap~~ icons.~~jpg]]~~