Types/Animation - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:15Z

Removed old prototype docs

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:42:19Z

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

2023-08-16T17:51:27Z

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

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

Bilka: copied the info of the one property that was missing

2023-07-03T13:44:21Z

copied the info of the one property that was missing

← Older revision		Revision as of 13:44, 3 July 2023
Line 3:		Line 3:

	Note that if any frame of the animation is specified from the same source as any other [[Types/Sprite]] or frame of other animation, it will be shared.		Note that if any frame of the animation is specified from the same source as any other [[Types/Sprite]] or frame of other animation, it will be shared.

	~~Also take a look at [[Types/Sprite]], as it shares many properties with animation and some of them may be better documented.~~

	== Optional properties ==		== Optional properties ==
Line 77:		Line 75:

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

			In tiles. util.by_pixel() can be used to divide the shift by 32 which is the usual pixel height/width of 1 tile in normal resolution. Note that 32 pixel tile height/width is not enforced anywhere - any other tile height or width is also possible.

	=== scale ===		=== scale ===

Curiosity: dice description + sprite/animation similarity note

2023-04-05T16:21:11Z

dice description + sprite/animation similarity note

← Older revision		Revision as of 16:21, 5 April 2023
Line 3:		Line 3:

	Note that if any frame of the animation is specified from the same source as any other [[Types/Sprite]] or frame of other animation, it will be shared.		Note that if any frame of the animation is specified from the same source as any other [[Types/Sprite]] or frame of other animation, it will be shared.

			Also take a look at [[Types/Sprite]], as it shares many properties with animation and some of them may be better documented.

	== Optional properties ==		== Optional properties ==
Line 205:		Line 207:
	=== dice ===		=== dice ===
	'''Type''': [[Types/uint8]]		'''Type''': [[Types/uint8]]

			Number of slices this is sliced into when using the "optimized atlas packing" option. If you are a modder, you can just ignore this property.

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

	=== dice_x ===		=== dice_x ===
	'''Type''': [[Types/uint8]]		'''Type''': [[Types/uint8]]

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

	=== dice_y ===		=== dice_y ===
	'''Type''': [[Types/uint8]]		'''Type''': [[Types/uint8]]

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

	=== frame_sequence ===		=== frame_sequence ===

Bilka: max_advance is also only needed once per layers

2022-11-07T11:10:08Z

max_advance is also only needed once per layers

← Older revision		Revision as of 11:10, 7 November 2022
Line 191:		Line 191:

	'''Default''': MAX_FLOAT		'''Default''': MAX_FLOAT

			If <code>layers</code> are used then <code>max_advance</code> only has to be defined in one layer.

	=== repeat_count ===		=== repeat_count ===

Stringweasel: animation_speed only has to be defined in one layer

2022-10-28T18:00:03Z

animation_speed only has to be defined in one layer

← Older revision		Revision as of 18:00, 28 October 2022
Line 185:		Line 185:
	Modifier of the animation playing speed, the default is 1, which means one animation frame per tick (60 fps).		Modifier of the animation playing speed, the default is 1, which means one animation frame per tick (60 fps).
	The speed of playing can often vary depending on the usage (output of steam engine for example). Has to be greater than 0.		The speed of playing can often vary depending on the usage (output of steam engine for example). Has to be greater than 0.
			If <code>layers</code> are used then the <code>animation_speed</code> only has to be defined in one layer. All layers will run at the same speed.

	=== max_advance ===		=== max_advance ===

Honktown: /* repeat_count */ description

2022-08-17T02:29:46Z

repeat_count: description

← Older revision		Revision as of 02:29, 17 August 2022
Line 195:		Line 195:

	'''Default''': 1		'''Default''': 1

			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:38Z

updated line_length description

← Older revision		Revision as of 15:54, 7 April 2022
Line 174:		Line 174:

	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.

	=== animation_speed ===		=== animation_speed ===