Factorio Prototype DocsVersion 1.1.107

RotatedAnimation :: struct

Inherits from AnimationParameters « SpriteParameters

Properties

layers optional :: array[RotatedAnimation]

If this property is present, all RotatedAnimation definitions have to be placed as entries in the array, and they will all be loaded from there. [...]

If this property is present, all RotatedAnimation definitions have to be placed as entries in the array, and they will all be loaded from there. [...]

direction_count :: uint32

Only loaded if layers is not defined. [...]

Only loaded if layers is not defined. [...]

hr_version optional :: RotatedAnimation

Only loaded if layers is not defined. [...]

Only loaded if layers is not defined. [...]

filenames optional :: array[FileName]

Only loaded if both layers and stripes are not defined.

Only loaded if both layers and stripes are not defined.

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. [...]

Only loaded if layers is not defined. [...]

still_frame optional :: uint32

Only loaded if layers is not defined.

Only loaded if layers is not defined.

axially_symmetrical optional :: bool

Only loaded if layers is not defined. [...]

Only loaded if layers is not defined. [...]

counterclockwise optional :: bool

Only loaded if layers is not defined.

Only loaded if layers is not defined.

middle_orientation optional :: RealOrientation

Only loaded if layers is not defined.

Only loaded if layers is not defined.

orientation_range optional :: float

Only loaded if layers is not defined. [...]

Only loaded if layers is not defined. [...]

apply_projection optional :: bool

Only loaded if layers is not defined.

Only loaded if layers is not defined.

stripes optional :: array[Stripe]

Only loaded if layers is not defined.

Only loaded if layers is not defined.

Inherited from AnimationParameters
run_mode optional :: "forward" or "backward" or "forward-then-backward"
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
filename[overridden] :: 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. [...]

Properties

layers :: array[RotatedAnimation] optional

If this property is present, all RotatedAnimation 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.

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

direction_count :: uint32

Only loaded if layers is not defined.

The sequential animation instance is loaded equal to the entities direction within the direction_count setting.

Direction count to Direction (animation sequence number):

  • 1: North (1)

  • 2: North (1), South (2)

  • 4: North (1), East (2), South (3), West (4)

  • 8: North (1), Northeast (2), East (3), Southeast (4), South (5), Southwest (6), West (7), Northwest (8)

hr_version :: RotatedAnimation optional

Only loaded if layers is not defined.

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

filenames :: array[FileName] optional

Only loaded if both layers and stripes are not defined.

lines_per_file :: uint32 optional

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

slice :: uint32 optional

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

still_frame :: uint32 optional

Default: 0

Only loaded if layers is not defined.

axially_symmetrical :: bool optional

Default: false

Only loaded if layers is not defined.

If true, direction_count must be greater than 1.

counterclockwise :: bool optional

Default: false

Only loaded if layers is not defined.

middle_orientation :: RealOrientation optional

Default: 0.5

Only loaded if layers is not defined.

orientation_range :: float optional

Default: 1

Only loaded if layers is not defined.

Automatically clamped to be between 0 and 1.

apply_projection :: bool optional

Default: true

Only loaded if layers is not defined.

stripes :: array[Stripe] optional

Only loaded if layers is not defined.

Overridden Properties

filename :: FileName optional

Only loaded, and mandatory if layers, stripes, and filenames are not defined.

The path to the sprite file to use.

Prototypes

Types