Types/SpriteVariations: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Created page with "Is specified by list of Types/Sprite definitions. It is typically used for different variations of the same object. Example: pictures = { { f...")
 
(Updated styling of prototype doc migration note)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Is specified by list of [[Types/Sprite]] definitions.
<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/types/SpriteVariations.html https://lua-api.factorio.com/latest/types/SpriteVariations.html]


It is typically used for different variations of the same object.
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
 
 
 
Either specified by a list (array) of [[Types/Sprite]] definitions, using [[#sheet]], or this is loaded as a [[Types/Sprite]] with the extra properties listed in [[#sheet]].
 
== Properties ==
 
=== sheet ===
'''Type''': [[Types/Sprite]]
 
A sprite. Does not use the <code>slice[_*]</code> or <code>dice[_*]</code> properties. Has the following extra optional properties:
 
* variation_count - [[Types/uint32]] - Default is 1.
* repeat_count - [[Types/uint32]] - Default is 1.
* line_length - [[Types/uint32]] - Default is the value of <code>variation_count</code>.


Example:
Example:
     pictures =
     <syntaxhighlight lang="lua">pictures =
       {
       {
         {
         {
Line 16: Line 31:
           height = 164
           height = 164
         },
         },
         {
         ...
          filename = "__base__/graphics/entity/decorative/green-carpet-grass/green-carpet-grass-03.png",
      }</syntaxhighlight>
          width = 173,
 
          height = 171
{{Prototype property type usage|{{FULLPAGENAME}}}}
        },
        {
          filename = "__base__/graphics/entity/decorative/green-carpet-grass/green-carpet-grass-04.png",
          width = 106,
          height = 172
        },
        {
          filename = "__base__/graphics/entity/decorative/green-carpet-grass/green-carpet-grass-05.png",
          width = 204,
          height = 186
        },
        {
          filename = "__base__/graphics/entity/decorative/green-carpet-grass/green-carpet-grass-06.png",
          width = 149,
          height = 138
        },
        {
          filename = "__base__/graphics/entity/decorative/green-carpet-grass/green-carpet-grass-07.png",
          width = 173,
          height = 160
        }
      }

Latest revision as of 10:42, 21 September 2023

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/types/SpriteVariations.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.


Either specified by a list (array) of Types/Sprite definitions, using #sheet, or this is loaded as a Types/Sprite with the extra properties listed in #sheet.

Properties

sheet

Type: Types/Sprite

A sprite. Does not use the slice[_*] or dice[_*] properties. Has the following extra optional properties:

Example:

pictures =
      {
        {
          filename = "__base__/graphics/entity/decorative/green-carpet-grass/green-carpet-grass-01.png",
          width = 105,
          height = 73
        },
        {
          filename = "__base__/graphics/entity/decorative/green-carpet-grass/green-carpet-grass-02.png",
          width = 185,
          height = 164
        },
        ...
      }

Prototype properties that use this type