Factorio Prototype DocsVersion 1.1.107

The path to the sprite file to use.

Default: "medium"

The width and height of the sprite. If this is a tuple, the first member of the tuple is the width and the second is the height. Otherwise the size is both width and height. Width and height may only be in the range of 0-8192.

Mandatory if size is not defined.

Width of the picture in pixels, from 0-8192.

Mandatory if size is not defined.

Height of the picture in pixels, from 0-8192.

Default: 0

Horizontal position of the sprite in the source file in pixels.

Default: 0

Vertical position of the sprite in the source file in pixels.

Loaded only when x and y are both 0. The first member of the tuple is x and the second is y.

Default: {0, 0}

The shift 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.

Default: 1

Values other than 1 specify the scale of the sprite on default zoom. A scale of 2 means that the picture will be two times bigger on screen (and thus more pixelated).

Default: false

Only one of draw_as_shadow, draw_as_glow and draw_as_light can be true. This takes precedence over draw_as_glow and draw_as_light.

Default: false

Only one of draw_as_shadow, draw_as_glow and draw_as_light can be true. This takes precedence over draw_as_light.

Draws first as a normal sprite, then again as a light layer. See https://forums.factorio.com/91682.

Default: false

Only one of draw_as_shadow, draw_as_glow and draw_as_light can be true.

Default: 0

Only loaded if this is an icon, that is it has the flag "group=icon" or "group=gui".

Default: false

Default: {r=1, g=1, b=1, a=1}

Default: "normal"

Default: false

Minimal mode is entered when mod loading fails. You are in it when you see the gray box after (part of) the loading screen that tells you a mod error (Example). Modders can ignore this property.

Default: true

Whether alpha should be pre-multiplied.

Default: false

This property is only used by sprites used in UtilitySprites that have the "icon" flag set.

If this is set to true, the game will generate an icon shadow (using signed distance fields) for the sprite.