Official Factorio Wiki - User contributions [en]

Mod portal API

2024-10-15T15:57:09Z

Asdff45: add score to response

<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal|Internal API]]</div>

The Mod Portal API is used to both browse and download all mods available on the [https://mods.factorio.com/ official Factorio mod portal]. Using the API does not require any kind of authentication or account information and can be viewed simply by following the URLs below in any web browser.

<code>https://mods.factorio.com/api/mods</code>

More detailed information about a particular mod can be obtained by retrieving the following URL, where {name} is the mod's name field in the result object.

<code>https://mods.factorio.com/api/mods/{name}</code>

To get even more information about a mod, you can use the following URL.

<code>https://mods.factorio.com/api/mods/{name}/full</code>

== Endpoints ==

=== /api/mods ===

GET Parameters (sent as query parameters):

{| class="wikitable"
! Key !! Values !! Description
|-
| hide_deprecated || {boolean} || Only return non-deprecated mods.
|-
| page ||{an integer}||Page number you would like to show. Makes it so you can see a certain part of the list without getting detail on all
|-
| page_size ||{an integer or 'max'}||The amount of results to show in your search
|-
| sort || {enum, one of name, created_at or updated_at} || Sort results by this property. Defaults to name when not defined. Ignored for <code>page_size=max</code> queries.
|-
| sort_order || {enum, one of asc or desc} || Sort results ascending or descending. Defaults to descending when not defined. Ignored for <code>page_size=max</code> queries.
|-
| namelist || {array of strings} || Return only mods that match the given names. Either comma-separated names or supply the namelist parameter more than once. Response will include <code>releases</code> instead of <code>latest_release</code>.
|-
| version || {enum, one of 0.13, 0.14, 0.15, 0.16, 0.17, 0.18, 1.0 or 1.1} || Only return non-deprecated mods compatible with this Factorio version
|}

Returns [[#Mod List Response]]

=== /api/mods/{mod_name} ===

Return short information of a specific mod.

See [[#Result Entry]], "Short" column.

=== /api/mods/{mod_name}/full ===

Returns more information of a mod.

See [[#Result Entry]], "Full" column.

== JSON Object Types ==

=== Mod List Response ===

{| class="wikitable"
! Key !! Type !! Description
|-
| pagination || [[#Pagination|Pagination]] || See [[#Pagination]]
|-
| results || [[#Result Entry|Result]][] || A list of mods, matching any filters you specified.
|}

=== Pagination ===

{| class="wikitable"
! Key !! Type !! Description
|-
| count || Integer || Total number of mods that match your specified filters.
|-
| links || [[#Pagination_Links|Links]] || Utility links to mod portal api requests, preserving all filters and search queries.
|-
| page || Integer || The current page number.
|-
| page_count || Integer || The total number of pages returned.
|-
| page_size || Integer || The number of results per page.
|}

=== Pagination Links ===

{| class="wikitable"
! Key !! Type !! Description
|-
| first || String(URL) || URL to the first page of the results, or null if you're already on the first page.
|-
| prev || String(URL) || URL to the previous page of the results, or null if you're already on the first page.
|-
| next || String(URL) || URL to the next page of the results, or null if you're already on the last page.
|-
| last || String(URL) || URL to the last page of the results, or null if you're already on the last page.
|}

=== Result Entry ===

Fields returned by the api/mods endpoint are marked with a check (✓) in the "api/mods endpoint" column, those returned by the api/mods/{name} endpoint are marked with a check in the "Short" column and those returned by the api/mods/{name}/full endpoint are marked in the "Full" column. Fields may be absent if there is no data.

{| class="wikitable"
! Key !! Type !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | api/mods endpoint !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Short !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Full !! Description
|-
| latest_release || [[#Releases|Release]]? || ✓ || ||
| The latest version of the mod available for download. Absent when the <code>namelist</code> [[#/api/mods|parameter]] is used.
|-
| downloads_count || Integer || ✓ || ✓ || ✓
| Number of downloads.
|-
| name || String || ✓ || ✓ || ✓
| The mod's machine-readable ID string.
|-
| owner || String || ✓ || ✓ || ✓
| The Factorio username of the mod's author.
|-
| releases || [[#Releases|Release]][] || ✓* || ✓ || ✓
| A list of different versions of the mod available for download. See [[#Releases]]. *Only when using <code>namelist</code> [[#/api/mods|parameter]].
|-
| summary || String || ✓ || ✓ || ✓
| A shorter mod description.
|-
| title || String || ✓ || ✓ || ✓
| The mod's human-readable name.
|-
| category || [[Mod_details_API#Category|Category]]? || ✓ || ✓ || ✓
| A single category describing the mod. See [[Mod_details_API#Category]].

|-
| score || Integer || ✓ || ✓* || ✓*
| The score of the mod. *Only when not 0.
|-
| thumbnail || String(relative URL) || || ✓ || ✓
| The relative path to the thumbnail of the mod. For mods that have no thumbnail it may be absent or default to <code>"/assets/.thumb.png"</code>. Prepend "assets-mod.factorio.com".
|-
| changelog || String || || || ✓
| A string describing the recent changes to a mod.
|-
| created_at || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was created.
|-
| description || String || || || ✓
| A longer description of the mod, in text only format.
|-
| source_url || String || || || ✓
| A URL to the mod's source code.
|-
| github_path || String || || || ✓
| Deprecated: Use <code>source_url</code> instead. A link to the mod's github project page, just prepend "github.com/". Can be blank ("").
|-
| homepage || String || || || ✓
| Usually a URL to the mod's main project page, but can be any string.
|-
| tags || [[#Tags|Tag]][] || || || ✓
| A list of tag names that categorize the mod. See [[#Tags]].
|-
| license || [[#License]][] || || || ✓
| The license that applies to the mod. See [[#License]].
|-
| deprecated || Boolean? || || || ✓
| <ref></ref>True if the mod is marked as deprecated by its owner. Absent when false.
|-
|}

=== Releases ===

Only difference here between the api/mods/{name} endpoint and the api/mods/{name}/full endpoint is that the full one includes an array of dependencies in the info_json object.

{| class="wikitable"
! Key !! Type !! Description
|-
| download_url || String
| Path to download for a mod. starts with "/download" and does not include a full url. See [[#Downloading Mods]]
|-
| file_name || String
| The file name of the release. Always seems to follow the pattern "{name}_{version}.zip"
|-
| info_json || Object
| A copy of the mod's info.json file, only contains factorio_version in short version, also contains an array of dependencies in full version
|-
| released_at || String(ISO 8601)
| ISO 8601 for when the mod was released.
|-
| version || String
| The version string of this mod release. Used to determine dependencies.
|-
| sha1 || String
| The sha1 key for the file
|-
|}

=== Tags ===

Currently, there are only a fixed number of tags available, these include:

{| class="wikitable"
! id !! type !! name !! title !! description
|-
| 12 || t || transportation || Transportation || Transportation of the player, be it vehicles or teleporters.
|-
| 13 || t || logistics || Logistics || Augmented or new ways of transporting materials - belts, inserters, pipes!
|-
| ?? || t || combat || Combat || New ways to deal with enemies, be it attack or defense.
|-
| 17 || t || enemies || Enemies || Changes to enemies or entirely new enemies to deal with.
|-
| 18 || t || armor || Armor || Armors or armor equipment.
|-
| ?? || t || environment || Environment || Map generation and terrain modification.
|-
| 20 || t || logistic-network || Logistics Network || Related to roboports and logistic robots
|-
| ?? || t || circuit-network || Circuit network || Entities which interact with the circuit network.
|-
| 21 || t || storage || Storage || More than just chests.
|-
| 22 || t || power || Power Production || Changes to power production and distribution.
|-
| 23 || t || manufacturing || Manufacture || Furnaces, assembling machines, production chains
|-
| 24 || t || blueprints || Blueprints || Change blueprint behavior.
|-
| 25 || t || cheats || Cheats || Play it your way.
|-
| 27 || t || mining || Mining || New ores and resources as well as machines.
|-
| ?? || t || fluids || Fluids || Things related to oil and other fluids.
|-
| 29 || t || trains || Trains || Trains are great, but what if they could do even more?
|}

=== License ===

{| class="wikitable"
! Key !! Type !! Description
|-
| description || String || A short description of the license.
|-
| id || String || The unique id of the license.
|-
| name || String || The internal name of the license.
|-
| title || String || The human-readable title of the license.
|-
| url || String || Usually a URL to the full license text, but can be any string.
|}

=== Error ===

{| class="wikitable"
! Key !! Type !! Description
|-
| message || String ||
|}

== Downloading Mods ==

You can get the full url by appending the download_url to mods.factorio.com, but if you're not authenticated, you will be redirected to mods.factorio.com/login. Logging in to that would give you access to the file. Fortunately, there's a better way to do this. Simply adding username and token parameters to the download url will prevent the redirecting and let you download the file immediately. The token can be acquired from a json file called "player-data.json", located in the User Data directory (see [[Application_directory#User_data_directory]]). You can also get the token by using the [[Web_authentication_API | Web Authentication API]].

Example usage:
https://mods.factorio.com/{download_url}?username={username}&token={token}

[[Category:Technical]]

Web authentication API

2024-10-03T19:50:03Z

Asdff45: Update possible return codes and values

<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal|Internal API]]</div>

Factorio's Web Authentication API endpoint gives you a token in exchange for your username and password, which is used by several other Factorio web API endpoints. The authentication endpoint is located at:

<code>https://auth.factorio.com/api-login</code>

Authentication requires sending an HTTP POST request (Content-Type: <code>application/x-www-form-urlencoded</code>) with these parameters:

{| class="wikitable"
| username
| Required.
| Account username or e-mail.
|-
| password
| Required.
| Account password.
|-
| api_version
| Default: 1
| Currently 6.
|-
| require_game_ownership
| Not required.
| If set to 'true', will fail authentication if the user account hasn't actually purchased Factorio.
|-
| email_authentication_code
| Not required.
| If a previous login failed with <code>email-authentication-required</code>, email authentication can be completed by including the code sent to the user via mail.

|}

This endpoint always returns JSON encoded data.

{| class="wikitable"
|+ HTTP Status codes
|-
! API-Version
! Success
! Error
|-
! <= 3
| 200
| 401
|-
! >= 4
| 200
| 200
|}

{| class="wikitable"
|+ Success json
|-
! API-Version
! Name
! Value
|-
| <= 1
| []
| Array of hexadecimal encoded auth tokens
|-
| >= 2
| token
| Auth token is a hexadecimal encoded byte string
|-
| >= 2
| username
| The username of the logged in user.
|}

{| class="wikitable"
|+ Error json
|-
! API-Version
! Name
! Value
|-
| all
| data
| Always empty object "{}"
|-
| all
| error
| Error codes like <code>login-failed</code> or <code>email-authentication-required</code>
|-
| all
| message
| A more detailed error message that can be shown to the user
|-
| <= 3
| status
| Same value as the Status Code
|}

Clients causing a lot of errors like <code>login-failed</code> will be rate limited.

[[Category:Technical]]

Prototype/Entity

2021-11-25T13:34:58Z

Asdff45: grammar mistake

{{Prototype parent|PrototypeBase}}
Abstract base of all entities in the game.
Entity is basically everything that can be on the map (except tiles).
For in game script access to entity, take a look at [http://lua-api.factorio.com/latest/LuaEntity.html LuaEntity]

{{Prototype TOC|''abstract''}}

== Extensions ==
<div class="factorio-list">
* [[Prototype/Arrow]] '''arrow'''
* [[Prototype/ArtilleryFlare]] '''artillery-flare'''
* [[Prototype/ArtilleryProjectile]] '''artillery-projectile'''
* [[Prototype/Beam]] '''beam'''
* [[Prototype/CharacterCorpse]] '''character-corpse'''
* [[Prototype/Cliff]] '''cliff'''
* [[Prototype/Corpse]] '''corpse'''
** [[Prototype/RailRemnants]] '''rail-remnants'''
* [[Prototype/DeconstructibleTileProxy]] '''deconstructible-tile-proxy'''
* [[Prototype/EntityGhost]] '''entity-ghost'''
* [[Prototype/EntityParticle]] '''particle''' (for migration, cannot be used)
** [[Prototype/LeafParticle]] '''leaf-particle''' (for migration, cannot be used)
* [[Prototype/EntityWithHealth]] <abstract>
** [[Prototype/Accumulator]] '''accumulator'''
** [[Prototype/ArtilleryTurret]] '''artillery-turret'''
** [[Prototype/Beacon]] '''beacon'''
** [[Prototype/Boiler]] '''boiler'''
** [[Prototype/BurnerGenerator]] '''burner-generator'''
** [[Prototype/Character]] '''character'''
** [[Prototype/Combinator]] <abstract>
*** [[Prototype/ArithmeticCombinator]] '''arithmetic-combinator'''
*** [[Prototype/DeciderCombinator]] '''decider-combinator'''
** [[Prototype/ConstantCombinator]] '''constant-combinator'''
** [[Prototype/Container]] '''container'''
*** [[Prototype/LogisticContainer]] '''logistic-container'''
**** [[Prototype/InfinityContainer]] '''infinity-container'''
** [[Prototype/CraftingMachine]] <abstract>
*** [[Prototype/AssemblingMachine]] '''assembling-machine'''
**** [[Prototype/RocketSilo]] '''rocket-silo'''
*** [[Prototype/Furnace]] '''furnace'''
** [[Prototype/ElectricEnergyInterface]] '''electric-energy-interface'''
** [[Prototype/ElectricPole]] '''electric-pole'''
** [[Prototype/EnemySpawner]] '''unit-spawner'''
** [[Prototype/Fish]] '''fish'''
** [[Prototype/FlyingRobot]] <abstract>
*** [[Prototype/CombatRobot]] '''combat-robot'''
*** [[Prototype/RobotWithLogisticInterface]] <abstract>
**** [[Prototype/ConstructionRobot]] '''construction-robot'''
**** [[Prototype/LogisticRobot]] '''logistic-robot'''
** [[Prototype/Gate]] '''gate'''
** [[Prototype/Generator]] '''generator'''
** [[Prototype/HeatInterface]] '''heat-interface'''
** [[Prototype/HeatPipe]] '''heat-pipe'''
** [[Prototype/Inserter]] '''inserter'''
** [[Prototype/Lab]] '''lab'''
** [[Prototype/Lamp]] '''lamp'''
** [[Prototype/LandMine]] '''land-mine'''
** [[Prototype/LinkedContainer]] '''linked-container'''
** [[Prototype/Market]] '''market'''
** [[Prototype/MiningDrill]] '''mining-drill'''
** [[Prototype/OffshorePump]] '''offshore-pump'''
** [[Prototype/Pipe]] '''pipe'''
*** [[Prototype/InfinityPipe]] '''infinity-pipe'''
** [[Prototype/PipeToGround]] '''pipe-to-ground'''
** [[Prototype/PlayerPort]] '''player-port'''
** [[Prototype/PowerSwitch]] '''power-switch'''
** [[Prototype/ProgrammableSpeaker]] '''programmable-speaker'''
** [[Prototype/Pump]] '''pump'''
** [[Prototype/Radar]] '''radar'''
** [[Prototype/Rail]] <abstract>
*** [[Prototype/CurvedRail]] '''curved-rail'''
*** [[Prototype/StraightRail]] '''straight-rail'''
** [[Prototype/RailSignalBase]] <abstract>
*** [[Prototype/RailChainSignal]] '''rail-chain-signal'''
*** [[Prototype/RailSignal]] '''rail-signal'''
** [[Prototype/Reactor]] '''reactor'''
** [[Prototype/Roboport]] '''roboport'''
** [[Prototype/SimpleEntity]] '''simple-entity'''
** [[Prototype/SimpleEntityWithOwner]] '''simple-entity-with-owner'''
** [[Prototype/SimpleEntityWithForce]] '''simple-entity-with-force'''
** [[Prototype/SolarPanel]] '''solar-panel'''
** [[Prototype/SpiderLeg]] '''spider-leg'''
** [[Prototype/StorageTank]] '''storage-tank'''
** [[Prototype/TrainStop]] '''train-stop'''
** [[Prototype/TransportBeltConnectable]] <abstract>
*** [[Prototype/LinkedBelt]] '''linked-belt'''
*** [[Prototype/Loader1x1]] '''loader-1x1'''
*** [[Prototype/Loader1x2]] '''loader'''
*** [[Prototype/Splitter]] '''splitter'''
*** [[Prototype/TransportBelt]] '''transport-belt'''
*** [[Prototype/UndergroundBelt]] '''underground-belt'''
** [[Prototype/Tree]] '''tree'''
** [[Prototype/Turret]] '''turret'''
*** [[Prototype/AmmoTurret]] '''ammo-turret'''
*** [[Prototype/ElectricTurret]] '''electric-turret'''
*** [[Prototype/FluidTurret]] '''fluid-turret'''
** [[Prototype/Unit]] '''unit'''
** [[Prototype/Vehicle]] <abstract>
*** [[Prototype/Car]] '''car'''
*** [[Prototype/RollingStock]] <abstract>
**** [[Prototype/ArtilleryWagon]] '''artillery-wagon'''
**** [[Prototype/CargoWagon]] '''cargo-wagon'''
**** [[Prototype/FluidWagon]] '''fluid-wagon'''
**** [[Prototype/Locomotive]] '''locomotive'''
*** [[Prototype/SpiderVehicle]] '''spider-vehicle'''
** [[Prototype/Wall]] '''wall'''
* [[Prototype/Explosion]] '''explosion'''
** [[Prototype/FlameThrowerExplosion]] '''flame-thrower-explosion'''
* [[Prototype/FireFlame]] '''fire'''
* [[Prototype/FluidStream]] '''stream'''
* [[Prototype/FlyingText]] '''flying-text'''
* [[Prototype/HighlightBoxEntity]] '''highlight-box'''
* [[Prototype/ItemEntity]] '''item-entity'''
* [[Prototype/ItemRequestProxy]] '''item-request-proxy'''
* [[Prototype/ParticleSource]] '''particle-source'''
* [[Prototype/Projectile]] '''projectile'''
* [[Prototype/ResourceEntity]] '''resource'''
* [[Prototype/RocketSiloRocket]] '''rocket-silo-rocket'''
* [[Prototype/RocketSiloRocketShadow]] '''rocket-silo-rocket-shadow'''
* [[Prototype/Smoke]] <abstract>
** [[Prototype/SimpleSmoke]] '''smoke''' (for migration, cannot be used)
** [[Prototype/SmokeWithTrigger]] '''smoke-with-trigger'''
* [[Prototype/SpeechBubble]] '''speech-bubble'''
* [[Prototype/Sticker]] '''sticker'''
* [[Prototype/TileGhost]] '''tile-ghost'''
</div>

== Mandatory properties ==
Inherits all properties from [[PrototypeBase]].

{{Prototype property|icons, icon, icon_size (IconSpecification)|[[Types/IconSpecification|IconSpecification]]}}
An icon is mandatory for entities that have at least one of these flags active: placeable-neutral, placeable-player, placeable-enemy.

The icon will be used in the editor building selection and the bonus gui.
<syntaxhighlight lang="lua">icon = "__base__/graphics/icons/wooden-chest.png"</syntaxhighlight>

== Optional properties ==

=== order ===
:''See [[PrototypeBase#order]]''
Inherited from [[PrototypeBase]].

The order string is taken from the items in <code>placeable_by</code> if they exist, or from an item that has its [[Prototype/Item#place_result|place_result]] set to this entity if it exists.

{{Prototype property|collision_box|[[Types/BoundingBox|BoundingBox]]|Empty=<nowiki>{{0, 0}, {0, 0}} means no collisions.</nowiki>|optional=true}}
Specification of the entity collision boundaries.

Empty collision box is used for smoke, projectiles, particles, explosions etc.
<syntaxhighlight lang="lua">collision_box = {{-0.4, -0.4}, {0.4, 0.4}}</syntaxhighlight>
The {0,0} coordinate in the collision box will match the entity position.

It should be near the center of the collision box, to keep correct entity drawing order. It must include the {0,0} coordinate.

Note, that for buildings, it is customary to leave 0.1 wide border between the edge of the tile and the edge of the building, this lets the player move between the building and electric poles/inserters etc.

{{Prototype property|collision_mask|[[Types/CollisionMask|CollisionMask]]|<nowiki>{"item-layer", "object-layer", "player-layer", "water-tile"}</nowiki>|optional=true}}

Two entities can collide only if they share a layer from the collision mask.

<div class="toccolours mw-collapsible mw-collapsed">
NOTE: '''Some entity types have their own default''' that differs from the above default. They are listed here:
<div class="mw-collapsible-content">
* [[Prototype/Arrow]] - no masks
* [[Prototype/ArtilleryFlare]] - no masks
* [[Prototype/ArtilleryProjectile]] - no masks
* [[Prototype/Beam]] - no masks
* [[Prototype/Car]] - <code>{"player-layer", "train-layer", "consider-tile-transitions"}</code>
* [[Prototype/Character]] - <code>{"player-layer", "train-layer", "consider-tile-transitions"}</code>
* [[Prototype/CharacterCorpse]] - no masks
* [[Prototype/Cliff]] - <code>{ "item-layer", "object-layer", "player-layer", "water-tile", "not-colliding-with-itself"}</code>
* [[Prototype/Corpse]] - no masks
* [[Prototype/DeconstructibleTileProxy]] - <code>{"ground-tile"}</code>
* [[Prototype/EntityGhost]] - <code>{"ghost-layer"}</code>
* [[Prototype/EntityParticle]] - no masks
* [[Prototype/Explosion]] - no masks
* [[Prototype/FireFlame]] - no masks
* [[Prototype/Fish]] - <code>{"ground-tile", "colliding-with-tiles-only"}</code>
* [[Prototype/FluidStream]] - no masks
* [[Prototype/FlyingRobot]] - no masks
* [[Prototype/FlyingText]] - no masks
* [[Prototype/Gate]] - <code>{"item-layer", "object-layer", "player-layer", "water-tile", "train-layer"}</code>
* [[Prototype/HeatPipe]] - <code>{"object-layer", "floor-layer", "water-tile"}</code>
* [[Prototype/HighlightBoxEntity]] - no masks
* [[Prototype/ItemEntity]] - <code>{"item-layer"}</code>
* [[Prototype/ItemRequestProxy]] - no masks
* [[Prototype/LandMine]] - <code>{"object-layer", "water-tile"}</code>
* [[Prototype/LinkedBelt]] - <code>{"object-layer", "item-layer", "transport-belt-layer", "water-tile"}</code>
* [[Prototype/Loader1x1]] - <code>{"object-layer", "item-layer", "transport-belt-layer", "water-tile"}</code>
* [[Prototype/Loader1x2]] - <code>{"object-layer", "item-layer", "transport-belt-layer", "water-tile"}</code>
* [[Prototype/ParticleSource]] - no masks
* [[Prototype/PlayerPort]] - <code>{"object-layer", "floor-layer", "water-tile"}</code>
* [[Prototype/Projectile]] - no masks
* [[Prototype/Rail]] - <code>{"item-layer", "object-layer", "rail-layer", "floor-layer", "water-tile"}</code>
* [[Prototype/RailSignalBase]] - <code>{"floor-layer", "rail-layer", "item-layer"}</code>
* [[Prototype/ResourceEntity]] - <code>{"resource-layer"}</code>
* [[Prototype/RollingStock]] - <code>{"train-layer"}</code>
* [[Prototype/Smoke]] - no masks
* [[Prototype/SpeechBubble]] - no masks
* [[Prototype/SpiderLeg]] - <code>{"player-layer", "rail-layer"}</code>
* [[Prototype/Splitter]] - <code>{"object-layer", "item-layer", "transport-belt-layer", "water-tile"}</code>
* [[Prototype/Sticker]] - no masks
* [[Prototype/TileGhost]] - <code>{"ghost-layer"}</code>
* [[Prototype/TransportBelt]] - <code>{"object-layer", "floor-layer", "transport-belt-layer", "water-tile"}</code>
* [[Prototype/UndergroundBelt]] - <code>{"object-layer", "item-layer", "transport-belt-layer", "water-tile"}</code>
* [[Prototype/Unit]] - <code>{"player-layer", "train-layer", "not-colliding-with-itself"}</code>
* [[Prototype/Vehicle]] - <code>{"player-layer", "train-layer"}</code>
</div></div>

{{Prototype property|map_generator_bounding_box|[[Types/BoundingBox|BoundingBox]]|The value of collision box.|optional=true}}
Used instead of the collision box during map generation. Allows space entities differently during map generation, for example if the box is bigger, the entities will be placed farther apart.

{{Prototype property|selection_box|[[Types/BoundingBox|BoundingBox]]|<nowiki>Empty = {{0, 0}, {0, 0}}</nowiki>|optional=true}}
Specification of the entity selection area.
When empty the entity will have no selection area (and thus is not selectable).
<syntaxhighlight lang="lua">selection_box = {{-0.5, -0.5}, {0.5, 0.5}}</syntaxhighlight>
The selection box is usually a little bit bigger than the collision box, for tilable entities (like buildings) it should match the tile size of the building.

{{Prototype property|drawing_box|[[Types/BoundingBox|BoundingBox]]|<nowiki>Empty = {{0, 0}, {0, 0}} (selection_box is used instead)</nowiki>|optional=true}}
Specification of space needed to see the whole entity.

This is used to calculate the correct zoom and positioning in the entity info gui.
<syntaxhighlight lang="lua">drawing_box = {{-0.5, -0.5}, {0.5, 0.5}}</syntaxhighlight>

{{Prototype property|sticker_box|[[Types/BoundingBox|BoundingBox]]|The value of collision box.|optional=true}}
Used to set the area of the entity that can have stickers on it, currently only used for units to specify the area where the green slow down stickers can appear.
It is optional and the collision box is used when not specified.
<syntaxhighlight lang="lua">sticker_box = {{-0.5, -0.5}, {0.5, 0.5}}</syntaxhighlight>

{{Prototype property|hit_visualization_box|[[Types/BoundingBox|BoundingBox]]|<nowiki>Empty = {{0, 0}, {0, 0}}</nowiki>|optional=true}}
Where beams should hit the entity. Useful if the bounding box only covers part of the entity (e.g. feet of the character) and beams only hitting there would look weird.

{{Prototype property|trigger_target_mask|[[Types/TriggerTargetMask|TriggerTargetMask]]|optional=true}}

{{Prototype property|flags|[[Types/EntityPrototypeFlags|EntityPrototypeFlags]]|optional=true}}

{{Prototype property|minable|[[Types/MinableProperties|MinableProperties]]|not minable|optional=true}}

{{Prototype property|subgroup|[[Types/string|string]]|optional=true}}
The name of the subgroup this entity should be sorted into in the map editor building selection.

{{Prototype property|allow_copy_paste|[[Types/bool|bool]]|true|optional=true}}

{{Prototype property|selectable_in_game|[[Types/bool|bool]]|true|optional=true}}

{{Prototype property|selection_priority|[[Types/uint8|uint8]]|50|optional=true}}
The entity with the higher number is selectable before the entity with the lower number. When two entities have the same selection priority, the one with the highest [[Types/CollisionMask|collision mask]] (as determined by the order on that page) is selected.

{{Prototype property|remove_decoratives|[[Types/string|string]]|"automatic"|optional=true}}
Either "automatic", "true" or "false". Whether this entity should remove decoratives that collide with it when this entity is built. When set to "automatic", if the entity type is considered a building (e.g. an assembling machine or a wall) it will remove decoratives.

{{Prototype property|emissions_per_second|[[Types/double|double]]|0|optional=true}}
Amount of emissions created (positive number) or cleaned (negative number) every second by the entity.
This is passive, and it is independent concept of the emissions of machines, these are created actively depending on the power consumption.
Currently used just for trees.

<syntaxhighlight lang="lua">emissions_per_second = -0.001 -- cleaning effect of big tree</syntaxhighlight>

{{Prototype property|shooting_cursor_size|[[Types/double|double]]|optional=true}}
The cursor size used when shooting at this entity.

{{Prototype property|created_smoke|[[Types/CreateTrivialSmokeEffectItem|CreateTrivialSmokeEffectItem]]|The "smoke-building"-smoke|optional=true}}
The smoke that is shown when the entity is placed.

{{Prototype property|working_sound|[[Types/WorkingSound|WorkingSound]]|optional=true}}
Will also work on entities that don't actually do work.

{{Prototype property|created_effect|[[Types/Trigger|Trigger]]|optional=true}}
The effect/trigger that happens when the entity is placed.

{{Prototype property|build_sound|[[Types/Sound|Sound]]|optional=true}}

{{Prototype property|mined_sound|[[Types/Sound|Sound]]|optional=true}}

{{Prototype property|mining_sound|[[Types/Sound|Sound]]|optional=true}}

{{Prototype property|rotated_sound|[[Types/Sound|Sound]]|optional=true}}

{{Prototype property|vehicle_impact_sound|[[Types/Sound|Sound]]|optional=true}}
When playing this sound, the volume is scaled by the speed of the vehicle when colliding with this entity.

{{Prototype property|open_sound|[[Types/Sound|Sound]]|optional=true}}

{{Prototype property|close_sound|[[Types/Sound|Sound]]|optional=true}}

{{Prototype property|radius_visualisation_specification|[[Types/RadiusVisualisationSpecification|RadiusVisualisationSpecification]]|optional=true}}

{{Prototype property|build_base_evolution_requirement|[[Types/double|double]]|0|optional=true}}

{{Prototype property|alert_icon_shift|[[Types/vector|vector]]|optional=true}}

{{Prototype property|alert_icon_scale|[[Types/float|float]]|optional=true}}

{{Prototype property|fast_replaceable_group|[[Types/string|string]]|""|optional=true}}
This allows you to replace an entity that's already placed, with a different one in your inventory. For example, replacing a burner inserter with a fast inserter.

This is simply a string, so any string can be used here. The entity that should be replaced simply has to use the same string here.

The ones the game uses are:

"container"
"furnace"
"transport-belt"
"electric-pole"
"steam-engine"
"inserter"
"long-handed-inserter"
"pipe"
"assembling-machine"
"wall"
"loader"
"rail-signal"
"mining-drill"
"pumpjack"

{{Prototype property|next_upgrade|[[Types/string|string]]|optional=true}}
Name of the entity that will be automatically selected as the upgrade of this entity when using the [[upgrade planner]] without configuration.

This entity may not have 'not-upgradable' flag set and must be minable. This entity mining result must not contain item product with "hidden" flag set. Mining results with no item products are allowed. The entity may not be a [[Prototype/RollingStock]].<br>
The upgrade target entity needs to have the same bounding box, collision mask, and fast replaceable group as this entity. The upgrade target entity must have least 1 item that builds it that isn't hidden.

{{Prototype property|placeable_by|[[Types/ItemToPlace|ItemToPlace]] or [[Types/table|table]] of [[Types/ItemToPlace|ItemToPlace]]|optional=true}}
Item that when placed creates this entity. Determines which item is picked when "Q" (smart pipette) is used on the entity, determines which item is needed in a blueprint of this entity.

The item count specified here can't be larger than the stack size of that item.

{{Prototype property|remains_when_mined|[[Types/string|string]] or [[Types/table|table]] of [[Types/string|string]]|optional=true}}
The entity that remains when this one is mined, deconstructed or fast-replaced. The entity wont actually be spawned if it would collide with the entity that is in the process of being mined.

{{Prototype property|additional_pastable_entities|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
Names of the entity prototypes this entity prototype can be pasted on to in addition to the standard supported types.
This is used to allow copying between types that aren't compatible on the C++ code side, by allowing mods to receive the [https://lua-api.factorio.com/latest/events.html#on_entity_settings_pasted on_entity_settings_pasted] event for the given entity and do the setting pasting via script.<br>
additional_pastable_entities = {"steel-chest", "iron-chest"}

{{Prototype property|tile_width|[[Types/uint32|uint32]]|calculated by the collision box width rounded up.|optional=true}}
Used to determine how the center of the entity should be positioned when building (unless the offgrid [[Types/EntityPrototypeFlags|flag]] is specified).
When the tile width is odd, the center will be in the center of the tile, when it is even, the center is on the tile transition.

{{Prototype property|tile_height|[[Types/uint32|uint32]]|calculated by the collision box height rounded up.|optional=true}}

{{Prototype property|autoplace|[[Types/AutoplaceSpecification|AutoplaceSpecification]]|nil (entity is not autoplacable)|optional=true}}
Used to specify the rules for placing this entity during map generation.

{{Prototype property|map_color|[[Types/Color|Color]]|optional=true}}

{{Prototype property|friendly_map_color|[[Types/Color|Color]]|optional=true}}

{{Prototype property|enemy_map_color|[[Types/Color|Color]]|optional=true}}

{{Prototype property|water_reflection|[[Types/WaterReflectionDefinition|WaterReflectionDefinition]]|optional=true}}
May also be defined inside <code>graphics_set</code> instead of directly in the entity prototype. This is useful for entities that use the a <code>graphics_set</code> property to define their graphics, because then all graphics can be defined in one place.<br>
Currently only renders for [[Prototype/EntityWithHealth]].[https://forums.factorio.com/100703]

== Example ==
<syntaxhighlight lang="lua">{
type = "container",
name = "wooden-chest",
icon = "__base__/graphics/icons/wooden-chest.png",
flags = {"placeable-neutral", "player-creation"},
minable = {mining_time = 1, result = "wooden-chest"},
max_health = 100,
corpse = "small-remnants",
collision_box = {{-0.35, -0.35}, {0.35, 0.35}},
fast_replaceable_group = "container",
selection_box = {{-0.5, -0.5}, {0.5, 0.5}},
inventory_size = 16,
open_sound = { filename = "__base__/sound/wooden-chest-open.ogg" },
close_sound = { filename = "__base__/sound/wooden-chest-close.ogg" },
vehicle_impact_sound = { filename = "__base__/sound/car-wood-impact.ogg", volume = 1.0 },
picture =
{
filename = "__base__/graphics/entity/wooden-chest/wooden-chest.png",
priority = "extra-high",
width = 46,
height = 33,
shift = {0.25, 0.015625}
},
circuit_wire_connection_point =
{
shadow =
{
red = {0.734375, 0.453125},
green = {0.609375, 0.515625},
},
wire =
{
red = {0.40625, 0.21875},
green = {0.40625, 0.375},
}
},
circuit_connector_sprites = get_circuit_connector_sprites({0.1875, 0.15625}, nil, 18),
circuit_wire_max_distance = 9
}</syntaxhighlight>

Types/FluidBox

2021-11-10T15:15:41Z

Asdff45: Fixed link

== Basics ==
[[File:Fluidboxes.png|thumb|550px|Visual representation of base_area, base_level and height. When all the fluidboxes are connected, the water leaves fluidbox A and flows into the other 3 boxes through fluidbox B until the water level is equal in all boxes. For more info about fluids, see [[Fluid system#See also]].]]
Used to set the fluid amount an entity can hold, as well as the connection points for pipes leading into and out of the entity.

Each entity can have multiple fluidboxes.
It can come from a [[Types/EnergySource#Fluid_energy_source]], any fluidbox or normal property storage tanks and pumps.

Each fluidbox should store only ONE type of fluid.
It accepts to store multiple different fluids, which is fluid mixing and not wanted.
To avoid fluid mixing, you can setup a filter for certain fluids.
Crafting machines will automatically disable unused fluidboxes.

== Mandatory properties ==

=== pipe_connections ===
'''Type''': [[Types/table]] of [[Types/PipeConnectionDefinition]]

Max number of members is 255.

Connection points to connect to other fluidboxes. This is also marked as blue arrows in alt mode.
Fluid may flow in or out depending on the `type` field of each connection.
Connection points may depend on the direction the entity is facing.

== Optional properties ==

=== base_area ===
'''Type''': [[Types/double]]

'''Default''': 1

Must be greater than 0.

=== base_level ===
'''Type''': [[Types/double]]

'''Default''': 0

=== height ===
'''Type''': [[Types/double]]

'''Default''': 1

Must be greater than 0.

=== filter ===
'''Type''': [[Types/string]]

Name of a [[Prototype/Fluid]]. Can be used to specify which fluid is allowed to enter this fluid box. [https://forums.factorio.com/viewtopic.php?f=28&t=46302]

=== render_layer ===
'''Type''': [[Types/RenderLayer]]

'''Default''': "object"

=== pipe_covers ===
'''Type''': [[Types/Sprite4Way]]

The pictures to show when another fluid box connects to this one.

=== pipe_picture ===
'''Type''': [[Types/Sprite4Way]]

=== minimum_temperature ===
'''Type''': [[Types/double]]

The minimum temperature allowed into the fluidbox. Only applied if a <code>filter</code> is specified [https://forums.factorio.com/viewtopic.php?p=496738#p496738].

<syntaxhighlight lang="lua">minimum_temperature = 100.0</syntaxhighlight>

=== maximum_temperature ===
'''Type''': [[Types/double]]

The maximum temperature allowed into the fluidbox. Only applied if a <code>filter</code> is specified [https://forums.factorio.com/viewtopic.php?p=496738#p496738].

<syntaxhighlight lang="lua">maximum_temperature = 1000.0</syntaxhighlight>

=== production_type ===
'''Type''': [[Types/string]]

'''Default''': "None"

Possible values:
* "None"
* "input"
* "input-output"
* "output"

=== secondary_draw_order ===
'''Type''': [[Types/int8]]

'''Default''': 1

Set the secondary draw order for all orientations. Used to determine render order for sprites with the same <code>render_layer</code> in the same position. Sprites with a higher <code>secondary_draw_order</code> are drawn on top.

=== secondary_draw_orders ===
'''Type''': [[Types/table]] of [[Types/int8]]

'''Default''': {north = 1, east = 1, south = 1, west = 1}

Set the secondary draw order for each orientation. Used to determine render order for sprites with the same <code>render_layer</code> in the same position. Sprites with a higher <code>secondary_draw_order</code> are drawn on top.

== Example ==

<syntaxhighlight lang="lua">fluid_box =
{
base_area = 1,
height = 2,
base_level = -1,
pipe_covers = pipecoverspictures(),
pipe_connections =
{
{type = "input-output", position = {-2, 0.5}},
{type = "input-output", position = {2, 0.5}}
},
production_type = "input-output"
},
</syntaxhighlight>

Types/FluidBox

2021-11-10T15:13:08Z

Asdff45: Changed previous description to be more english-like

== Basics ==
[[File:Fluidboxes.png|thumb|550px|Visual representation of base_area, base_level and height. When all the fluidboxes are connected, the water leaves fluidbox A and flows into the other 3 boxes through fluidbox B until the water level is equal in all boxes. For more info about fluids, see [[Fluid system#See also]].]]
Used to set the fluid amount an entity can hold, as well as the connection points for pipes leading into and out of the entity.

Each entity can have multiple fluidboxes.
It can come from a [[fluid energy source]], any fluidbox and normal property storage tanks and pumps.

Each fluidbox should store only ONE type of fluid.
It accepts to store multiple different fluids, which is fluid mixing and not wanted.
To avoid fluid mixing, you can setup a filter for certain fluids.
Crafting machines will automatically disable unused fluidboxes.

== Mandatory properties ==

=== pipe_connections ===
'''Type''': [[Types/table]] of [[Types/PipeConnectionDefinition]]

Max number of members is 255.

Connection points to connect to other fluidboxes. This is also marked as blue arrows in alt mode.
Fluid may flow in or out depending on the `type` field of each connection.
Connection points may depend on the direction the entity is facing.

== Optional properties ==

=== base_area ===
'''Type''': [[Types/double]]

'''Default''': 1

Must be greater than 0.

=== base_level ===
'''Type''': [[Types/double]]

'''Default''': 0

=== height ===
'''Type''': [[Types/double]]

'''Default''': 1

Must be greater than 0.

=== filter ===
'''Type''': [[Types/string]]

Name of a [[Prototype/Fluid]]. Can be used to specify which fluid is allowed to enter this fluid box. [https://forums.factorio.com/viewtopic.php?f=28&t=46302]

=== render_layer ===
'''Type''': [[Types/RenderLayer]]

'''Default''': "object"

=== pipe_covers ===
'''Type''': [[Types/Sprite4Way]]

The pictures to show when another fluid box connects to this one.

=== pipe_picture ===
'''Type''': [[Types/Sprite4Way]]

=== minimum_temperature ===
'''Type''': [[Types/double]]

The minimum temperature allowed into the fluidbox. Only applied if a <code>filter</code> is specified [https://forums.factorio.com/viewtopic.php?p=496738#p496738].

<syntaxhighlight lang="lua">minimum_temperature = 100.0</syntaxhighlight>

=== maximum_temperature ===
'''Type''': [[Types/double]]

The maximum temperature allowed into the fluidbox. Only applied if a <code>filter</code> is specified [https://forums.factorio.com/viewtopic.php?p=496738#p496738].

<syntaxhighlight lang="lua">maximum_temperature = 1000.0</syntaxhighlight>

=== production_type ===
'''Type''': [[Types/string]]

'''Default''': "None"

Possible values:
* "None"
* "input"
* "input-output"
* "output"

=== secondary_draw_order ===
'''Type''': [[Types/int8]]

'''Default''': 1

Set the secondary draw order for all orientations. Used to determine render order for sprites with the same <code>render_layer</code> in the same position. Sprites with a higher <code>secondary_draw_order</code> are drawn on top.

=== secondary_draw_orders ===
'''Type''': [[Types/table]] of [[Types/int8]]

'''Default''': {north = 1, east = 1, south = 1, west = 1}

Set the secondary draw order for each orientation. Used to determine render order for sprites with the same <code>render_layer</code> in the same position. Sprites with a higher <code>secondary_draw_order</code> are drawn on top.

== Example ==

<syntaxhighlight lang="lua">fluid_box =
{
base_area = 1,
height = 2,
base_level = -1,
pipe_covers = pipecoverspictures(),
pipe_connections =
{
{type = "input-output", position = {-2, 0.5}},
{type = "input-output", position = {2, 0.5}}
},
production_type = "input-output"
},
</syntaxhighlight>

Prototype/RoboportEquipment

2021-10-11T10:02:22Z

Asdff45: made sentence more english

{{Prototype parent|Prototype/Equipment}}
Used by [[personal roboport]].

{{Prototype TOC|roboport-equipment}}

== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/Equipment]].

{{Prototype property|recharging_animation|[[Types/Animation|Animation]]}}
The animation played at each charging point when a robot is charging there.

{{Prototype property|spawn_and_station_height|[[Types/float|float]]}}
Presumably states the height of the charging stations and thus an additive offset for the charging_offsets.

{{Prototype property|charge_approach_distance|[[Types/float|float]]}}
Presumably, the distance from the roboport at which robots will wait to charge.

{{Prototype property|construction_radius|[[Types/float|float]]}}
Can't be negative.

{{Prototype property|charging_energy|[[Types/Energy|Energy]]}}
== Optional properties ==

{{Prototype property|spawn_and_station_shadow_height_offset|[[Types/float|float]]|0|optional=true}}

{{Prototype property|draw_logistic_radius_visualization|[[Types/bool|bool]]|true|optional=true}}

{{Prototype property|draw_construction_radius_visualization|[[Types/bool|bool]]|true|optional=true}}

{{Prototype property|recharging_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}
The light emitted when charging a robot.

{{Prototype property|charging_station_count|[[Types/uint32|uint32]]|0|optional=true}}

{{Prototype property|charging_distance|[[Types/float|float]]|0.0|optional=true}}

{{Prototype property|charging_station_shift|[[Types/vector|vector]]|optional=true}}

{{Prototype property|charging_threshold_distance|[[Types/float|float]]|1.0|optional=true}}
This defines how far away a robot can be to be charged, however a bot is still required to reach a charging spot and cannot have full battery.

{{Prototype property|robot_vertical_acceleration|[[Types/float|float]]|0.01|optional=true}}

{{Prototype property|stationing_offset|[[Types/vector|vector]]||optional=true}}
The offset from the center of the roboport at which robots will enter and exit.

{{Prototype property|robot_limit|[[Types/ItemCountType|ItemCountType]]|max uint|optional=true}}
How many robots can exist in the network (cumulative).

{{Prototype property|robots_shrink_when_entering_and_exiting|[[Types/bool|bool]]|false|optional=true}}

{{Prototype property|charging_offsets|[[Types/table|table]] of [[Types/vector|vector]]|optional=true}}
The offsets from the centre of the roboport at which robots will charge.

{{Prototype property|spawn_minimum|[[Types/Energy|Energy]]|0.2 * energy_source.buffer_capacity|optional=true}}
Minimum amount of energy that needs to available inside the roboport's buffer so that robots can be spawned.

{{Prototype property|burner|[[Types/EnergySource|EnergySource]]|optional=true}}
Must be a burner energy source. Add this is if the roboport should be fueled directly instead of using power from the equipment grid.

{{Prototype property|power|[[Types/Energy|Energy]]|optional=true}}
Mandatory if <code>burner</code> is present. The size of the buffer of the burner energy source, so effectively the amount of power that the energy source can produce per tick.

Prototype/RoboportEquipment

2021-10-11T09:57:57Z

Asdff45: Capitalization on sentence begin and spaces after ','

{{Prototype parent|Prototype/Equipment}}
Used by [[personal roboport]].

{{Prototype TOC|roboport-equipment}}

== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/Equipment]].

{{Prototype property|recharging_animation|[[Types/Animation|Animation]]}}
The animation played at each charging point when a robot is charging there.

{{Prototype property|spawn_and_station_height|[[Types/float|float]]}}
Presumably states the height of the charging stations and thus an additive offset for the charging_offsets.

{{Prototype property|charge_approach_distance|[[Types/float|float]]}}
Presumably, the distance from the roboport at which robots will wait to charge.

{{Prototype property|construction_radius|[[Types/float|float]]}}
Can't be negative.

{{Prototype property|charging_energy|[[Types/Energy|Energy]]}}
== Optional properties ==

{{Prototype property|spawn_and_station_shadow_height_offset|[[Types/float|float]]|0|optional=true}}

{{Prototype property|draw_logistic_radius_visualization|[[Types/bool|bool]]|true|optional=true}}

{{Prototype property|draw_construction_radius_visualization|[[Types/bool|bool]]|true|optional=true}}

{{Prototype property|recharging_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}
The light emitted when charging a robot.

{{Prototype property|charging_station_count|[[Types/uint32|uint32]]|0|optional=true}}

{{Prototype property|charging_distance|[[Types/float|float]]|0.0|optional=true}}

{{Prototype property|charging_station_shift|[[Types/vector|vector]]|optional=true}}

{{Prototype property|charging_threshold_distance|[[Types/float|float]]|1.0|optional=true}}
This defines how long can robot charging from this robopot, however bots are still required to reach charging spot and bot cannot be full battery.

{{Prototype property|robot_vertical_acceleration|[[Types/float|float]]|0.01|optional=true}}

{{Prototype property|stationing_offset|[[Types/vector|vector]]||optional=true}}
The offset from the centre of the roboport at which robots will enter and exit.

{{Prototype property|robot_limit|[[Types/ItemCountType|ItemCountType]]|max uint|optional=true}}
How many robots can exist in the network (cumulative).

{{Prototype property|robots_shrink_when_entering_and_exiting|[[Types/bool|bool]]|false|optional=true}}

{{Prototype property|charging_offsets|[[Types/table|table]] of [[Types/vector|vector]]|optional=true}}
The offsets from the centre of the roboport at which robots will charge.

{{Prototype property|spawn_minimum|[[Types/Energy|Energy]]|0.2 * energy_source.buffer_capacity|optional=true}}
Minimum amount of energy that needs to available inside the roboport's buffer so that robots can be spawned.

{{Prototype property|burner|[[Types/EnergySource|EnergySource]]|optional=true}}
Must be a burner energy source. Add this is if the roboport should be fueled directly instead of using power from the equipment grid.

{{Prototype property|power|[[Types/Energy|Energy]]|optional=true}}
Mandatory if <code>burner</code> is present. The size of the buffer of the burner energy source, so effectively the amount of power that the energy source can produce per tick.

Prototype/Roboport

2021-10-11T09:50:24Z

Asdff45: Capitalization and spaces after '.' and ','

{{Prototype parent|Prototype/EntityWithHealth}}
A [[roboport]].

{{Prototype TOC|roboport}}

== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].

{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
The roboport's energy source. Must be an electric or void energy source.

{{Prototype property|energy_usage|[[Types/Energy|Energy]]}}
The amount of energy the roboport uses when idle.

{{Prototype property|recharge_minimum|[[Types/Energy|Energy]]}}

{{Prototype property|robot_slots_count|[[Types/ItemStackIndex|ItemStackIndex]]}}
The number of robot slots in the roboport.

{{Prototype property|material_slots_count|[[Types/ItemStackIndex|ItemStackIndex]]}}
The number of repair pack slots in the roboport.

{{Prototype property|base|[[Types/Sprite|Sprite]]}}

{{Prototype property|base_patch|[[Types/Sprite|Sprite]]}}

{{Prototype property|base_animation|[[Types/Animation|Animation]]}}
The animation played when the roboport is idle.

{{Prototype property|door_animation_up|[[Types/Animation|Animation]]}}

{{Prototype property|door_animation_down|[[Types/Animation|Animation]]}}

{{Prototype property|request_to_open_door_timeout|[[Types/uint32|uint32]]}}

{{Prototype property|recharging_animation|[[Types/Animation|Animation]]}}
The animation played at each charging point when a robot is charging there.

{{Prototype property|spawn_and_station_height|[[Types/float|float]]}}
Presumably states the height of the charging stations and thus an additive offset for the charging_offsets.

{{Prototype property|charge_approach_distance|[[Types/float|float]]}}
The distance from the roboport at which robots will wait to charge.
Notablely, if robots are already in range, then it will simplely wait at spot.

{{Prototype property|logistics_radius|[[Types/float|float]]}}
Can't be negative.

{{Prototype property|construction_radius|[[Types/float|float]]}}
Can't be negative.

{{Prototype property|charging_energy|[[Types/Energy|Energy]]}}
The amount of energy that is given to a robot per tick.

== Optional properties ==

{{Prototype property|open_door_trigger_effect|[[Types/TriggerEffect|TriggerEffect]]|optional=true}}

{{Prototype property|close_door_trigger_effect|[[Types/TriggerEffect|TriggerEffect]]|optional=true}}

{{Prototype property|default_available_logistic_output_signal|[[Types/SignalIDConnector|SignalIDConnector]]|optional=true}}

{{Prototype property|default_total_logistic_output_signal|[[Types/SignalIDConnector|SignalIDConnector]]|optional=true}}

{{Prototype property|default_available_construction_output_signal|[[Types/SignalIDConnector|SignalIDConnector]]|optional=true}}

{{Prototype property|default_total_construction_output_signal|[[Types/SignalIDConnector|SignalIDConnector]]|optional=true}}

{{Prototype property|circuit_wire_connection_point|[[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}}

{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}}
The maximum circuit wire distance for this entity.

{{Prototype property|draw_copper_wires|[[Types/bool|bool]]|true|optional=true}}

{{Prototype property|draw_circuit_wires|[[Types/bool|bool]]|true|optional=true}}

{{Prototype property|circuit_connector_sprites|[[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}}

{{Prototype property|spawn_and_station_shadow_height_offset|[[Types/float|float]]|0|optional=true}}

{{Prototype property|draw_logistic_radius_visualization|[[Types/bool|bool]]|true|optional=true}}

{{Prototype property|draw_construction_radius_visualization|[[Types/bool|bool]]|true|optional=true}}

{{Prototype property|recharging_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}
The light emitted when charging a robot.

{{Prototype property|charging_station_count|[[Types/uint32|uint32]]|0|optional=true}}
How many charging point this roboport has, if value is 0, roboport will try to use charging_offsets to know charging point instead.
(in vanilla game, roboport charging point is defined by charging_offsets)

{{Prototype property|charging_distance|[[Types/float|float]]|0.0|optional=true}}

{{Prototype property|charging_station_shift|[[Types/vector|vector]]|optional=true}}

{{Prototype property|charging_threshold_distance|[[Types/float|float]]|1.0|optional=true}}
Unused. (only used in [[Prototype/RoboportEquipment|personal roboport]])

{{Prototype property|robot_vertical_acceleration|[[Types/float|float]]|0.01|optional=true}}

{{Prototype property|stationing_offset|[[Types/vector|vector]]|optional=true}}
The offset from the centre of the roboport at which robots will enter and exit.

{{Prototype property|robot_limit|[[Types/ItemCountType|ItemCountType]]|max uint|optional=true}}
Unused. (only used in [[Prototype/RoboportEquipment|personal roboport]])

{{Prototype property|robots_shrink_when_entering_and_exiting|[[Types/bool|bool]]|false|optional=true}}

{{Prototype property|charging_offsets|[[Types/table|table]] of [[Types/vector|vector]]|optional=true}}
The offsets from the centre of the roboport at which robots will charge. Only used if charging_station_count is equal to zero.

{{Prototype property|logistics_connection_distance|[[Types/float|float]]|optional=true}}
Must be >= <code>logistics_radius</code>.

Prototype/MiningDrill

2021-09-23T01:18:06Z

Asdff45: New line for example

{{Prototype parent|Prototype/EntityWithHealth}}
A mining drill.

{{Prototype TOC|mining-drill}}

== Mandatory properties ==

This prototype inherits the properties of [[Prototype/EntityWithHealth]].

{{Prototype property|vector_to_place_result|[[Types/vector|vector]]}}
The position where any item results are placed, when the mining drill is facing north (default direction).

{{Prototype property|resource_searching_radius|[[Types/double|double]]}}
The distance from the centre of the mining drill to search for resources in.

This is 2.49 for electric mining drills (a 5x5 area) and 0.99 for burner mining drills (a 2x2 area). The drill searches resource outside its natural boundary box, which is 0.01 (the middle of the entity); making it 2.5 and 1.0 gives it another block radius.

{{Prototype property|energy_usage|[[Types/Energy|Energy]]}}
The amount of energy used by the drill while mining. Can't be less than or equal to 0.

{{Prototype property|mining_speed|[[Types/double|double]]}}
The speed of this drill.

{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
The energy source of this mining drill.

{{Prototype property|resource_categories|[[Types/table|array]] of [[Types/string|string]]}}
The names of the [[Prototype/ResourceCategory]] that can be mined by this drill. For a list on built-in categories, see [[Data.raw#resource-category]].</br>
Note: Categories containing resources which produce items, fluids, or items+fluids may be combined on the same entity, but may not work as expected.</br>
Examples: Miner does not rotate fluid-resulting resources until depletion. Fluid isn't output (fluid resource change and fluidbox matches previous fluid). Miner with no vector_to_place_result can't output an item result and halts.

== Optional properties ==

{{Prototype property|output_fluid_box|[[Types/FluidBox|FluidBox]]|optional=true}}

{{Prototype property|input_fluid_box|[[Types/FluidBox|FluidBox]]|optional=true}}

{{Prototype property|animations|[[Types/Animation4Way|Animation4Way]]|optional=true}}
Loaded only if <code>graphics_set</code> does not exist.

{{Prototype property|graphics_set|[[Types/MiningDrillGraphicsSet|MiningDrillGraphicsSet]]|optional=true}}

{{Prototype property|wet_mining_graphics_set|[[Types/MiningDrillGraphicsSet|MiningDrillGraphicsSet]]|optional=true}}

{{Prototype property|base_picture|[[Types/Sprite4Way|Sprite4Way]]|optional=true}}
Used by the [[pumpjack]] to have a static 4 way sprite.

{{Prototype property|allowed_effects|[[Types/EffectTypeLimitation|EffectTypeLimitation]]|All effects are allowed|optional=true}}

{{Prototype property|radius_visualisation_picture|[[Types/Sprite|Sprite]]|optional=true}}
The sprite used to show the range of the mining drill.

{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}}
The maximum circuit wire distance for this entity.

{{Prototype property|draw_copper_wires|[[Types/bool|bool]]|true|optional=true}}

{{Prototype property|draw_circuit_wires|[[Types/bool|bool]]|true|optional=true}}

{{Prototype property|base_render_layer|[[Types/RenderLayer|RenderLayer]]|"lower-object"|optional=true}}

{{Prototype property|base_productivity|[[Types/float|float]]|0|optional=true}}
Productivity bonus that this machine always has.

{{Prototype property|monitor_visualization_tint|[[Types/Color|Color]]|optional=true}}
When this mining drill is connected to the circuit network, the resource that it is reading (either the entire resource patch, or the resource in the mining area of the drill, depending on circuit network setting), is tinted in this color when mousing over the mining drill.

{{Prototype property|circuit_wire_connection_points|[[Types/table|table]] of [[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}}
Mandatory if circuit_wire_max_distance > 0.

{{Prototype property|circuit_connector_sprites|[[Types/table|table]] of [[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}}
Mandatory if circuit_wire_max_distance > 0.

{{Prototype property|module_specification|[[Types/ModuleSpecification|ModuleSpecification]]|optional=true}}

Types/WorkingVisualisation

2021-09-22T14:53:02Z

Asdff45: New line for each definition for readability

Used by crafting machines to display different graphics when the machine is running.

== Optional properties ==

=== render_layer ===
'''Type''': [[Types/RenderLayer]]

'''Default''': "object"

=== fadeout ===
'''Type''': [[Types/bool]]

'''Default''': false

=== synced_fadeout ===
'''Type''': [[Types/bool]]

'''Default''': false

=== constant_speed ===
'''Type''': [[Types/bool]]

'''Default''': false

Whether the animations are always played at the same speed, not adjusted to the machine speed.

=== always_draw ===
'''Type''': [[Types/bool]]

'''Default''': false

=== animated_shift ===
'''Type''': [[Types/bool]]

'''Default''': false

=== align_to_waypoint ===
'''Type''': [[Types/bool]]

'''Default''': false

=== secondary_draw_order ===
'''Type''': [[Types/int8]]

Used to determine render order for sprites with the same <code>render_layer</code> in the same position. Sprites with a higher <code>secondary_draw_order</code> are drawn on top.

=== draw_as_sprite ===
'''Type''': [[Types/bool]]

'''Default''': true

=== draw_as_light ===
'''Type''': [[Types/bool]]

'''Default''': false

=== light ===
'''Type''': [[Types/LightDefinition]]

=== effect ===
'''Type''': [[Types/string]]

Either "flicker", "uranium-glow" or "none".

=== apply_recipe_tint ===
'''Type''': [[Types/string]]

Either "primary", "secondary", "tertiary", "quaternary" or "none". Used by [[Prototype/CraftingMachine]].

=== apply_tint ===
'''Type''': [[Types/string]]

Either "resource-color", "input-fluid-base-color", "input-fluid-flow-color", "status" or "none". Used by [[Prototype/CraftingMachine]] ("status" only) and [[Prototype/MiningDrill]].

For "status" on CraftingMachine, the colors are specified via [[Prototype/CraftingMachine#status_colors]].

For "status" on MiningDrill, the colors are specified via [[Types/MiningDrillGraphicsSet#status_colors]].

For "resource-color", the colors are specified via [[Prototype/ResourceEntity#mining_visualisation_tint]].

=== north_animation ===
'''Type''': [[Types/Animation]]

Either these animations for the directions are loaded (though they are still optional), or <code>animation</code> is loaded.

=== west_animation ===
'''Type''': [[Types/Animation]]

Either these animations for the directions are loaded (though they are still optional), or <code>animation</code> is loaded.

=== south_animation ===
'''Type''': [[Types/Animation]]

Either these animations for the directions are loaded (though they are still optional), or <code>animation</code> is loaded.

=== east_animation ===
'''Type''': [[Types/Animation]]

Either these animations for the directions are loaded (though they are still optional), or <code>animation</code> is loaded.

=== animation ===
'''Type''': [[Types/Animation]]

If this is present, this is loaded, otherwise the animation properties for each direction are loaded.

=== north_position ===
'''Type''': [[Types/vector]]

=== west_position ===
'''Type''': [[Types/vector]]

=== south_position ===
'''Type''': [[Types/vector]]

=== east_position ===
'''Type''': [[Types/vector]]

Prototype/SelectionTool

2021-09-22T12:58:09Z

Asdff45: Fixed typo

{{Prototype parent|Prototype/ItemWithLabel}}
Used in the base game as a base for the blueprint item and the deconstruction item.

{{Prototype TOC|selection-tool}}

== Extensions ==
* [[Prototype/BlueprintItem]] '''blueprint'''
* [[Prototype/CopyPasteTool]] '''copy-paste-tool'''
* [[Prototype/DeconstructionItem]] '''deconstruction-item'''
* [[Prototype/UpgradeItem]] '''upgrade-item'''

== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/ItemWithLabel]].

{{Prototype property|selection_color|[[Types/Color|Color]]}}
The color of the rectangle used when standard selection is done in-game.

{{Prototype property|alt_selection_color|[[Types/Color|Color]]}}
The color of the rectangle used when alt-selection is done in-game.

{{Prototype property|selection_mode|[[Types/table|table]] of [[Types/string|string]]}}
A list of selection mode flags that define how the selection tool selects things in-game.

Possible values are:
{| class="wikitable"
|-
! Flag !! meaning
|-
| blueprint || The normal rules for acceptable entities in blueprints
|-
| deconstruct || The normal rules for acceptable entities for deconstruction
|-
| cancel-deconstruct || The normal rules for acceptable entities for cancel deconstruction
|-
| items || Item entities
|-
| trees || Trees
|-
| buildable-type || Buildable entities as defined by the game
|-
| nothing || Nothing
|-
| items-to-place || The entity has an item that builds the entity
|-
| any-entity || Any entity
|-
| any-tile || Any tile
|-
| same-force || The entity force matches that of the player doing the selection
|-
| not-same-force || The entity force does not match that of the player doing the selection
|-
| friend || The entity force is friend to that of the player doing the selection
|-
| enemy || The entity force is enemy to that of the player doing the selection
|-
| upgrade || The normal rules for acceptable entities in upgrade planners
|-
| cancel-upgrade || The normal rules for acceptable entities for cancel upgrade
|-
| downgrade || The normal rules for acceptable entities for downgrade
|-
| entity-with-health ||
|-
| entity-with-force ||
|-
| entity-with-owner ||
|-
| avoid-rolling-stock || The entity is not a [[Prototype/RollingStock]]
|}

{{Prototype property|alt_selection_mode|[[Types/table|table]] of [[Types/string|string]]}}
A list of selection mode flags that define how the selection tool alt-selects things in-game. Possible values are identical to normal selection_mode.

{{Prototype property|selection_cursor_box_type|[[Types/CursorBoxType|CursorBoxType]]}}
The type of cursor box used to render selection of entities/tiles when standard selecting.

{{Prototype property|alt_selection_cursor_box_type|[[Types/CursorBoxType|CursorBoxType]]}}
The type of cursor box used to render selection of entities/tiles when alt selecting.

== Optional properties ==

{{Prototype property|reverse_selection_color|[[Types/Color|Color]]|Value of <code>selection_color</code>|optional=true}}

{{Prototype property|selection_count_button_color|[[Types/Color|Color]]|Value of <code>selection_color</code>|optional=true}}

{{Prototype property|alt_selection_count_button_color|[[Types/Color|Color]]|Value of <code>alt_selection_color</code>|optional=true}}

{{Prototype property|reverse_selection_count_button_color|[[Types/Color|Color]]|Value of <code>reverse_selection_color</code>|optional=true}}

{{Prototype property|chart_selection_color|[[Types/Color|Color]]|Value of <code>selection_color</code>|optional=true}}

{{Prototype property|chart_alt_selection_color|[[Types/Color|Color]]|Value of <code>alt_selection_color</code>|optional=true}}

{{Prototype property|chart_reverse_selection_color|[[Types/Color|Color]]|Value of <code>reverse_selection_color</code>|optional=true}}

{{Prototype property|reverse_selection_mode|[[Types/table|table]] of [[Types/string|string]]|Value of <code>selection_mode</code>|optional=true}}
A list of selection mode flags that define how the selection tool reverse-selects things in-game. Possible values are identical to normal selection_mode.

{{Prototype property|reverse_selection_cursor_box_type|[[Types/CursorBoxType|CursorBoxType]]|Value of <code>selection_cursor_box_type</code>|optional=true}}
The type of cursor box used to render selection of entities/tiles when reverse-selecting.

{{Prototype property|always_include_tiles|[[Types/bool|bool]]|false|optional=true}}
If tiles should be included in the selection regardless of entities also being in the selection. This is a visual only setting.

{{Prototype property|mouse_cursor|[[Types/string|string]]|"selection-tool-cursor"|optional=true}}
Name of a [[Prototype/MouseCursor]].

{{Prototype property|entity_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
Array of [[Prototype/Entity]] names.

{{Prototype property|alt_entity_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
Array of [[Prototype/Entity]] names.

{{Prototype property|entity_type_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}

{{Prototype property|alt_entity_type_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}

{{Prototype property|tile_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
Array of [[Prototype/Tile]] names.

{{Prototype property|alt_tile_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
Array of [[Prototype/Tile]] names.

{{Prototype property|entity_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}}
One of "whitelist" and "blacklist".

{{Prototype property|alt_entity_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}}
One of "whitelist" and "blacklist".

{{Prototype property|tile_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}}
One of "whitelist" and "blacklist".

{{Prototype property|alt_tile_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}}
One of "whitelist" and "blacklist".

Types/SpriteNWaySheet

2020-12-24T03:16:50Z

Asdff45: Surround new draw_as_* descriptions with <code>tag

Used in [[Types/Sprite4Way]] and [[Types/Sprite8Way]]

== Mandatory properties ==

=== filename ===
'''Type''': [[Types/FileName]]

'''Default''': ""

Technically optional, but path to sprite cannot be empty.

== Optional properties ==

=== frames ===
'''Type''': [[Types/uint32]]

'''Default''': 4 if this is used in [[Types/Sprite4Way]], 8 if used in [[Types/Sprite8Way]]

Specifies how many of the directions of the SpriteNWay are filled up with this sheet.

=== hr_version ===
'''Type''': [[Types/SpriteNWaySheet]]

If this property exists and high resolution sprites are turned on, its contents are used to load the SpriteNWaySheet.

=== priority ===
'''Type''': [[Types/SpritePriority]]

'''Default''': "medium"

=== flags ===
'''Type''': [[Types/SpriteFlags]]

=== size ===
'''Type''': [[Types/SpriteSizeType]] or [[Types/table]] of [[Types/SpriteSizeType]]

The width and height of the sprite. If this is an array, the first member of the array 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.

=== width ===
'''Type''': [[Types/SpriteSizeType]]

Mandatory if <code>size</code> is not given. Width of the picture in pixels, from 0-8192.

=== height ===
'''Type''': [[Types/SpriteSizeType]]

Mandatory if <code>size</code> is not given. Height of the picture in pixels, from 0-8192.

=== x ===
'''Type''': [[Types/SpriteSizeType]]

'''Default''': 0

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

=== y ===
'''Type''': [[Types/SpriteSizeType]]

'''Default''': 0

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

=== position ===
'''Type''': [[Types/table]] of [[Types/SpriteSizeType]]

Loaded only when <code>x</code> and <code>y</code> are both 0. The first member of the array is x and the second is y.

=== shift ===
'''Type''': [[Types/vector]]

'''Default''': {0, 0}

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.

=== scale ===
'''Type''': [[Types/double]]

'''Default''': 1

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

=== draw_as_shadow ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_shadow</code> takes precedence over <code>draw_as_glow</code> and <code>draw_as_light</code>.

=== draw_as_glow ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_glow</code> takes precedence over <code>draw_as_light</code>.

Draws first as a normal sprite, and again as a light layer.<sup>[https://forums.factorio.com/91682]</sup>

=== draw_as_light ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true.

=== mipmap_count ===
'''Type''': [[Types/uint8]]

'''Default''': 0

Only loaded if this is an icon (has flag "group=icon" or "group=gui").

=== apply_runtime_tint ===
'''Type''': [[Types/bool]]

'''Default''': false

=== tint ===
'''Type''': [[Types/Color]]

'''Default''': {r=1, g=1, b=1, a=1} (white)

=== blend_mode ===
'''Type''': [[Types/BlendMode]]

'''Default''': "normal"

=== load_in_minimal_mode ===
'''Type''': [[Types/bool]]

'''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 ([https://cdn.discordapp.com/attachments/340530709712076801/532315796626472972/unknown.png Example]). If you are a modder, you can just ignore this property.

=== premul_alpha ===
'''Type''': [[Types/bool]]

'''Default''': true

Whether alpha should be premultiplied.

=== generate_sdf ===
'''Type''': [[Types/bool]]

'''Default''': false

== Example ==
<syntaxhighlight lang="lua">sheet =
{
filename = "__base__/graphics/entity/burner-inserter/burner-inserter-platform.png",
priority = "extra-high",
width = 46,
height = 46,
shift = {0.09375, 0},
hr_version =
{
filename = "__base__/graphics/entity/burner-inserter/hr-burner-inserter-platform.png",
priority = "extra-high",
width = 105,
height = 79,
shift = util.by_pixel(1.5, 7.5-1),
scale = 0.5
}
}</syntaxhighlight>

Types/Sprite

2020-12-24T03:12:59Z

Asdff45: Surround new draw_as_* descriptions with <code>tag

== Basics ==
Specifies one picture that can be used in the game.

When there is more than one sprite or [[Types/Animation|animation]] frame with the same source file and dimensions/position in the game, they all share the same memory.
== Mandatory properties ==

=== filename ===
'''Type''': [[Types/FileName]]

'''Default''': ""

Technically optional, but path to sprite cannot be empty.

== Optional properties ==

=== layers ===
'''Type''': [[Types/table]] of [[Types/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. Each item (Sprite definition) in the array may also have the <code>layers</code> property.

If this property is present, all other properties are ignored and the mandatory properties do not have to be defined.

Layers may not be an empty table.

=== hr_version ===
'''Type''': [[Types/Sprite]]

If this property exists and high resolution sprites are turned on, its contents are used to load the sprite.

=== slice or dice ===
'''Type''': [[Types/SpriteSizeType]]

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.

Example: If this is 4, the sprite will be sliced into a 4×4 grid.

=== slice_x or dice_x ===
'''Type''': [[Types/SpriteSizeType]]

Same as <code>slice</code> or <code>dice</code> above, but this specifies only how many slices there are on the x axis.

=== slice_y or dice_y ===
'''Type''': [[Types/SpriteSizeType]]

Same as <code>slice</code> or <code>dice</code> above, but this specifies only how many slices there are on the y axis.

=== priority ===
'''Type''': [[Types/SpritePriority]]

'''Default''': "medium"

=== flags ===
'''Type''': [[Types/SpriteFlags]]

=== size ===
'''Type''': [[Types/SpriteSizeType]] or [[Types/table]] of [[Types/SpriteSizeType]]

The width and height of the sprite. If this is an array, the first member of the array 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.

=== width ===
'''Type''': [[Types/SpriteSizeType]]

Mandatory if <code>size</code> is not given. Width of the picture in pixels, from 0-8192.

=== height ===
'''Type''': [[Types/SpriteSizeType]]

Mandatory if <code>size</code> is not given. Height of the picture in pixels, from 0-8192.

=== x ===
'''Type''': [[Types/SpriteSizeType]]

'''Default''': 0

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

=== y ===
'''Type''': [[Types/SpriteSizeType]]

'''Default''': 0

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

=== position ===
'''Type''': [[Types/table]] of [[Types/SpriteSizeType]]

Loaded only when <code>x</code> and <code>y</code> are both 0. The first member of the array is x and the second is y.

=== shift ===
'''Type''': [[Types/vector]]

'''Default''': {0, 0}

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.

=== scale ===
'''Type''': [[Types/double]]

'''Default''': 1

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

=== draw_as_shadow ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_shadow</code> takes precedence over <code>draw_as_glow</code> and <code>draw_as_light</code>.

=== draw_as_glow ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_glow</code> takes precedence over <code>draw_as_light</code>.

Draws first as a normal sprite, and again as a light layer.<sup>[https://forums.factorio.com/91682]</sup>

=== draw_as_light ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true.

=== mipmap_count ===
'''Type''': [[Types/uint8]]

'''Default''': 0

Only loaded if this is an icon (has flag "group=icon" or "group=gui").

=== apply_runtime_tint ===
'''Type''': [[Types/bool]]

'''Default''': false

=== tint ===
'''Type''': [[Types/Color]]

'''Default''': {r=1, g=1, b=1, a=1} (white)

=== blend_mode ===
'''Type''': [[Types/BlendMode]]

'''Default''': "normal"

=== load_in_minimal_mode ===
'''Type''': [[Types/bool]]

'''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 ([https://cdn.discordapp.com/attachments/340530709712076801/532315796626472972/unknown.png Example]). If you are a modder, you can just ignore this property.

=== premul_alpha ===
'''Type''': [[Types/bool]]

'''Default''': true

Whether alpha should be premultiplied.

=== generate_sdf ===
'''Type''': [[Types/bool]]

'''Default''': false

== Example ==
<syntaxhighlight lang="lua">picture =
{
filename = "__base__/graphics/entity/basic-accumulator/basic-accumulator.png",
priority = "extra-high",
width = 124,
height = 103,
shift = {0.7, -0.2}
}</syntaxhighlight>

{{Prototype property type usage|{{FULLPAGENAME}}?Sprite]}}

Types/RotatedSprite

2020-12-24T02:41:50Z

Asdff45: Surround new draw_as_* descriptions with <code>tag

== Basics ==
Specifies series of sprites used to visualise different rotations of the object.

== Mandatory properties ==

=== direction_count ===
'''Type''': [[Types/uint16]]

Count of direction (frames) specified.

== Optional properties ==

=== filename ===
'''Type''': [[Types/FileName]]

'''Default''': ""

Either this or <code>"filenames"</code> has to be non-empty.

=== filenames ===
'''Type''': [[types/table]] of [[Types/FileName]]

'''Default''': ""

Array of filenames. Either this or <code>"filename"</code> has to be non-empty.

=== layers ===
'''Type''': [[Types/table]] of [[Types/RotatedSprite]]

If this property is present, all RotatedSprite definitions have to be placed as entries in the array, and they will all be loaded from there. Each item (RotatedSprite definition) in the array may also have the <code>layers</code> property.

If this property is present, all other properties are ignored and the mandatory properties do not have to be defined.

Layers may not be an empty table.

=== hr_version ===
'''Type''': [[Types/RotatedSprite]]

If this property exists and high resolution sprites are turned on, its contents are used to load the RotatedSprite.

=== slice or dice ===
'''Type''': [[Types/SpriteSizeType]]

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.

Example: If this is 4, the sprite will be sliced into a 4×4 grid.

=== slice_x or dice_x ===
'''Type''': [[Types/SpriteSizeType]]

Same as <code>slice</code> or <code>dice</code> above, but this specifies only how many slices there are on the x axis.

=== slice_y or dice_y ===
'''Type''': [[Types/SpriteSizeType]]

Same as <code>slice</code> or <code>dice</code> above, but this specifies only how many slices there are on the y axis.

=== priority ===
'''Type''': [[Types/SpritePriority]]

'''Default''': "medium"

=== flags ===
'''Type''': [[Types/SpriteFlags]]

=== size ===
'''Type''': [[Types/SpriteSizeType]] or [[Types/table]] of [[Types/SpriteSizeType]]

The width and height of the sprite. If this is an array, the first member of the array 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.

=== width ===
'''Type''': [[Types/SpriteSizeType]]

Mandatory if <code>size</code> is not given. Width of the picture in pixels, from 0-8192.

=== height ===
'''Type''': [[Types/SpriteSizeType]]

Mandatory if <code>size</code> is not given. Height of the picture in pixels, from 0-8192.

=== x ===
'''Type''': [[Types/SpriteSizeType]]

'''Default''': 0

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

=== y ===
'''Type''': [[Types/SpriteSizeType]]

'''Default''': 0

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

=== position ===
'''Type''': [[Types/table]] of [[Types/SpriteSizeType]]

Loaded only when <code>x</code> and <code>y</code> are both 0. The first member of the array is x and the second is y.

=== shift ===
'''Type''': [[Types/vector]]

'''Default''': {0, 0}

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.

=== scale ===
'''Type''': [[Types/double]]

'''Default''': 1

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

=== draw_as_shadow ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_shadow</code> takes precedence over <code>draw_as_glow</code> and <code>draw_as_light</code>.

=== draw_as_glow ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_glow</code> takes precedence over <code>draw_as_light</code>.

Draws first as a normal sprite, and again as a light layer.<sup>[https://forums.factorio.com/91682]</sup>

=== draw_as_light ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true.

=== mipmap_count ===
'''Type''': [[Types/uint8]]

'''Default''': 0

Only loaded if this is an icon (has flag "group=icon" or "group=gui").

=== apply_runtime_tint ===
'''Type''': [[Types/bool]]

'''Default''': false

=== tint ===
'''Type''': [[Types/Color]]

'''Default''': {r=1, g=1, b=1, a=1} (white)

=== blend_mode ===
'''Type''': [[Types/BlendMode]]

'''Default''': "normal"

=== load_in_minimal_mode ===
'''Type''': [[Types/bool]]

'''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 ([https://cdn.discordapp.com/attachments/340530709712076801/532315796626472972/unknown.png Example]). If you are a modder, you can just ignore this property.

=== premul_alpha ===
'''Type''': [[Types/bool]]

'''Default''': true

Whether alpha should be premultiplied.

=== generate_sdf ===
'''Type''': [[Types/bool]]

'''Default''': false

=== axially_symmetrical ===
'''Type''': [[Types/bool]]

'''Default''': false

When set to true, left the same picture is used for left/right direction, just flipped, this can save half of the space required, but is not usable once the picture contains shadows etc.

=== back_equals_front ===
'''Type''': [[Types/bool]]

'''Default''': false

=== apply_projection ===
'''Type''': [[Types/bool]]

'''Default''': true

Used to fix the inconsistency of direction of the entity in 3d when rendered and direction on the screen (where the 45 degree angle for projection is used).

=== counterclockwise ===
'''Type''': [[Types/bool]]

'''Default''': false

Set to true to indicate sprites in the spritesheet are in counterclockwise order.

=== line_length ===
'''Type''': [[Types/uint32]]

'''Defult''': 0

Used to specify the individual images in grid.
0 means that all the picture are in one horizontal line.

=== allow_low_quality_rotation ===
'''Type''': [[Types/bool]]

'''Default''': false

=== lines_per_file ===
'''Type''': [[Types/uint64]]

Mandatory if <code>"filenames"</code> exists.

== Example ==
<syntaxhighlight lang="lua">pictures =
{
layers =
{
{
filename = "__base__/graphics/entity/radar/radar.png",
priority = "low",
width = 98,
height = 128,
apply_projection = false,
direction_count = 64,
line_length = 8,
shift = util.by_pixel(1, -16),
hr_version =
{
filename = "__base__/graphics/entity/radar/hr-radar.png",
priority = "low",
width = 196,
height = 254,
apply_projection = false,
direction_count = 64,
line_length = 8,
shift = util.by_pixel(1, -16),
scale = 0.5
}
},
{
filename = "__base__/graphics/entity/radar/radar-shadow.png",
priority = "low",
width = 172,
height = 94,
apply_projection = false,
direction_count = 64,
line_length = 8,
shift = util.by_pixel(39,3),
draw_as_shadow = true,
hr_version =
{
filename = "__base__/graphics/entity/radar/hr-radar-shadow.png",
priority = "low",
width = 343,
height = 186,
apply_projection = false,
direction_count = 64,
line_length = 8,
shift = util.by_pixel(39.25,3),
draw_as_shadow = true,
scale = 0.5
}
}
}
},</syntaxhighlight>

{{Prototype property type usage|{{FULLPAGENAME}}}}

Types/RotatedAnimation

2020-12-24T02:22:23Z

Asdff45: Surround new draw_as_* descriptions with <code>tag

== Mandatory properties ==

=== direction_count ===
'''Type''': [[Types/uint32]]

== Optional properties ==

=== layers ===
'''Type''': [[Types/table]] of [[Types/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. Each item (RotatedAnimation definition) in the array may also have the <code>layers</code> property.

If this property is present, all other properties are ignored and the mandatory properties do not have to be defined.

Layers may not be an empty table.

=== hr_version ===
'''Type''': [[Types/RotatedAnimation]]

If this property exists and high resolution sprites are turned on, its contents are used to load the RotatedAnimation.

=== filename ===
'''Type''': [[Types/FileName]]

'''Default''': ""

Mandatory if <code>stripes</code> and <code>filenames</code> is not specified.

=== filenames ===
'''Type''': [[types/table]] of [[Types/FileName]]

'''Default''': ""

Only loaded if <code>stripes</code> is not present.

=== slice ===
'''Type''': [[Types/uint32]]

Mandatory if <code>filenames</code> is present.

=== lines_per_file ===
'''Type''': [[Types/uint32]]

Mandatory if <code>filenames</code> is present.

=== priority ===
'''Type''': [[Types/SpritePriority]]

'''Default''': "medium"

=== flags ===
'''Type''': [[Types/SpriteFlags]]

=== size ===
'''Type''': [[Types/SpriteSizeType]] or [[Types/table]] of [[Types/SpriteSizeType]]

The width and height of the one frame. If this is an array, the first member of the array 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.

=== width ===
'''Type''': [[Types/SpriteSizeType]]

Mandatory if <code>size</code> is not given. Width of one frame in pixels, from 0-8192.

=== height ===
'''Type''': [[Types/SpriteSizeType]]

Mandatory if <code>size</code> is not given. Height of one frame in pixels, from 0-8192.

=== x ===
'''Type''': [[Types/SpriteSizeType]]

'''Default''': 0

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

=== y ===
'''Type''': [[Types/SpriteSizeType]]

'''Default''': 0

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

=== position ===
'''Type''': [[Types/table]] of [[Types/SpriteSizeType]]

Loaded only when <code>x</code> and <code>y</code> are both 0. The first member of the array is x and the second is y.

=== shift ===
'''Type''': [[Types/vector]]

'''Default''': {0, 0}

=== scale ===
'''Type''': [[Types/double]]

'''Default''': 1

Values different than 1 specify the scale of the animation on default zoom.
Scale 2 means that the picture will be 2 times bigger on screen (and more pixelated).

=== draw_as_shadow ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_shadow</code> takes precedence over <code>draw_as_glow</code> and <code>draw_as_light</code>.

=== draw_as_glow ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_glow</code> takes precedence over <code>draw_as_light</code>.

Draws first as a normal sprite, and again as a light layer.<sup>[https://forums.factorio.com/91682]</sup>

=== draw_as_light ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true.

=== mipmap_count ===
'''Type''': [[Types/uint8]]

'''Default''': 0

Only loaded if this is an icon (has flag "group=icon" or "group=gui").

=== apply_runtime_tint ===
'''Type''': [[Types/bool]]

'''Default''': false

=== tint ===
'''Type''': [[Types/Color]]

'''Default''': {r=1, g=1, b=1, a=1} (white)

=== blend_mode ===
'''Type''': [[Types/BlendMode]]

'''Default''': "normal"''

=== load_in_minimal_mode ===
'''Type''': [[Types/bool]]

'''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 ([https://cdn.discordapp.com/attachments/340530709712076801/532315796626472972/unknown.png Example]). If you are a modder, you can just ignore this property.

=== premul_alpha ===
'''Type''': [[Types/bool]]

'''Default''': true

Whether alpha should be premultiplied.

=== generate_sdf ===
'''Type''': [[Types/bool]]

'''Default''': false

=== run_mode ===
'''Type''': [[Types/string]]

'''Default''': "forward"

Possible values are:
*forward
*backward
*forward-then-backward

=== frame_count ===
'''Type''': [[Types/uint32]]

'''Default''': 1

Can't be 0.

=== line_length ===
'''Type''': [[Types/uint32]]

'''Default''': 0

Once the specified number of pictures is loaded, other pictures are loaded on other line.
This is to allow having longer animations in matrix, to avoid pictures with too big width.
The game engine limits the width of any input picture to 2048px, so it is compatible with most graphics cards.

=== animation_speed ===
'''Type''': [[Types/float]]

'''Default''': 1

Modifier of the animation playing speed, the default is 1, which means one animation frame per tick (60 fps).
The speed of playing can often vary depending on the usage (output of steam engine for example). Has to be greater than 0.

=== max_advance ===
'''Type''': [[Types/float]]

'''Default''': MAX_FLOAT

=== repeat_count ===
'''Type''': [[Types/uint8]]

'''Default''': 1

Can't be 0.

=== dice ===
'''Type''': [[Types/uint8]]

=== dice_x ===
'''Type''': [[Types/uint8]]

=== dice_y ===
'''Type''': [[Types/uint8]]

=== frame_sequence ===
'''Type''': [[Types/AnimationFrameSequence]]

=== still_frame ===
'''Type''': [[Types/uint32]]

'''Default''': 0

=== axially_symmetrical ===
'''Type''': [[Types/bool]]

'''Default''': false

If true, <code>direction_count</code> must be greater than 1.

=== counterclockwise ===
'''Type''': [[Types/bool]]

'''Default''': false

=== middle_orientation ===
'''Type''': [[Types/RealOrientation]]

'''Default''': 0.5

=== orientation_range ===
'''Type''': [[Types/float]]

'''Default''': 1

Automatically clamped to be between 0 and 1.

=== apply_projection ===
'''Type''': [[Types/bool]]

'''Default''': true

=== stripes ===
'''Type''': [[Types/table|table]] (array) of [[Types/Stripe|Stripe]]

{{Prototype property type usage|{{FULLPAGENAME}}}}

Types/Animation

2020-12-24T02:19:26Z

Asdff45: Surround new draw_as_* descriptions with <code>tag

== Basics ==
Specifies 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 [[Types/Sprite]] or frame of other animation, it will be shared.

== Optional properties ==

=== layers ===
'''Type''': [[Types/table]] of [[Types/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. Each item (Animation definition) in the array may also have the <code>layers</code> property.

If this property is present, all other properties are ignored and the mandatory properties do not have to be defined.

Layers may not be an empty table.

=== hr_version ===
'''Type''': [[Types/Animation]]

If this property exists and high resolution sprites are turned on, its contents are used to load the Animation.

=== filename ===
'''Type''': [[Types/FileName]]

'''Default''': ""

Mandatory if <code>"stripes"</code> is not specified.

=== priority ===
'''Type''': [[Types/SpritePriority]]

'''Default''': "medium"

=== flags ===
'''Type''': [[Types/SpriteFlags]]

=== size ===
'''Type''': [[Types/SpriteSizeType]] or [[Types/table]] of [[Types/SpriteSizeType]]

The width and height of the one frame. If this is an array, the first member of the array 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.

=== width ===
'''Type''': [[Types/SpriteSizeType]]

Mandatory if <code>size</code> is not given. Width of one frame in pixels, from 0-8192.

=== height ===
'''Type''': [[Types/SpriteSizeType]]

Mandatory if <code>size</code> is not given. Height of one frame in pixels, from 0-8192.

=== x ===
'''Type''': [[Types/SpriteSizeType]]

'''Default''': 0

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

=== y ===
'''Type''': [[Types/SpriteSizeType]]

'''Default''': 0

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

=== position ===
'''Type''': [[Types/table]] of [[Types/SpriteSizeType]]

Loaded only when <code>x</code> and <code>y</code> are both 0. The first member of the array is x and the second is y.

=== shift ===
'''Type''': [[Types/vector]]

'''Default''': {0, 0}

=== scale ===
'''Type''': [[Types/double]]

'''Default''': 1

Values different than 1 specify the scale of the animation on default zoom.
Scale 2 means that the picture will be 2 times bigger on screen (and more pixelated).

=== draw_as_shadow ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_shadow</code> takes precedence over <code>draw_as_glow</code> and <code>draw_as_light</code>.

=== draw_as_glow ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_glow</code> takes precedence over <code>draw_as_light</code>.

Draws first as a normal sprite, and again as a light layer.<sup>[https://forums.factorio.com/91682]</sup>

=== draw_as_light ===
'''Type''': [[Types/bool]]

'''Default''': false

Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true.

=== mipmap_count ===
'''Type''': [[Types/uint8]]

'''Default''': 0

Only loaded if this is an icon (has flag "group=icon" or "group=gui").

=== apply_runtime_tint ===
'''Type''': [[Types/bool]]

'''Default''': false

=== tint ===
'''Type''': [[Types/Color]]

'''Default''': {r=1, g=1, b=1, a=1} (white)

=== blend_mode ===
'''Type''': [[Types/BlendMode]]

'''Default''': "normal"

=== load_in_minimal_mode ===
'''Type''': [[Types/bool]]

'''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 ([https://cdn.discordapp.com/attachments/340530709712076801/532315796626472972/unknown.png Example]). If you are a modder, you can just ignore this property.

=== premul_alpha ===
'''Type''': [[Types/bool]]

'''Default''': true

Whether alpha should be premultiplied.

=== generate_sdf ===
'''Type''': [[Types/bool]]

'''Default''': false

=== run_mode ===
'''Type''': [[Types/string]]

'''Default''': "forward"

Possible values are:
*forward
*backward
*forward-then-backward

=== frame_count ===
'''Type''': [[Types/uint32]]

'''Default''': 1

Can't be 0.

=== line_length ===
'''Type''': [[Types/uint32]]

'''Default''': 0

Once the specified number of pictures is loaded, other pictures are loaded on other line.
This is to allow having longer animations in matrix, to avoid pictures with too big width.
The game engine limits the width of any input picture to 2048px, so it is compatible with most graphics cards.

=== animation_speed ===
'''Type''': [[Types/float]]

'''Default''': 1

Modifier of the animation playing speed, the default is 1, which means one animation frame per tick (60 fps).
The speed of playing can often vary depending on the usage (output of steam engine for example). Has to be greater than 0.

=== max_advance ===
'''Type''': [[Types/float]]

'''Default''': MAX_FLOAT

=== repeat_count ===
'''Type''': [[Types/uint8]]

'''Default''': 1

Can't be 0.

=== dice ===
'''Type''': [[Types/uint8]]

=== dice_x ===
'''Type''': [[Types/uint8]]

=== dice_y ===
'''Type''': [[Types/uint8]]

=== frame_sequence ===
'''Type''': [[Types/AnimationFrameSequence]]

=== stripes ===
'''Type''': [[Types/table|table]] (array) of [[Types/Stripe|Stripe]]

== Example ==
Specification of animation of a beacon
<syntaxhighlight lang="lua">
animation =
{
filename = "__base__/graphics/entity/beacon/beacon-antenna.png",
width = 54,
height = 50,
line_length = 8,
frame_count = 32,
shift = { -0.03125, -1.71875},
animation_speed = 0.5
},</syntaxhighlight>

{{Prototype property type usage|{{FULLPAGENAME}}?Animation]}}

Prototype/Sprite

2020-12-23T02:13:08Z

Asdff45: use <code> around targets in new draw_as_glow and draw_as_light

{{Prototype parent}}
Specifies a picture that can be used with https://lua-api.factorio.com/latest/Concepts.html#SpritePath during runtime.

{{Prototype TOC|sprite}}

== Mandatory properties ==

{{Prototype property|type|[[Types/string|string]]}}
Must be "sprite".

{{Prototype property|name|[[Types/string|string]]}}
Name of the sprite. Must be unique. Can be used as a https://lua-api.factorio.com/latest/Concepts.html#SpritePath.

{{Prototype property|filename|[[Types/FileName|FileName]]|""}}
Technically optional, but path to sprite cannot be empty.

== Optional properties ==

{{Prototype property|layers|[[Types/table|table]] of [[Types/Sprite|Sprite]]|optional=true}}
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. Each item (Sprite definition) in the array may also have the <code>layers</code> property.

If this property is present, all other properties are ignored and the mandatory properties do not have to be defined.

Layers may not be an empty table.

{{Prototype property|hr_version|[[Types/Sprite|Sprite]]|optional=true}}
If this property exists and high resolution sprites are turned on, its contents are used to load the sprite.

{{Prototype property|slice or dice|[[Types/SpriteSizeType|SpriteSizeType]]|optional=true}}
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.

Example: If this is 4, the sprite will be sliced into a 4×4 grid.

{{Prototype property|slice_x or dice_x|[[Types/SpriteSizeType|SpriteSizeType]]|optional=true}}
Same as <code>slice</code> above, but this specifies only how many slices there are on the x axis.

{{Prototype property|slice_y or dice_y|[[Types/SpriteSizeType|SpriteSizeType]]|optional=true}}
Same as <code>slice</code> above, but this specifies only how many slices there are on the y axis.

{{Prototype property|priority|[[Types/SpritePriority|SpritePriority]]|"medium"|optional=true}}

{{Prototype property|flags|[[Types/SpriteFlags|SpriteFlags]]|optional=true}}

{{Prototype property|size|[[Types/SpriteSizeType|SpriteSizeType]] or [[Types/table|table]] of [[Types/SpriteSizeType|SpriteSizeType]]|optional=true}}
The width and height of the sprite. If this is an array, the first member of the array 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.

{{Prototype property|width|[[Types/SpriteSizeType|SpriteSizeType]]|optional=true}}
Mandatory if <code>size</code> is not given. Width of the picture in pixels, from 0-8192.

{{Prototype property|height|[[Types/SpriteSizeType|SpriteSizeType]]|optional=true}}
Mandatory if <code>size</code> is not given. Height of the picture in pixels, from 0-8192.

{{Prototype property|x|[[Types/SpriteSizeType|SpriteSizeType]]|0|optional=true}}
Horizontal position of the sprite in the source file in pixels.

{{Prototype property|y|[[Types/SpriteSizeType|SpriteSizeType]]|0|optional=true}}
Vertical position of the sprite in the source file in pixels.

{{Prototype property|position|[[Types/table|table]] of [[Types/SpriteSizeType|SpriteSizeType]]|optional=true}}
Loaded only when <code>x</code> and <code>y</code> are both 0. The first member of the array is x and the second is y.

{{Prototype property|shift|[[Types/vector|vector]]|<nowiki>{0, 0}</nowiki>|optional=true}}
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.

{{Prototype property|scale|[[Types/double|double]]|1|optional=true}}
Values different than 1 specify the scale of the sprite on default zoom.
Scale 2 means that the picture will be 2 times bigger on screen (and more pixelated).

{{Prototype property|draw_as_shadow|[[Types/bool|bool]]|false|optional=true}}
Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_shadow</code> takes precedence over <code>draw_as_glow</code> and <code>draw_as_light</code>.

{{Prototype property|draw_as_glow |[[Types/bool|bool]]|false|optional=true}}
Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_glow</code> takes precedence over <code>draw_as_light</code>.

Draws first as a normal sprite, and again as a light layer.<sup>[https://forums.factorio.com/91682]</sup>

{{Prototype property|draw_as_light |[[Types/bool|bool]]|false|optional=true}}
Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true.

{{Prototype property|mipmap_count|[[Types/uint8|uint8]]|0|optional=true}}
Only loaded if this is an icon (has flag "group=icon" or "group=gui").

{{Prototype property|apply_runtime_tint|[[Types/bool|bool]]|false|optional=true}}

{{Prototype property|tint|[[Types/Color|Color]]|<nowiki>{r=1, g=1, b=1, a=1} (white)</nowiki>|optional=true}}

{{Prototype property|blend_mode|[[Types/BlendMode|BlendMode]]|"normal"|optional=true}}

{{Prototype property|load_in_minimal_mode|[[Types/bool|bool]]|false|optional=true}}
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 ([https://cdn.discordapp.com/attachments/340530709712076801/532315796626472972/unknown.png Example]). If you are a modder, you can just ignore this property.

{{Prototype property|premul_alpha|[[Types/bool|bool]]|true|optional=true}}
Whether alpha should be premultiplied.

{{Prototype property|generate_sdf|[[Types/bool|bool]]|false|optional=true}}

== Example ==
{
type = "sprite"
name = "accumulator-sprite",
filename = "__base__/graphics/entity/basic-accumulator/basic-accumulator.png",
priority = "extra-high",
width = 124,
height = 103,
shift = {0.7, -0.2}
}

Prototype/Animation

2020-12-23T00:41:33Z

Asdff45: use <code> around targets in new draw_as_glow and draw_as_light

{{Prototype parent}}
Specifies a animation that can be used by https://lua-api.factorio.com/latest/LuaRendering.html#LuaRendering.draw_animation during runtime.

{{Prototype TOC|animation}}

== Mandatory properties ==

{{Prototype property|type|[[Types/string|string]]}}
Must be "animation".

{{Prototype property|name|[[Types/string|string]]}}
Name of the animation. Must be unique. Used in https://lua-api.factorio.com/latest/LuaRendering.html#LuaRendering.draw_animation.

== Optional properties ==

{{Prototype property|layers|[[Types/table|table]] of [[Types/Animation|Animation]]|optional=true}}
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. Each item (Animation definition) in the array may also have the <code>layers</code> property.

If this property is present, all other properties are ignored and the mandatory properties do not have to be defined.

Layers may not be an empty table.

{{Prototype property|hr_version|[[Types/Animation|Animation]]|optional=true}}
If this property exists and high resolution sprites are turned on, its contents are used to load the Animation.

{{Prototype property|filename|[[Types/FileName|FileName]]|""|optional=true}}
Mandatory if <code>stripes</code> is not specified.

{{Prototype property|priority|[[Types/SpritePriority|SpritePriority]]|"medium"|optional=true}}

{{Prototype property|flags|[[Types/SpriteFlags|SpriteFlags]]|optional=true}}

{{Prototype property|size|[[Types/SpriteSizeType|SpriteSizeType]] or [[Types/table|table]] of [[Types/SpriteSizeType|SpriteSizeType]]|optional=true}}
The width and height of the one frame. If this is an array, the first member of the array 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.

{{Prototype property|width|[[Types/SpriteSizeType|SpriteSizeType]]|optional=true}}
Mandatory if <code>size</code> is not given. Width of one frame in pixels, from 0-8192.

{{Prototype property|height|[[Types/SpriteSizeType|SpriteSizeType]]|optional=true}}
Mandatory if <code>size</code> is not given. Height of one frame in pixels, from 0-8192.

{{Prototype property|x|[[Types/SpriteSizeType|SpriteSizeType]]|0|optional=true}}
Horizontal position of the animation in the source file in pixels.

{{Prototype property|y|[[Types/SpriteSizeType|SpriteSizeType]]|0|optional=true}}
Vertical position of the animation in the source file in pixels.

{{Prototype property|position|[[Types/table|table]] of [[Types/SpriteSizeType|SpriteSizeType]]|optional=true}}
Loaded only when <code>x</code> and <code>y</code> are both 0. The first member of the array is x and the second is y.

{{Prototype property|shift|[[Types/vector|vector]]|<nowiki>{0, 0}</nowiki>|optional=true}}

{{Prototype property|scale|[[Types/double|double]]|1|optional=true}}
Values different than 1 specify the scale of the animation on default zoom.
Scale 2 means that the picture will be 2 times bigger on screen (and more pixelated).

{{Prototype property|draw_as_shadow|[[Types/bool|bool]]|false|optional=true}}
Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_shadow</code> takes precedence over <code>draw_as_glow</code> and <code>draw_as_light</code>.

{{Prototype property|draw_as_glow |[[Types/bool|bool]]|false|optional=true}}
Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true. <code>draw_as_glow</code> takes precedence over <code>draw_as_light</code>.

Draws first as a normal sprite, and again as a light layer.<sup>[https://forums.factorio.com/91682]</sup>

{{Prototype property|draw_as_light |[[Types/bool|bool]]|false|optional=true}}
Only one of <code>draw_as_shadow</code>, <code>draw_as_glow</code> and <code>draw_as_light</code> can be true.

{{Prototype property|mipmap_count|[[Types/uint8|uint8]]|0|optional=true}}
Only loaded if this is an icon (has flag "group=icon" or "group=gui").

{{Prototype property|apply_runtime_tint|[[Types/bool|bool]]|false|optional=true}}

{{Prototype property|tint|[[Types/Color|Color]]|<nowiki>{r=1, g=1, b=1, a=1} (white)</nowiki>|optional=true}}

{{Prototype property|blend_mode|[[Types/BlendMode|BlendMode]]|"normal"|optional=true}}

{{Prototype property|load_in_minimal_mode|[[Types/bool|bool]]|false|optional=true}}
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 ([https://cdn.discordapp.com/attachments/340530709712076801/532315796626472972/unknown.png Example]). If you are a modder, you can just ignore this property.

{{Prototype property|premul_alpha|[[Types/bool|bool]]|true|optional=true}}
Whether alpha should be premultiplied.

{{Prototype property|generate_sdf|[[Types/bool|bool]]|false|optional=true}}

{{Prototype property|run_mode|[[Types/string|string]]|"forward"|optional=true}}
Possible values are:
*forward
*backward
*forward-then-backward

{{Prototype property|frame_count|[[Types/uint32|uint32]]|1|optional=true}}
Can't be 0.

{{Prototype property|line_length|[[Types/uint32|uint32]]|0|optional=true}}
Once the specified number of pictures is loaded, other pictures are loaded on other line.
This is to allow having longer animations in matrix, to avoid pictures with too big width.
The game engine limits the width of any input picture to 2048px, so it is compatible with most graphics cards.

{{Prototype property|animation_speed|[[Types/float|float]]|1|optional=true}}
Modifier of the animation playing speed, the default is 1, which means one animation frame per tick (60 fps).
The speed of playing can often vary depending on the usage (output of steam engine for example). Has to be greater than 0.

{{Prototype property|max_advance|[[Types/float|float]]|MAX_FLOAT|optional=true}}

{{Prototype property|repeat_count|[[Types/uint8|uint8]]|1|optional=true}}
Can't be 0.

{{Prototype property|dice|[[Types/uint8|uint8]]|optional=true}}

{{Prototype property|dice_x|[[Types/uint8|uint8]]|optional=true}}

{{Prototype property|dice_y|[[Types/uint8|uint8]]|optional=true}}

{{Prototype property|frame_sequence|[[Types/AnimationFrameSequence|AnimationFrameSequence]]|optional=true}}

{{Prototype property|stripes|[[Types/table|table]] of [[Types/Stripe|Stripe]]|optional=true}}

Types/AnimatedVector

2020-10-07T16:56:05Z

Asdff45: fixed typo

Used by [[Prototype/FluidTurret]].

== Mandatory properties ==

=== rotations ===
'''Type''': [[Types/table]] of [[Types/table]]

An array of tables with the following key/value pairs:
* frames - [[Types/table|array]] of [[Types/vector]] - Mandatory. Sizes of all <code>frames</code> arrays must be the same.
* render_layer - [[Types/RenderLayer]] - Optional.

== Optional properties ==

=== render_layer ===
'''Type''': [[Types/RenderLayer]]

Default render layer for the rotations.

=== direction_shift ===
'''Type''': [[Types/table]]

Table with the following optional key/value pairs:
* north - [[Types/vector]]
* east - [[Types/vector]]
* south - [[Types/vector]]
* west - [[Types/vector]]

Prototype/UpgradeItem

2020-09-24T02:01:20Z

Asdff45:

{{Prototype parent|Prototype/SelectionTool}}
An [[upgrade planner]].

{{Prototype TOC|upgrade-item}}

== Optional properties ==
This prototype inherits all the properties from [[Prototype/SelectionTool]].

{{Prototype property|mapper_count|[[Types/ItemStackIndex|ItemStackIndex]]|0|optional=true}}
Can't be > 255.

== Differing defaults ==
<code>show_in_library</code> defaults to true instead of false. <code>show_in_library</code> is unused as of 0.18.13 as the ability to show any selection tools in the blueprint library was removed.

== Mandatory values ==
Upgrade items must have a stack size of 1.

== Ignored properties ==
'''Prototype/UpgradeItem''' ignores the following properties that it inherits from [[Prototype/SelectionTool]]:
* selection_mode (forced to be "upgrade")
* alt_selection_mode (forced to be "cancel-upgrade")
* always_include_tiles (forced to be false)
* entity_filters
* entity_type_filters
* tile_filters
* entity_filter_mode
* tile_filter_mode
* alt_entity_filters
* alt_entity_type_filters
* alt_tile_filters
* alt_entity_filter_mode
* alt_tile_filter_mode