Prototype/Animation - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:42Z

Removed old prototype docs

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:42:46Z

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

2023-08-16T17:51:58Z

Protected "Prototype/Animation": 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:58Z

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/prototypes/AnimationPrototype.html https://lua-api.factorio.com/latest/prototypes/AnimationPrototype.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].



	{{Prototype parent}}		{{Prototype parent}}
	Specifies a animation that can be used by https://lua-api.factorio.com/latest/LuaRendering.html#LuaRendering.draw_animation during runtime.		Specifies a animation that can be used by https://lua-api.factorio.com/latest/LuaRendering.html#LuaRendering.draw_animation during runtime.

Bilka: Fixed copy paste issue for layers description

2022-11-07T11:46:10Z

Fixed copy paste issue for layers description

← Older revision		Revision as of 11:46, 7 November 2022
Line 17:		Line 17:
	If this property is present, all Animation definitions have to be placed as entries in the array, and they will all be loaded from there. Each item (Animation definition) in the array may also have the <code>layers</code> property.		If this property is present, all Animation definitions have to be placed as entries in the array, and they will all be loaded from there. Each item (Animation definition) in the array may also have the <code>layers</code> property.

	If this property is present, all other properties are ignored ~~and the~~ mandatory properties ~~do not~~ have to be defined.		If this property is present, all other optional properties are ignored. The mandatory properties (<code>name</code> and <code>type</code>) still have to be defined.

	Layers may not be an empty table.		Layers may not be an empty table.

Bilka: repeat_count desc copied from Types/Animation

2022-09-21T10:19:22Z

repeat_count desc copied from Types/Animation

← Older revision		Revision as of 10:19, 21 September 2022
Line 109:		Line 109:

	{{Prototype property\|repeat_count\|[[Types/uint8\|uint8]]\|1\|optional=true}}		{{Prototype property\|repeat_count\|[[Types/uint8\|uint8]]\|1\|optional=true}}
			How many times to repeat the animation to complete an animation cycle. E.g. if one layer is 10 frames, a second layer of 1 frame would need repeat_count = 10 to match the complete cycle.

	Can't be 0.		Can't be 0.

Bilka: updated line_length description

2022-04-07T15:54:44Z

updated line_length description

← Older revision		Revision as of 15:54, 7 April 2022
Line 98:		Line 98:
	{{Prototype property\|line_length\|[[Types/uint32\|uint32]]\|0\|optional=true}}		{{Prototype property\|line_length\|[[Types/uint32\|uint32]]\|0\|optional=true}}
	Once the specified number of pictures is loaded, other pictures are loaded on other line.		Once the specified number of pictures is loaded, other pictures are loaded on other line.
	This is to allow having longer animations in matrix, to ~~avoid pictures~~ with too ~~big~~ width.		This is to allow having longer animations in matrix, to input files with too high width.
	The game engine limits the width of any input ~~picture~~ to ~~2048px~~, so it is compatible with most graphics cards.		The game engine limits the width of any input files to 8192px, so it is compatible with most graphics cards.
			0 means that all the pictures are in one horizontal line.

	{{Prototype property\|animation_speed\|[[Types/float\|float]]\|1\|optional=true}}		{{Prototype property\|animation_speed\|[[Types/float\|float]]\|1\|optional=true}}

Bilka: mipmap_count desc expansion regarding usefulness

2021-07-29T12:21:37Z

mipmap_count desc expansion regarding usefulness

← Older revision		Revision as of 12:21, 29 July 2021
Line 69:		Line 69:

	{{Prototype property\|mipmap_count\|[[Types/uint8\|uint8]]\|0\|optional=true}}		{{Prototype property\|mipmap_count\|[[Types/uint8\|uint8]]\|0\|optional=true}}
	Only loaded if this is an icon (has flag "group=icon" or "group=gui").		Only loaded if this is an icon (has flag "group=icon" or "group=gui").<br>
			Note: mipmap_count doesn't make sense in animation, as it is not possible to layout mipmaps in a way, that would load correctly both the animation and the mipmaps (besides animations with just one frame).[https://forums.factorio.com/viewtopic.php?p=549058#p549058]

	{{Prototype property\|apply_runtime_tint\|[[Types/bool\|bool]]\|false\|optional=true}}		{{Prototype property\|apply_runtime_tint\|[[Types/bool\|bool]]\|false\|optional=true}}

Bilka: generate_sdf description

2021-06-11T11:48:13Z

generate_sdf description

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

	{{Prototype property\|generate_sdf\|[[Types/bool\|bool]]\|false\|optional=true}}		{{Prototype property\|generate_sdf\|[[Types/bool\|bool]]\|false\|optional=true}}
			Unused.

	{{Prototype property\|run_mode\|[[Types/string\|string]]\|"forward"\|optional=true}}		{{Prototype property\|run_mode\|[[Types/string\|string]]\|"forward"\|optional=true}}

Asdff45: use `around targets in new draw_as_glow and draw_as_light`


2020-12-23T00:41:33Z
use <code> around targets in new draw_as_glow and draw_as_light

				
				
				
				
				
				← Older revision
				Revision as of 00:41, 23 December 2020
				
Line 58:
Line 58:



{{Prototype property|draw_as_shadow|[[Types/bool|bool]]|false|optional=true}} {{Prototype property|draw_as_shadow|[[Types/bool|bool]]|false|optional=true}}
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>.



{{Prototype property|draw_as_glow |[[Types/bool|bool]]|false|optional=true}} {{Prototype property|draw_as_glow |[[Types/bool|bool]]|false|optional=true}}
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>



{{Prototype property|draw_as_light |[[Types/bool|bool]]|false|optional=true}} {{Prototype property|draw_as_light |[[Types/bool|bool]]|false|optional=true}}
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.



{{Prototype property|mipmap_count|[[Types/uint8|uint8]]|0|optional=true}} {{Prototype property|mipmap_count|[[Types/uint8|uint8]]|0|optional=true}}

← Older revision		Revision as of 00:41, 23 December 2020
Line 58:		Line 58:

	{{Prototype property\|draw_as_shadow\|[[Types/bool\|bool]]\|false\|optional=true}}		{{Prototype property\|draw_as_shadow\|[[Types/bool\|bool]]\|false\|optional=true}}
	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>.

	{{Prototype property\|draw_as_glow \|[[Types/bool\|bool]]\|false\|optional=true}}		{{Prototype property\|draw_as_glow \|[[Types/bool\|bool]]\|false\|optional=true}}
	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>

	{{Prototype property\|draw_as_light \|[[Types/bool\|bool]]\|false\|optional=true}}		{{Prototype property\|draw_as_light \|[[Types/bool\|bool]]\|false\|optional=true}}
	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.

	{{Prototype property\|mipmap_count\|[[Types/uint8\|uint8]]\|0\|optional=true}}		{{Prototype property\|mipmap_count\|[[Types/uint8\|uint8]]\|0\|optional=true}}