Animation - Prototype Docs

Animation :: struct Example code

Specifies an animation that can be used in the game.

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

Inherits from AnimationParameters « SpriteParameters « SpriteSource

Properties

default

sorted

layers optional	:: array[Animation]	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. [...]
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. [...]
stripes optional	:: array[Stripe]	Only loaded if `layers` is not defined.
Only loaded if `layers` is not defined.
filenames optional	:: array[FileName]	Only loaded if neither `layers` nor `stripes` are defined.
Only loaded if neither `layers` nor `stripes` are defined.
slice optional	:: uint32	Only loaded if `layers` is not defined and if `filenames` is defined.
Only loaded if `layers` is not defined and if `filenames` is defined.
lines_per_file optional	:: uint32	Only loaded if `layers` is not defined. [...]
Only loaded if `layers` is not defined. [...]

Inherited from AnimationParameters

run_mode optional	:: AnimationRunMode
frame_count optional	:: uint32	Can't be `0`.
Can't be `0`.
line_length optional	:: uint32	Specifies how many pictures are on each horizontal line in the image file. [...]
Specifies how many pictures are on each horizontal line in the image file. [...]
animation_speed optional	:: float	Modifier of the animation playing speed, the default of `1` means one animation frame per tick (60 fps). [...]
Modifier of the animation playing speed, the default of `1` means one animation frame per tick (60 fps). [...]
max_advance optional	:: float	Maximum amount of frames the animation can move forward in one update. [...]
Maximum amount of frames the animation can move forward in one update. [...]
repeat_count optional	:: uint8	How many times to repeat the animation to complete an animation cycle. [...]
How many times to repeat the animation to complete an animation cycle. [...]
dice optional	:: uint8	Number of slices this is sliced into when using the "optimized atlas packing" option. [...]
Number of slices this is sliced into when using the "optimized atlas packing" option. [...]
dice_x optional	:: uint8	Same as `dice` above, but this specifies only how many slices there are on the x axis.
Same as `dice` above, but this specifies only how many slices there are on the x axis.
dice_y optional	:: uint8	Same as `dice` above, but this specifies only how many slices there are on the y axis.
Same as `dice` above, but this specifies only how many slices there are on the y axis.
frame_sequence optional	:: AnimationFrameSequence

Inherited from SpriteParameters

priority optional	:: SpritePriority
flags optional	:: SpriteFlags
shift optional	:: Vector	The shift in tiles. [...]
The shift in tiles. [...]
rotate_shift optional	:: bool	Whether to rotate the `shift` alongside the sprite's rotation. [...]
Whether to rotate the `shift` alongside the sprite's rotation. [...]
apply_special_effect optional	:: bool
scale optional	:: double	Values other than `1` specify the scale of the sprite on default zoom. [...]
Values other than `1` specify the scale of the sprite on default zoom. [...]
draw_as_shadow optional	:: bool	Only one of `draw_as_shadow`, `draw_as_glow` and `draw_as_light` can be true. [...]
Only one of `draw_as_shadow`, `draw_as_glow` and `draw_as_light` can be true. [...]
draw_as_glow optional	:: bool	Only one of `draw_as_shadow`, `draw_as_glow` and `draw_as_light` can be true. [...]
Only one of `draw_as_shadow`, `draw_as_glow` and `draw_as_light` can be true. [...]
draw_as_light optional	:: bool	Only one of `draw_as_shadow`, `draw_as_glow` and `draw_as_light` can be true.
Only one of `draw_as_shadow`, `draw_as_glow` and `draw_as_light` can be true.
mipmap_count optional	:: uint8	Only loaded if this is an icon, that is it has the flag `"group=icon"` or `"group=gui"`. [...]
Only loaded if this is an icon, that is it has the flag `"group=icon"` or `"group=gui"`. [...]
apply_runtime_tint optional	:: bool
tint_as_overlay optional	:: bool
invert_colors optional	:: bool
tint optional	:: Color
blend_mode optional	:: BlendMode
generate_sdf optional	:: bool	This property is only used by sprites used in UtilitySprites that have the `"icon"` flag set. [...]
This property is only used by sprites used in UtilitySprites that have the `"icon"` flag set. [...]
surface optional	:: SpriteUsageSurfaceHint	Provides hint to sprite atlas system, so it can try to put sprites that are intended to be used at the same locations to the same sprite atlas.
Provides hint to sprite atlas system, so it can try to put sprites that are intended to be used at the same locations to the same sprite atlas.
usage optional	:: SpriteUsageHint	Provides hint to sprite atlas system, so it can pack sprites that are related to each other to the same sprite atlas.
Provides hint to sprite atlas system, so it can pack sprites that are related to each other to the same sprite atlas.

Inherited from SpriteSource

