Types/IconData - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:25Z

Removed old prototype docs

← Older revision		Revision as of 14:32, 25 October 2024
Line 2:		Line 2:

	</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>		</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>



	~~== Basics ==~~
	~~Data of one icon "layer" for the <code>icons</code> property of the [[Types/IconSpecification]].~~

	~~== Mandatory properties ==~~
	~~=== icon ===~~
	~~'''Type''': [[Types/FileName]]~~

	~~The path to the icon.~~

	~~=== icon_size ===~~
	~~'''Type''': [[Types/SpriteSizeType]]~~

	~~Mandatory if <code>icon_size</code> is not specified outside of <code>icons</code>. The size of the square icon, in pixels, e.g. 32 for a 32px by 32px icon.~~

	~~== Optional properties ==~~
	~~=== tint ===~~
	~~'''Type''': [[Types/Color]]~~

	~~'''Default''': <nowiki>{r=1, g=1, b=1, a=1} (white)</nowiki>~~

	~~Tint of the icon.~~

	~~=== shift ===~~
	~~'''Type''': [[Types/vector]]~~

	~~'''Default''': {0, 0}~~

	~~Used to offset the icon "layer" from the overall icon.<br>~~
	~~The shift is applied from the center (so negative shifts are left and up, respectively). Shift uses the unit "pixels after scaling", see [[#Notes]].~~

	~~=== scale ===~~
	~~'''Type''': [[Types/double]]~~

	~~'''Default for items/recipes''': (32/icon_size)~~

	~~'''Default for technologies''': (256/icon_size)~~

	~~When set, specifies the scale of the icon on the GUI scale.<br>~~
	~~Scale 2 means that the icon will be 2 times bigger on screen (and more pixelated).~~

	~~=== icon_mipmaps ===~~
	~~'''Type''': [[Types/uint8]]~~

	~~'''Default''': 0~~

	Icons of reduced size will be used at decreased scale. 0 or 1 mipmaps is a single image. The file must contain 1/2 size images with a geometric-ratio, for each mipmap level. Each next level is aligned to the upper-left corner. Example sequence: 128x128@(0,0), 64x64@(128,0), 32x32@(196,0) is 3 mipmaps.<br>See also [https://factorio.com/blog/post/fff-291 Factorio Friday Facts #291] about the visual effects of icon mipmaps.

	~~== Notes ==~~

	* The rendering order of the individual icons follows the table (array) order: Later added icons (higher index) get drawn on top of previously added icons (lower index).
	* Only the first icon layer will display a shadow.
	* When the final icon is displayed with transparency (e.g. a faded out alert), the icon layer overlap may look undesirable.[https://forums.factorio.com/viewtopic.php?p=575844#p575844]
	* The final combination of icons will always be resized in GUI based on the first icon layer's size, but won't be resized when displayed on machines in alt-mode.
	~~: (example: recipe first icon layer is size 128, scale 1, the icon group will be displayed at resolution /4 to fit the 32px GUI boxes, but will be displayed 4 times as large on buildings)~~
	* Shift values are based on final size (icon_size * scale) of the first icon.

	~~== Examples ==~~

	~~<syntaxhighlight lang="lua">{~~
	~~icon = "__base__/graphics/icons/fluid/heavy-oil.png",~~
	~~icon_size = 64,~~
	~~scale = 0.5,~~
	~~shift = {4, -8}~~
	~~}</syntaxhighlight>~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:42:30Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:42, 21 September 2023
Line 1:		Line 1:
	'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/types/IconData.html https://lua-api.factorio.com/latest/types/IconData.html]		<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/types/IconData.html https://lua-api.factorio.com/latest/types/IconData.html]

	This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].		</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>

BilkaBot: Protected "Types/IconData": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:51:38Z

Protected "Types/IconData": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision		Revision as of 17:51, 16 August 2023
(No difference)

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:51:38Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:51, 16 August 2023
Line 1:		Line 1:
			'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/types/IconData.html https://lua-api.factorio.com/latest/types/IconData.html]

			This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].



	== Basics ==		== Basics ==
	Data of one icon "layer" for the <code>icons</code> property of the [[Types/IconSpecification]].		Data of one icon "layer" for the <code>icons</code> property of the [[Types/IconSpecification]].

Bilka: /* Notes */ moved notes from Types/IconSpecification

2022-10-18T10:29:37Z

Notes: moved notes from Types/IconSpecification

← Older revision		Revision as of 10:29, 18 October 2022
Line 48:		Line 48:
	== Notes ==		== Notes ==

			* The rendering order of the individual icons follows the table (array) order: Later added icons (higher index) get drawn on top of previously added icons (lower index).
	* Only the first icon layer will display a shadow.		* Only the first icon layer will display a shadow.
			* When the final icon is displayed with transparency (e.g. a faded out alert), the icon layer overlap may look undesirable.[https://forums.factorio.com/viewtopic.php?p=575844#p575844]
	* The final combination of icons will always be resized in GUI based on the first icon layer's size, but won't be resized when displayed on machines in alt-mode.		* The final combination of icons will always be resized in GUI based on the first icon layer's size, but won't be resized when displayed on machines in alt-mode.
	: (example: recipe first icon layer is size 128, scale 1, the icon group will be displayed at resolution /4 to fit the 32px GUI boxes, but will be displayed 4 times as large on buildings)		: (example: recipe first icon layer is size 128, scale 1, the icon group will be displayed at resolution /4 to fit the 32px GUI boxes, but will be displayed 4 times as large on buildings)

Bilka: link mipmap fff

2022-10-18T10:01:49Z

link mipmap fff

← Older revision		Revision as of 10:01, 18 October 2022
Line 44:		Line 44:
	'''Default''': 0		'''Default''': 0

	Icons of reduced size will be used at decreased scale. 0 or 1 mipmaps is a single image. The file must contain 1/2 size images with a geometric-ratio, for each mipmap level. Each next level is aligned to the upper-left corner. Example sequence: 128x128@(0,0), 64x64@(128,0), 32x32@(196,0) is 3 mipmaps.		Icons of reduced size will be used at decreased scale. 0 or 1 mipmaps is a single image. The file must contain 1/2 size images with a geometric-ratio, for each mipmap level. Each next level is aligned to the upper-left corner. Example sequence: 128x128@(0,0), 64x64@(128,0), 32x32@(196,0) is 3 mipmaps.<br>See also [https://factorio.com/blog/post/fff-291 Factorio Friday Facts #291] about the visual effects of icon mipmaps.

	== Notes ==		== Notes ==

Bilka: moved default above description

2022-10-18T10:00:36Z

moved default above description

← Older revision		Revision as of 10:00, 18 October 2022
Line 41:		Line 41:
	=== icon_mipmaps ===		=== icon_mipmaps ===
	'''Type''': [[Types/uint8]]		'''Type''': [[Types/uint8]]

			'''Default''': 0

	Icons of reduced size will be used at decreased scale. 0 or 1 mipmaps is a single image. The file must contain 1/2 size images with a geometric-ratio, for each mipmap level. Each next level is aligned to the upper-left corner. Example sequence: 128x128@(0,0), 64x64@(128,0), 32x32@(196,0) is 3 mipmaps.		Icons of reduced size will be used at decreased scale. 0 or 1 mipmaps is a single image. The file must contain 1/2 size images with a geometric-ratio, for each mipmap level. Each next level is aligned to the upper-left corner. Example sequence: 128x128@(0,0), 64x64@(128,0), 32x32@(196,0) is 3 mipmaps.

	~~'''Default''': 0~~

	== Notes ==		== Notes ==

Honktown: /* icon_mipmaps */ tiniest inconsistency. changing comma to x between resolution example

2022-10-04T08:43:07Z

icon_mipmaps: tiniest inconsistency. changing comma to x between resolution example

← Older revision		Revision as of 08:43, 4 October 2022
Line 42:		Line 42:
	'''Type''': [[Types/uint8]]		'''Type''': [[Types/uint8]]

	Icons of reduced size will be used at decreased scale. 0 or 1 mipmaps is a single image. The file must contain 1/2 size images with a geometric-ratio, for each mipmap level. Each next level is aligned to the upper-left corner. Example sequence: 128x128@(0,0), ~~64,64~~@(128,0), 32x32@(196,0) is 3 mipmaps.		Icons of reduced size will be used at decreased scale. 0 or 1 mipmaps is a single image. The file must contain 1/2 size images with a geometric-ratio, for each mipmap level. Each next level is aligned to the upper-left corner. Example sequence: 128x128@(0,0), 64x64@(128,0), 32x32@(196,0) is 3 mipmaps.

	'''Default''': 0		'''Default''': 0

Honktown: /* icon_mipmaps */

2022-09-24T02:46:18Z

icon_mipmaps

← Older revision		Revision as of 02:46, 24 September 2022
Line 41:		Line 41:
	=== icon_mipmaps ===		=== icon_mipmaps ===
	'''Type''': [[Types/uint8]]		'''Type''': [[Types/uint8]]

	Icons of reduced size will be used at decreased scale. 0 or 1 mipmaps is a single image. The file must contain 1/2 size images with a geometric-ratio, for each mipmap level. Each next level is aligned to the upper-left corner. Example sequence: 128x128@(0,0), 64,64@(128,0), 32x32@(196,0) is 3 mipmaps.		Icons of reduced size will be used at decreased scale. 0 or 1 mipmaps is a single image. The file must contain 1/2 size images with a geometric-ratio, for each mipmap level. Each next level is aligned to the upper-left corner. Example sequence: 128x128@(0,0), 64,64@(128,0), 32x32@(196,0) is 3 mipmaps.

	'''Default''': 0		'''Default''': 0

Honktown: /* icon_mipmaps */ description

2022-09-24T02:41:30Z

icon_mipmaps: description

← Older revision		Revision as of 02:41, 24 September 2022
Line 41:		Line 41:
	=== icon_mipmaps ===		=== icon_mipmaps ===
	'''Type''': [[Types/uint8]]		'''Type''': [[Types/uint8]]
			Icons of reduced size will be used at decreased scale. 0 or 1 mipmaps is a single image. The file must contain 1/2 size images with a geometric-ratio, for each mipmap level. Each next level is aligned to the upper-left corner. Example sequence: 128x128@(0,0), 64,64@(128,0), 32x32@(196,0) is 3 mipmaps.
	'''Default''': 0		'''Default''': 0