Types/Sprite - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:34Z

Removed old prototype docs

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:42:37Z

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/Sprite.html https://lua-api.factorio.com/latest/types/Sprite.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/Sprite.html https://lua-api.factorio.com/latest/types/Sprite.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/Sprite": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:51:47Z

Protected "Types/Sprite": 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:47Z

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/Sprite.html https://lua-api.factorio.com/latest/types/Sprite.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 ==
	Specifies one picture that can be used in the game.		Specifies one picture that can be used in the game.

Bilka: typo

2021-06-11T11:50:46Z

typo

← Older revision		Revision as of 11:50, 11 June 2021
Line 171:		Line 171:
	If this is set to true, the game will generate an icon shadow (using signed distance fields) for the sprite.		If this is set to true, the game will generate an icon shadow (using signed distance fields) for the sprite.

	Example of the icon shadow in the character modifier icon used by the ~~steelaxe~~ research.<br>		Example of the icon shadow in the character modifier icon used by the steel axe research.<br>
	[[File:Generate_sdf_example.png]]		[[File:Generate_sdf_example.png]]

Bilka: generate_sdf description

2021-06-11T11:48:19Z

generate_sdf description

← Older revision		Revision as of 11:48, 11 June 2021
Line 167:		Line 167:

	'''Default''': false		'''Default''': false

			This property is only used by sprites used in [[Prototype/UtilitySprites]] that have the "icon" flag.<br>
			If this is set to true, the game will generate an icon shadow (using signed distance fields) for the sprite.

			Example of the icon shadow in the character modifier icon used by the steelaxe research.<br>
			[[File:Generate_sdf_example.png]]

	== Example ==		== Example ==

Asdff45: Surround new draw_as_* descriptions with `tag`


2020-12-24T03:12:59Z
Surround new draw_as_* descriptions with <code>tag

				
				
				
				
				
				← Older revision
				Revision as of 03:12, 24 December 2020
				
Line 109:
Line 109:
'''Default''': false '''Default''': false



Only one of draw_as_shadow, draw_as_glow and draw_as_light can be true. draw_as_shadow takes precedence over draw_as_glow and draw_as_light. Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_shadow</code> takes precedence over <code>draw_as_glow</code> and <code>draw_as_light</code>.



=== draw_as_glow === === draw_as_glow ===
Line 116:
Line 116:
'''Default''': false '''Default''': false



Only one of draw_as_shadow, draw_as_glow and draw_as_light can be true. draw_as_glow takes precedence over draw_as_light. Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_glow</code> takes precedence over <code>draw_as_light</code>.



