AnimationSheet - Prototype Docs

AnimationSheet :: struct

Inherits from AnimationParameters « SpriteParameters

Properties

hr_version optional	:: AnimationSheet	If this property exists and high resolution sprites are turned on, this is used to load the AnimationSheet.
If this property exists and high resolution sprites are turned on, this is used to load the AnimationSheet.
variation_count	:: uint32

Inherited from AnimationParameters

run_mode optional	:: `"forward"` or `"backward"` or `"forward-then-backward"`
frame_count[overridden] optional	:: uint32	Can't be `0`.
Can't be `0`.
line_length[overridden] 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

filename	:: FileName	The path to the sprite file to use.
The path to the sprite file to use.
priority optional	:: SpritePriority
flags optional	:: SpriteFlags
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`. [...]
shift optional	:: Vector	The shift in tiles. [...]
The shift in tiles. [...]
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 optional	:: Color
blend_mode optional	:: BlendMode
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.
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. [...]

variation_count	:: uint32
hr_version optional	:: AnimationSheet	If this property exists and high resolution sprites are turned on, this is used to load the AnimationSheet.
If this property exists and high resolution sprites are turned on, this is used to load the AnimationSheet.

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[overridden] optional	:: uint32	Can't be `0`.
Can't be `0`.
frame_sequence optional	:: AnimationFrameSequence
line_length[overridden] 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	:: `"forward"` or `"backward"` or `"forward-then-backward"`

Inherited from SpriteParameters

filename	:: FileName	The path to the sprite file to use.
The path to the sprite file to use.
apply_runtime_tint 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. [...]
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. [...]
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"`.
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.
priority optional	:: SpritePriority
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. [...]
size optional	:: SpriteSizeType or {SpriteSizeType, SpriteSizeType}	The width and height of the sprite. [...]
The width and height of the sprite. [...]
tint optional	:: Color
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

hr_version :: AnimationSheet optional

If this property exists and high resolution sprites are turned on, this is used to load the AnimationSheet.

variation_count :: uint32

Overridden Properties

frame_count :: uint32 optional

Default: 1

line_length :: uint32 optional

Default: Value of variation_count

Type used in

Factorio Prototype Docs Version 1.1.107

AnimationSheet :: struct

Properties

Properties

hr_version :: AnimationSheet optional

variation_count :: uint32

Overridden Properties

frame_count :: uint32 optional

line_length :: uint32 optional

Prototypes

Types

Factorio Prototype DocsVersion 1.1.107

AnimationSheet :: struct

Properties

Properties

hr_version :: AnimationSheet optional

variation_count :: uint32

Overridden Properties

frame_count :: uint32 optional

line_length :: uint32 optional

Prototypes

Types

Factorio Prototype Docs Version 1.1.107