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

Factorio Prototype DocsVersion 1.1.100

Home / Types / Animation<>

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

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.

    hr_version optional :: Animation

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

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

    stripes :: array[Stripe] optional

    Only loaded if layers is not defined.

    Overridden Properties

    filename :: FileName optional

    Only loaded if layers is not defined. Mandatory if stripes is not 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 = 176,
  height = 128,
  frame_count = 32,
  line_length = 8,
  shift = {0.03125, -0.15625}
}

    -- animation with hr version
horizontal_animation =
{
  filename = "__base__/graphics/entity/steam-engine/steam-engine-H.png",
  width = 176,
  height = 128,
  frame_count = 32,
  line_length = 8,
  shift = {0.03125, -0.15625},
  hr_version =
  {
    filename = "__base__/graphics/entity/steam-engine/hr-steam-engine-H.png",
    width = 352,
    height = 257,
    frame_count = 32,
    line_length = 8,
    shift = {0.03125, -0.1484375},
    scale = 0.5
  }
}

    -- animation with layers
horizontal_animation =
{
  layers =
  {
    {
      filename = "__base__/graphics/entity/steam-engine/steam-engine-H.png",
      width = 176,
      height = 128,
      frame_count = 32,
      line_length = 8,
      shift = {0.03125, -0.15625}
    },
    {
      filename = "__base__/graphics/entity/steam-engine/steam-engine-H-shadow.png",
      width = 254,
      height = 80,
      frame_count = 32,
      line_length = 8,
      draw_as_shadow = true,
      shift = {1.5, 0.75}
    }
  }
}
    Type used in
    Prototypes - Types - Inheritance Tree|<

    Prototypes

    Types

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