Icontypes.lua - Revision history

Gajop at 03:08, 3 December 2018

2018-12-03T03:08:01Z

← Older revision		Revision as of 04:08, 3 December 2018
Line 45:		Line 45:
	To assign units to a specific icon type, set the {{xtaglink\|Gamedev:UnitDefs\|iconType}} attribute of their UnitDef to the type name set in <code>icontypes.lua</code> (see [[#Example]])		To assign units to a specific icon type, set the {{xtaglink\|Gamedev:UnitDefs\|iconType}} attribute of their UnitDef to the type name set in <code>icontypes.lua</code> (see [[#Example]])

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

	If the {{xtaglink\|Gamedev:UnitDefs\|iconType}} 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.		If the {{xtaglink\|Gamedev:UnitDefs\|iconType}} 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==		==Example==
	~~<code>~~<pre>		<pre>
	local iconTypes = {		local iconTypes = {
	default = {		default = {
Line 76:		Line 76:

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

	[[Category:Gamedata]]		[[Category:Gamedata]]

Flozi: /* Source */ data types

2014-10-02T17:01:35Z

Source: data types

← Older revision		Revision as of 18:01, 2 October 2014
Line 9:		Line 9:

	* {{sourcelink\|file=rts/Rendering/IconHandler.cpp}}		* {{sourcelink\|file=rts/Rendering/IconHandler.cpp}}

			==Data Types==
			{{DataTypes}}

	==Details==		==Details==

Flozi: /* Assigning IconTypes */ update links

2013-10-28T22:46:07Z

Assigning IconTypes: update links

← Older revision		Revision as of 23:46, 28 October 2013
Line 40:		Line 40:

	===Assigning IconTypes===		===Assigning IconTypes===
	To assign units to a specific icon type, set the {{xtaglink\|~~Units-~~UnitDefs\|iconType}} attribute of their UnitDef to the type name set in <code>icontypes.lua</code> (see [[#Example]])		To assign units to a specific icon type, set the {{xtaglink\|Gamedev:UnitDefs\|iconType}} attribute of their UnitDef to the type name set in <code>icontypes.lua</code> (see [[#Example]])

	<code><pre>		<code><pre>
Line 48:		Line 48:
	</pre></code>		</pre></code>

	If the {{xtaglink\|~~Units-~~UnitDefs\|iconType}} 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.		If the {{xtaglink\|Gamedev:UnitDefs\|iconType}} 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==		==Example==

Flozi: 1cat

2013-03-21T09:01:21Z

1cat

← Older revision		Revision as of 10:01, 21 March 2013
Line 75:		Line 75:
	</pre></code>		</pre></code>

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

Flozi: /* Source */ reformat

2013-03-01T23:01:18Z

Source: reformat

← Older revision		Revision as of 00:01, 2 March 2013
Line 6:		Line 6:

	==Source==		==Source==
	The engine source code which parses the data from this file is viewable here:{{sourcelink\|file=rts/Rendering/IconHandler.cpp}}		The engine source code which parses the data from this file is viewable here:

			* {{sourcelink\|file=rts/Rendering/IconHandler.cpp}}

	==Details==		==Details==

Flozi: /* Assigning IconTypes */ xtaglink

2012-10-27T17:34:08Z

Assigning IconTypes: xtaglink

← Older revision		Revision as of 18:34, 27 October 2012
Line 38:		Line 38:

	===Assigning IconTypes===		===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]])		To assign units to a specific icon type, set the {{xtaglink\|Units-UnitDefs\|iconType}} attribute of their UnitDef to the type name set in <code>icontypes.lua</code> (see [[#Example]])

	<code><pre>		<code><pre>
Line 46:		Line 46:
	</pre></code>		</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.		If the {{xtaglink\|Units-UnitDefs\|iconType}} 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==		==Example==

Flozi: /* IconType Properties */ use {{tag}}

2012-04-02T13:49:15Z

IconType Properties: use {{tag}}

← Older revision		Revision as of 14:49, 2 April 2012
Line 13:		Line 13:

	===IconType Properties===		===IconType Properties===
	* '''<code>bitmap~~</code>''' -~~ type~~: <code>~~string~~</code> -~~ default~~: <code>~~""~~</code>~~		{{tag
	: The location of the custom icon image (not limited to bitmaps!). 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 image will need to have an alpha channel for transparency.		\|name = bitmap
			\|type = string
			\|default = ""
			\|description = The location of the custom icon image (not limited to bitmaps!). 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 image will need to have an alpha channel for transparency.}}

	* '''<code>size~~</code>''' -~~ type~~: <code>~~float~~</code> -~~ default~~: <code>~~1.0~~</code>~~		{{tag
	: Acts as multiplier for the icon size. The larger the number, the larger the icon will be.		\|name = size
			\|type = float
			\|default = 1.0
			\|description = Acts as multiplier for the icon size. The larger the number, the larger the icon will be.}}

	* '''<code>distance~~</code>''' -~~ type~~: <code>~~float~~</code> -~~ default~~: <code>~~1.0~~</code>~~		{{tag
	: Acts as a multiplier for the distance at which the unit will show up as an icon. The larger the number, the further away the camera has to be from the unit for it to turn into an icon.		\|name = distance
			\|type = float
			\|default = 1.0
			\|description = Acts as a multiplier for the distance at which the unit will show up as an icon. The larger the number, the further away the camera has to be from the unit for it to turn into an icon.}}

	* '''<code>radiusAdjust~~</code>''' -~~ type~~: <code>~~bool~~</code> - deafult: <code>~~false~~</code>~~		{{tag
	: Whether or not the icon should scale with the unit radius.		\|name = radiusAdjust
			\|type = bool
			\|default = false
			\|description = Whether or not the icon should scale with the unit radius.}}

	===Assigning IconTypes===		===Assigning IconTypes===

Jk: /* IconType Properties */

2011-07-07T16:24:21Z

IconType Properties

← Older revision		Revision as of 17:24, 7 July 2011
Line 14:		Line 14:
	===IconType Properties===		===IconType Properties===
	* '''<code>bitmap</code>''' - type: <code>string</code> - default: <code>""</code>		* '''<code>bitmap</code>''' - type: <code>string</code> - default: <code>""</code>
	: 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.		: The location of the custom icon image (not limited to bitmaps!). 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 image will need to have an alpha channel for transparency.

	* '''<code>size</code>''' - type: <code>float</code> - default: <code>1.0</code>		* '''<code>size</code>''' - type: <code>float</code> - default: <code>1.0</code>

Flozi: /* IconType Properties */ use UnitDef tag style

2011-07-07T16:08:46Z

IconType Properties: use UnitDef tag style

← Older revision		Revision as of 17:08, 7 July 2011
Line 13:		Line 13:

	===IconType Properties===		===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>bitmap</code>''' - type: <code>string</code> - default: <code>""</code>
			: 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>size</code>''' - type: <code>float</code> - default: <code>1.0</code>
			: Acts as multiplier for the icon size. The larger the number, the larger the icon will be.

	* <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>distance</code>''' - type: <code>float</code> - default: <code>1.0</code>
			: Acts as a multiplier for the distance at which the unit will show up as an icon. The larger the number, the further away the camera has to be from the unit for it to turn into an icon.

	* <code>~~radiusadjust~~</code> ~~is a boolean that tells Spring whether~~ or not the icon should scale with the unit radius~~. Default is false~~.		* '''<code>radiusAdjust</code>''' - type: <code>bool</code> - deafult: <code>false</code>
			: Whether or not the icon should scale with the unit radius.

	===Assigning IconTypes===		===Assigning IconTypes===

Flozi: /* Source */ use sourcelink

2011-07-04T22:17:34Z

Source: use sourcelink

← Older revision		Revision as of 23:17, 4 July 2011
Line 6:		Line 6:

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

	==Details==		==Details==