Factorio.com|Forums|Wiki|Mod Portal|API DocsPrototype|Runtime

Factorio Prototype DocsVersion 1.1.107

Home / Types / Sprite><

Sprite :: struct Example code

Specifies one picture that can be used in the game.

When there is more than one sprite or Animation frame with the same source file and dimensions/position in the game, they all share the same memory.

Inherits from SpriteParameters

Properties

  • default
  • sorted
    • layers optional :: array[Sprite]

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

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

    hr_version optional :: Sprite

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

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

    slice or dice optional :: SpriteSizeType

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

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

    slice_x or dice_x optional :: SpriteSizeType

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

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

    slice_y or dice_y optional :: SpriteSizeType

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

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

    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[Sprite] optional

    If this property is present, all Sprite 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 SpriteParameters, are ignored.

    hr_version :: Sprite 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 Sprite.

    slice or dice :: SpriteSizeType optional

    Only loaded if layers is not defined.

    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. As an example, if this is 4, the sprite will be sliced into a 4x4 grid.

    slice_x or dice_x :: SpriteSizeType optional

    Only loaded if layers is not defined.

    Same as slice, but this specifies only how many slices there are on the x-axis.

    slice_y or dice_y :: SpriteSizeType optional

    Only loaded if layers is not defined.

    Same as slice, but this specifies only how many slices there are on the y-axis.

    Overridden Properties

    filename :: FileName optional

    Only loaded, and mandatory if layers is not defined.

    The path to the sprite file to use.

    Examples 

    -- simple sprite
picture_set_enemy =
{
  filename = "__base__/graphics/entity/land-mine/land-mine-set-enemy.png",
  priority = "medium",
  width = 32,
  height = 32
}

    -- sprite with hr version
picture =
{
  filename = "__base__/graphics/entity/wooden-chest/wooden-chest.png",
  priority = "extra-high",
  width = 32,
  height = 36,
  shift = util.by_pixel(0.5, -2),
  hr_version =
  {
    filename = "__base__/graphics/entity/wooden-chest/hr-wooden-chest.png",
    priority = "extra-high",
    width = 62,
    height = 72,
    shift = util.by_pixel(0.5, -2),
    scale = 0.5
  }
}

    -- sprite with layers
picture =
{
  layers =
  {
    {
      filename = "__base__/graphics/entity/wooden-chest/wooden-chest.png",
      priority = "extra-high",
      width = 32,
      height = 36,
      shift = util.by_pixel(0.5, -2)
    },
    {
      filename = "__base__/graphics/entity/wooden-chest/wooden-chest-shadow.png",
      priority = "extra-high",
      width = 52,
      height = 20,
      shift = util.by_pixel(10, 6.5),
      draw_as_shadow = true
    }
  }
}

    -- sprite with layers and hr version
picture =
{
  layers =
  {
    {
      filename = "__base__/graphics/entity/wooden-chest/wooden-chest.png",
      priority = "extra-high",
      width = 32,
      height = 36,
      shift = util.by_pixel(0.5, -2),
      hr_version =
      {
        filename = "__base__/graphics/entity/wooden-chest/hr-wooden-chest.png",
        priority = "extra-high",
        width = 62,
        height = 72,
        shift = util.by_pixel(0.5, -2),
        scale = 0.5
      }
    },
    {
      filename = "__base__/graphics/entity/wooden-chest/wooden-chest-shadow.png",
      priority = "extra-high",
      width = 52,
      height = 20,
      shift = util.by_pixel(10, 6.5),
      draw_as_shadow = true,
      hr_version =
      {
        filename = "__base__/graphics/entity/wooden-chest/hr-wooden-chest-shadow.png",
        priority = "extra-high",
        width = 104,
        height = 40,
        shift = util.by_pixel(10, 6.5),
        draw_as_shadow = true,
        scale = 0.5
      }
    }
  }
}
    Type used in
    Prototypes - Types - Inheritance Tree|<

    Prototypes

    Types

    >|
    Copyright © Wube Software |License|Download|Feedback