filename[overridden]	:: FileName	The path to the sprite file to use.
The path to the sprite file to use.
size optional	:: SpriteSizeType or {SpriteSizeType, SpriteSizeType}	The width and height of the sprite. [...]
The width and height of the sprite. [...]
width optional	:: SpriteSizeType	Mandatory if `size` is not defined. [...]
Mandatory if `size` is not defined. [...]
height optional	:: SpriteSizeType	Mandatory if `size` is not defined. [...]
Mandatory if `size` is not defined. [...]
x optional	:: SpriteSizeType	Horizontal position of the sprite in the source file in pixels.
Horizontal position of the sprite in the source file in pixels.
y optional	:: SpriteSizeType	Vertical position of the sprite in the source file in pixels.
Vertical position of the sprite in the source file in pixels.
position optional	:: {SpriteSizeType, SpriteSizeType}	Loaded only when `x` and `y` are both `0`. [...]
Loaded only when `x` and `y` are both `0`. [...]
load_in_minimal_mode optional	:: bool	Minimal mode is entered when mod loading fails. [...]
Minimal mode is entered when mod loading fails. [...]
premul_alpha optional	:: bool	Whether alpha should be pre-multiplied.
Whether alpha should be pre-multiplied.
allow_forced_downscale optional	:: bool	If `true`, the sprite may be downsampled to half its size on load even when 'Sprite quality' graphics setting is set to 'High'. [...]
If `true`, the sprite may be downsampled to half its size on load even when 'Sprite quality' graphics setting is set to 'High'. [...]

filenames optional	:: array[FileName]	Only loaded if neither `layers` nor `stripes` are defined.
Only loaded if neither `layers` nor `stripes` are defined.
layers optional	:: array[Animation]	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. [...]
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. [...]
lines_per_file optional	:: uint32	Only loaded if `layers` is not defined. [...]
Only loaded if `layers` is not defined. [...]
slice optional	:: uint32	Only loaded if `layers` is not defined and if `filenames` is defined.
Only loaded if `layers` is not defined and if `filenames` is defined.
stripes optional	:: array[Stripe]	Only loaded if `layers` is not defined.
Only loaded if `layers` is not defined.

Inherited from AnimationParameters

animation_speed optional	:: float	Modifier of the animation playing speed, the default of `1` means one animation frame per tick (60 fps). [...]
Modifier of the animation playing speed, the default of `1` means one animation frame per tick (60 fps). [...]
dice optional	:: uint8	Number of slices this is sliced into when using the "optimized atlas packing" option. [...]
Number of slices this is sliced into when using the "optimized atlas packing" option. [...]
dice_x optional	:: uint8	Same as `dice` above, but this specifies only how many slices there are on the x axis.
Same as `dice` above, but this specifies only how many slices there are on the x axis.
dice_y optional	:: uint8	Same as `dice` above, but this specifies only how many slices there are on the y axis.
Same as `dice` above, but this specifies only how many slices there are on the y axis.
frame_count optional	:: uint32	Can't be `0`.
Can't be `0`.
frame_sequence optional	:: AnimationFrameSequence
line_length optional	:: uint32	Specifies how many pictures are on each horizontal line in the image file. [...]
Specifies how many pictures are on each horizontal line in the image file. [...]
max_advance optional	:: float	Maximum amount of frames the animation can move forward in one update. [...]
Maximum amount of frames the animation can move forward in one update. [...]
repeat_count optional	:: uint8	How many times to repeat the animation to complete an animation cycle. [...]
How many times to repeat the animation to complete an animation cycle. [...]
run_mode optional	:: AnimationRunMode

Inherited from SpriteParameters

apply_runtime_tint optional	:: bool
apply_special_effect optional	:: bool
blend_mode optional	:: BlendMode
draw_as_glow optional	:: bool	Only one of `draw_as_shadow`, `draw_as_glow` and `draw_as_light` can be true. [...]
Only one of `draw_as_shadow`, `draw_as_glow` and `draw_as_light` can be true. [...]
draw_as_light optional	:: bool	Only one of `draw_as_shadow`, `draw_as_glow` and `draw_as_light` can be true.
Only one of `draw_as_shadow`, `draw_as_glow` and `draw_as_light` can be true.
draw_as_shadow optional	:: bool	Only one of `draw_as_shadow`, `draw_as_glow` and `draw_as_light` can be true. [...]
Only one of `draw_as_shadow`, `draw_as_glow` and `draw_as_light` can be true. [...]
flags optional	:: SpriteFlags
generate_sdf optional	:: bool	This property is only used by sprites used in UtilitySprites that have the `"icon"` flag set. [...]
This property is only used by sprites used in UtilitySprites that have the `"icon"` flag set. [...]
invert_colors optional	:: bool
mipmap_count optional	:: uint8	Only loaded if this is an icon, that is it has the flag `"group=icon"` or `"group=gui"`. [...]
Only loaded if this is an icon, that is it has the flag `"group=icon"` or `"group=gui"`. [...]
priority optional	:: SpritePriority
rotate_shift optional	:: bool	Whether to rotate the `shift` alongside the sprite's rotation. [...]
Whether to rotate the `shift` alongside the sprite's rotation. [...]
scale optional	:: double	Values other than `1` specify the scale of the sprite on default zoom. [...]
Values other than `1` specify the scale of the sprite on default zoom. [...]
shift optional	:: Vector	The shift in tiles. [...]
The shift in tiles. [...]
surface optional	:: SpriteUsageSurfaceHint	Provides hint to sprite atlas system, so it can try to put sprites that are intended to be used at the same locations to the same sprite atlas.
Provides hint to sprite atlas system, so it can try to put sprites that are intended to be used at the same locations to the same sprite atlas.
tint optional	:: Color
tint_as_overlay optional	:: bool
usage optional	:: SpriteUsageHint	Provides hint to sprite atlas system, so it can pack sprites that are related to each other to the same sprite atlas.
Provides hint to sprite atlas system, so it can pack sprites that are related to each other to the same sprite atlas.