Draws first as a normal sprite, and again as a light layer.<sup>[https://forums.factorio.com/91682]</sup> Draws first as a normal sprite, and again as a light layer.<sup>[https://forums.factorio.com/91682]</sup>
Line 125:
Line 125:
'''Default''': false '''Default''': false



Only one of draw_as_shadow, draw_as_glow and draw_as_light can be true. Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true.



=== mipmap_count === === mipmap_count ===



Bilka: 1.1 draw_as_*
2020-12-14T13:19:05Z
1.1 draw_as_*

				
				
				
				
				
				← Older revision
				Revision as of 13:19, 14 December 2020
				
Line 108:
Line 108:



'''Default''': false '''Default''': false

Only one of draw_as_shadow, draw_as_glow and draw_as_light can be true. draw_as_shadow takes precedence over draw_as_glow and draw_as_light.

=== draw_as_glow ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of draw_as_shadow, draw_as_glow and draw_as_light can be true. draw_as_glow takes precedence over draw_as_light.

Draws first as a normal sprite, and again as a light layer.<sup>[https://forums.factorio.com/91682]</sup>

=== draw_as_light ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of draw_as_shadow, draw_as_glow and draw_as_light can be true.



=== mipmap_count === === mipmap_count ===





Bilka: Added dicing
2020-09-08T12:50:42Z
Added dicing

				
				
				
				
				
				← Older revision
				Revision as of 12:50, 8 September 2020
				
Line 28:
Line 28:
If this property exists and high resolution sprites are turned on, its contents are used to load the sprite. If this property exists and high resolution sprites are turned on, its contents are used to load the sprite.



=== slice === === slice or dice ===
'''Type''': [[Types/SpriteSizeType]] '''Type''': [[Types/SpriteSizeType]]



Line 35:
Line 35:
Example: If this is 4, the sprite will be sliced into a 4×4 grid. Example: If this is 4, the sprite will be sliced into a 4×4 grid.



=== slice_x === === slice_x or dice_x ===
'''Type''': [[Types/SpriteSizeType]] '''Type''': [[Types/SpriteSizeType]]



Same as <code>slice</code> above, but this specifies only how many slices there are on the x axis. Same as <code>slice</code> or <code>dice</code> above, but this specifies only how many slices there are on the x axis.



=== slice_y === === slice_y or dice_y ===
'''Type''': [[Types/SpriteSizeType]] '''Type''': [[Types/SpriteSizeType]]



Same as <code>slice</code> above, but this specifies only how many slices there are on the y axis. Same as <code>slice</code> or <code>dice</code> above, but this specifies only how many slices there are on the y axis.



=== priority === === priority ===





Bilka: Split sprite priority into own page
2020-05-04T11:59:45Z
Split sprite priority into own page

				
				
				
				
				
				← Older revision
				Revision as of 11:59, 4 May 2020
				
Line 46:
Line 46:



=== priority === === priority ===
'''Type''': [[Types/string]] '''Type''': [[Types/SpritePriority]]



'''Default''': "medium" '''Default''': "medium"

Possible values: 
* "extra-high-no-scale" 
* "extra-high" 
* "high" 
* "medium" 
* "low" 
* "very-low" 



=== flags === === flags ===

← Older revision		Revision as of 03:12, 24 December 2020
Line 109:		Line 109:
	'''Default''': false		'''Default''': false

	Only one of draw_as_shadow, draw_as_glow and draw_as_light can be true. draw_as_shadow takes precedence over draw_as_glow and draw_as_light.		Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_shadow</code> takes precedence over <code>draw_as_glow</code> and <code>draw_as_light</code>.

	=== draw_as_glow ===		=== draw_as_glow ===
Line 116:		Line 116:
	'''Default''': false		'''Default''': false

	Only one of draw_as_shadow, draw_as_glow and draw_as_light can be true. draw_as_glow takes precedence over draw_as_light.		Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_glow</code> takes precedence over <code>draw_as_light</code>.

	Draws first as a normal sprite, and again as a light layer.<sup>[https://forums.factorio.com/91682]</sup>		Draws first as a normal sprite, and again as a light layer.<sup>[https://forums.factorio.com/91682]</sup>
Line 125:		Line 125:
	'''Default''': false		'''Default''': false

	Only one of draw_as_shadow, draw_as_glow and draw_as_light can be true.		Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true.

	=== mipmap_count ===		=== mipmap_count ===

← Older revision		Revision as of 13:19, 14 December 2020
Line 108:		Line 108:

	'''Default''': false		'''Default''': false

			Only one of draw_as_shadow, draw_as_glow and draw_as_light can be true. draw_as_shadow takes precedence over draw_as_glow and draw_as_light.

			=== draw_as_glow ===
			'''Type''': [[Types/bool]]

			'''Default''': false

			Only one of draw_as_shadow, draw_as_glow and draw_as_light can be true. draw_as_glow takes precedence over draw_as_light.

			Draws first as a normal sprite, and again as a light layer.<sup>[https://forums.factorio.com/91682]</sup>

			=== draw_as_light ===
			'''Type''': [[Types/bool]]

			'''Default''': false

			Only one of draw_as_shadow, draw_as_glow and draw_as_light can be true.

	=== mipmap_count ===		=== mipmap_count ===

← Older revision		Revision as of 12:50, 8 September 2020
Line 28:		Line 28:
	If this property exists and high resolution sprites are turned on, its contents are used to load the sprite.		If this property exists and high resolution sprites are turned on, its contents are used to load the sprite.

	=== slice ===		=== slice or dice ===
	'''Type''': [[Types/SpriteSizeType]]		'''Type''': [[Types/SpriteSizeType]]

Line 35:		Line 35:
	Example: If this is 4, the sprite will be sliced into a 4×4 grid.		Example: If this is 4, the sprite will be sliced into a 4×4 grid.

	=== slice_x ===		=== slice_x or dice_x ===
	'''Type''': [[Types/SpriteSizeType]]		'''Type''': [[Types/SpriteSizeType]]

	Same as <code>slice</code> above, but this specifies only how many slices there are on the x axis.		Same as <code>slice</code> or <code>dice</code> above, but this specifies only how many slices there are on the x axis.

	=== slice_y ===		=== slice_y or dice_y ===
	'''Type''': [[Types/SpriteSizeType]]		'''Type''': [[Types/SpriteSizeType]]

	Same as <code>slice</code> above, but this specifies only how many slices there are on the y axis.		Same as <code>slice</code> or <code>dice</code> above, but this specifies only how many slices there are on the y axis.

	=== priority ===		=== priority ===

← Older revision		Revision as of 11:59, 4 May 2020
Line 46:		Line 46:

	=== priority ===		=== priority ===
	'''Type''': [[Types/~~string~~]]		'''Type''': [[Types/SpritePriority]]

	'''Default''': "medium"		'''Default''': "medium"

	~~Possible values:~~
	* "extra-high-no-scale"
	* "extra-high"
	* "high"
	* "medium"
	* "low"
	* "very-low"

	=== flags ===		=== flags ===

Types/Sprite - Revision history

BilkaBot: Removed old prototype docs

BilkaBot: Updated styling of prototype doc migration note

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

BilkaBot: Migrated prototype doc to separate website

Bilka: typo

Bilka: generate_sdf description

Asdff45: Surround new draw_as_* descriptions with tag

Bilka: 1.1 draw_as_*

Bilka: Added dicing

Bilka: Split sprite priority into own page

Asdff45: Surround new draw_as_* descriptions with `tag`