Inherited from SpriteSource

filename[overridden]	:: FileName	The path to the sprite file to use.
The path to the sprite file to use.
allow_forced_downscale optional	:: bool	If `true`, the sprite may be downsampled to half its size on load even when 'Sprite quality' graphics setting is set to 'High'. [...]
If `true`, the sprite may be downsampled to half its size on load even when 'Sprite quality' graphics setting is set to 'High'. [...]
height optional	:: SpriteSizeType	Mandatory if `size` is not defined. [...]
Mandatory if `size` is not defined. [...]
load_in_minimal_mode optional	:: bool	Minimal mode is entered when mod loading fails. [...]
Minimal mode is entered when mod loading fails. [...]
position optional	:: {SpriteSizeType, SpriteSizeType}	Loaded only when `x` and `y` are both `0`. [...]
Loaded only when `x` and `y` are both `0`. [...]
premul_alpha optional	:: bool	Whether alpha should be pre-multiplied.
Whether alpha should be pre-multiplied.
size optional	:: SpriteSizeType or {SpriteSizeType, SpriteSizeType}	The width and height of the sprite. [...]
The width and height of the sprite. [...]
width optional	:: SpriteSizeType	Mandatory if `size` is not defined. [...]
Mandatory if `size` is not defined. [...]
x optional	:: SpriteSizeType	Horizontal position of the sprite in the source file in pixels.
Horizontal position of the sprite in the source file in pixels.
y optional	:: SpriteSizeType	Vertical position of the sprite in the source file in pixels.
Vertical position of the sprite in the source file in pixels.

Properties

layers :: array[Animation] optional

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. layers may not be an empty table. Each definition in the array may also have the layers property.

animation_speed and max_advance of the first layer are used for all layers. All layers will run at the same speed.

If this property is present, all other properties, including those inherited from AnimationParameters, are ignored.

stripes :: array[Stripe] optional

Only loaded if layers is not defined.

filenames :: array[FileName] optional

Only loaded if neither layers nor stripes are defined.

slice :: uint32 optional

Default: Value of frame_count

Only loaded if layers is not defined and if filenames is defined.

lines_per_file :: uint32 optional

Only loaded if layers is not defined. Mandatory if filenames is defined.

Overridden Properties

filename :: FileName optional

Only loaded if layers is not defined. Mandatory if neither stripes nor filenames are defined.

The path to the sprite file to use.

Examples

-- simple animation
horizontal_animation =
{
  filename = "__base__/graphics/entity/steam-engine/steam-engine-H.png",
  width = 352,
  height = 257,
  frame_count = 32,
  line_length = 8,
  shift = {0.03125, -0.1484375}
}

-- animation with layers
horizontal_animation =
{
  layers =
  {
    {
      filename = "__base__/graphics/entity/steam-engine/steam-engine-H.png",
      width = 352,
      height = 257,
      frame_count = 32,
      line_length = 8,
      shift = {0.03125, -0.15625}
    },
    {
      filename = "__base__/graphics/entity/steam-engine/steam-engine-H-shadow.png",
      width = 508,
      height = 160,
      frame_count = 32,
      line_length = 8,
      draw_as_shadow = true,
      shift = {1.5, 0.75}
    }
  }
}

Type used in

Factorio Prototype Docs Version 2.0.26

Animation :: struct Example code

Properties

Properties

layers :: array[Animation] optional

stripes :: array[Stripe] optional

filenames :: array[FileName] optional

slice :: uint32 optional

lines_per_file :: uint32 optional

Overridden Properties

filename :: FileName optional

Examples

Prototypes

Types

Defines

Factorio Prototype DocsVersion 2.0.26

Animation :: struct Example code

Properties

Properties

layers :: array[Animation] optional

stripes :: array[Stripe] optional

filenames :: array[FileName] optional

slice :: uint32 optional

lines_per_file :: uint32 optional

Overridden Properties

filename :: FileName optional

Examples

Prototypes

Types

Defines

Factorio Prototype Docs Version 2.0.26