Official Factorio Wiki - User contributions [en]

Desynchronization

2024-11-27T10:34:45Z

Curiosity: /* Factorio multiplayer architecture */ fixed spelling

A desynchronization (desync) is a disagreement of the game state between the server and at least one client in a multiplayer game, this means the parties no longer run the simulation identically.

== How desyncs happen ==
Desyncs are errors and should not occur during regular play, they can be caused by:
* a bug in Factorio code
* a bug in a mod/scenario
* a miscalculation on server or client hardware
Networking-, latency or performance problems do ''not'' cause desyncs.

=== Factorio multiplayer architecture ===
Factorio multiplayer code uses deterministic lockstep to synchronize clients. This is a method of synchronizing a game from one computer to another by sending only the user inputs that control that game, rather than networking the state of the objects in the game itself. It means that all players' games need to simulate every single tick of the game identically. If any computer does something ever-so-slightly different, a desynchronization (desync) occurs. The game includes processes to ensure any issues with network traffic do not cause desyncs.

=== Player experience of desyncs ===
When a client detects a desync, it disconnects the player and starts to download files from the server (map and game state information) to include them in the [[#Desync_report|Desync report]], this will take longer than the normal map download. After the download is finished and the desync report has been generated the player is offered the options to view the report, quit or reconnect to continue playing. Depending on the cause of the desync, the client might immediately desync again when reconnecting.

[[File:Desync report notification.jpg]]

=== Desync report ===
The desync report will help mod/scenario makers or Factorio developers to fix the underlying bug, it contains both the player's and server's copy of the save game (map and game state). The player's copy is from when the desync occurred and titled ''desynced-level''. With the server's copy being from when the automatic reconnection was made and titled ''reference-level.zip''. A copy of the players Factorio log file is included titled ''log.txt''. As the report contains two copies of the save game it may have a large file size. Furthermore, the save files that are made for the desync report contain more data than normal save files, further increasing their size.

The desync report does not state the cause of the desync but rather is a record of the game state at the time of the desync.

=== Next Steps ===
The next steps after a desync occurs is to start a desync investigation. In many situations restarting the server will work around the desync in the short term and allow all players to rejoin until the conditions for the bug to occur are re-created. However, a server restart isn't guaranteed success and may lead to no players being able to rejoin the server without desyncing.

== Desync Investigations ==
In most cases when desyncs occur and mods or scenarios are being used they are the cause and need to be handled first. If they are found to not be the cause then it should be reported as a [[#Desync_reporting_of_core_Factorio_game|core Factorio desync]]. In both cases identifying the activity that triggers the desync is an important step. For example, whether it is tied to a player's action or activity that happens in the game (i.e. a train arriving at a station) or is a time-related event. In some cases, the desync may not be reproducible and so only a code investigation can work towards a fix.

When desyncs occur and mods/scenarios are in the use there are 2 different approaches that can be taken to help get the issue fixed. The code investigation approach requires you to be familiar with Factorio modding and its coding rules. The less technical method is to identify the mod and activity that causes the desync through trial and error so it can be reported to the mod author.

=== Identifying desync causing mod through trial and error ===
This is a less technical method aiming to identify the mod and its activity that seems to cause the desync so it can be reported to the mod/scenario author. The activity that causes the desync should be established prior to these activities being done to confirm if they are having an impact. These steps may affect the gameplay and should be done on a test save.
* Removing any newly added mods and rolling back (returning to the previous version) any updated mods to see if the issue still occurs.
* Removing mods from the game to rule them out as the cause.
Once the desync can no longer be reproduced the suspected mod can be re-added/updated and the desync recreated to confirm the mod and activity are the cause of the desync. As these steps require the server to be restarted this may in itself fix any desyncs in the short term until the conditions for the bug to occur are re-created.

=== Code investigations with mods/scenarios involved ===
The desync report is a useful reference for investigating desyncs but it does not state the cause of the desync. Comparing the desync files and use of heavy mode can assist in identifying which mods and activities to review initially. Ideally, it is supplemented by an account of what was occurring and being done by players at the point of the desync occurring to assist with narrowing down the activities of code to review. However in many complicated scenarios this may not be known prior to the investigation.

==== Code that causes desyncs ====
There are a number of ways mod and scenario code can cause desyncs, such as due to incorrect variable scoping, requiring or API event handling. Examples of these can be found in [[Tutorial:Modding tutorial/Gangsir#Multiplayer_and_desyncs|Gangsir's modding tutorial multiplayer and desyncs section]], with the full technical definition of usage constraints for API events in the [https://lua-api.factorio.com/latest/Data-Lifecycle.html Factorio API data lifecycle]. Not all instances of non-compliance will lead to desyncs or errors, but most will. For this reason, it is recommended to always maintain compliance to avoid risk and time-consuming testing. Instances of non-compliance found should be raised to the code author.

==== Comparing game state & save files ====
The desync report files and heavy mode dumps contain a number of files that can be compared by any text comparison tool to look for differences. These files are generally sequelized dumps of Lua tables or c++ game objects and so are only partially human readable. The less human readable items can include floating point numbers serilaised (0x.HEXp+HEX) and ''magic'' unique identifier numbers for prototype instances in the c++ game state. These numbers and reference ids should generally be the same between files as the in-game entity they reference normally won't have changed between the 2 save game states being obtained.
When the data differs between files the source code of that mod/scenario must be examined for all interactions with that data item for any instances of non-compliance.

==== Examining the desync files ====
Within each savegame's zip in the desync report are a number of files that when compared can show data changes. As the server copy of the save is obtained after the desync there may be genuine differences between the files. So differences aren't hard evidence of the cause of a desync, but only a pointer on where to investigate further.

* script.dat - contains the scenario and mods [https://lua-api.factorio.com/latest/Global.html Factorio global tables]. Generally, the save's persistent data should be the same between the 2 saves. On rare occasions, there can be a difference due to how the information is written out to the file. Should a mod causes a player's game to desync it can cause the player's game to stop processing other mod activity mid tick. This can lead those mod's global tables to have differences between the player and the server copies despite having no code defects themselves.
* level_with_tags_tick_XXXX.dat - contains the current game state together with additional saving tags to aid human readability. This can show if entity states or chat messages differ. ''level.dat'' is the same information, but without the descriptive tags for data values.

==== Using heavy mode command ====
[[Console#Normal_commands|Heavy mode]] is an in-game option that can be enabled to make Factorio save and load the game every tick. This allows Factorio to highlight if there are any changes in the game state between the save and subsequent load. Should a state change occur, a message is shown in-game and the save and load game states recorded to a ''dumps'' folder in the players [[Application directory#User_data_directory|user data folder]].
Typically this process will trigger for incorrect changing of data as part of the on_load event or local/global variables being changed and not persisted. The recorded game state is a dump of the internal game state, including entities, but does not include the mod's global table. This allows the checking if an entity's state has become different between the load and save state.

This process can be used to partially test a mod for multiplayer compliance without the need of multiple players or a server.

=== Desync reporting of core Factorio game ===
If no mod or scenario were involved in the desync, the desync report and activity information should be posted to the [https://forums.factorio.com/53851 Factorio forums bug report section].

== See also ==
* [https://www.factorio.com/blog/post/fff-63 FFF 63] - How heavy mode works

[[Category:Technical]]

Pistol

2024-11-26T14:31:24Z

Curiosity: It's actually hidden and disabled. Feel free to improve the wording

{{Languages}}
{{:Infobox:Pistol}}

The '''Pistol''' is the most basic weapon in Factorio. In Freeplay mode, the player starts with a pistol and 10 [[firearm magazine]]s.

The Pistol can only handle the smallest of enemy threats and the player will frequently take damage when trying to use it for self-defense. It is recommended to upgrade to the [[Submachine gun]] as soon as possible.

== History ==

{{History|2.0.7|
* Removed the crafting recipe.}}

{{CombatNav}}
{{C|Weapons}}

Prototype/Sticker

2023-05-03T07:00:49Z

Curiosity: according to Klonan on discord

{{Prototype parent|Prototype/Entity}}
Entity that sticks to another entity, and damages/slows it. Stickers can only be attached to [[Prototype/Unit]], [[Prototype/Character]], [[Prototype/Car]] and [[Prototype/SpiderVehicle]].

{{Prototype TOC|sticker}}

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

{{Prototype property|duration_in_ticks|[[Types/uint32|uint32]]}}
Must be > 0.

== Optional properties ==

{{Prototype property|animation|[[Types/Animation|Animation]]|optional=true}}

{{Prototype property|damage_interval|[[Types/uint32|uint32]]|1|optional=true}}
Interval between application of <code>damage_per_tick</code>, in ticks.

{{Prototype property|spread_fire_entity|[[Types/string|string]]|optional=true}}
Name of an entity. If this is given, this sticker is considered a "fire sticker" for some functions, such as [[Types/BaseAttackParameters#fire_penalty|BaseAttackParameters#fire_penalty]] and [[Types/EntityPrototypeFlags#.22not-flammable.22|EntityPrototypeFlags#.22not-flammable.22]].

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

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

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

{{Prototype property|force_visibility|[[Types/ForceCondition|ForceCondition]]|"all"|optional=true}}

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

{{Prototype property|damage_per_tick|[[Types/DamagePrototype|DamagePrototype]]||optional=true}}
Applied every <code>damage_interval</code> ticks, so may not necessarily be "per tick".

{{Prototype property|target_movement_modifier|[[Types/float|float]]|1|optional=true}}
Less than 1 to reduce movement speed, more than 1 to increase it.

{{Prototype property|target_movement_modifier_from|[[Types/float|float]]|Value of <code>target_movement_modifier</code>|optional=true}}
The modifier value when the sticker is attached. It linearly changes over time to reach <code>target_movement_modifier_to</code>.

{{Prototype property|target_movement_modifier_to|[[Types/float|float]]|Value of <code>target_movement_modifier</code>|optional=true}}
The modifier value when the sticker expires. It linearly changes over time starting from <code>target_movement_modifier_from</code>.

{{Prototype property|vehicle_speed_modifier|[[Types/float|float]]|1|optional=true}}
Less than 1 to reduce vehicle speed, more than 1 to increase it.

{{Prototype property|vehicle_speed_modifier_from|[[Types/float|float]]|Value of <code>vehicle_speed_modifier</code>|optional=true}}
Works similarly to <code>target_movement_modifier_from</code>.

{{Prototype property|vehicle_speed_modifier_to|[[Types/float|float]]|Value of <code>vehicle_speed_modifier</code>|optional=true}}
Works similarly to <code>target_movement_modifier_to</code>.

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

{{Prototype property|vehicle_friction_modifier_from|[[Types/float|float]]|Value of <code>vehicle_friction_modifier</code>|optional=true}}
Works similarly to <code>target_movement_modifier_from</code>.

{{Prototype property|vehicle_friction_modifier_to|[[Types/float|float]]|Value of <code>vehicle_friction_modifier</code>|optional=true}}
Works similarly to <code>target_movement_modifier_to</code>.

{{Prototype property|selection_box_type|[[Types/CursorBoxType|CursorBoxType]]|"entity"|optional=true}}
Using this property marks the sticker as a "selection sticker", meaning that the selection box will be rendered around the entity when the sticker is on it.

Types/Animation

2023-04-05T16:21:11Z

Curiosity: dice description + sprite/animation similarity note

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

Also take a look at [[Types/Sprite]], as it shares many properties with animation and some of them may be better documented.

== 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").<br>
Note: mipmap_count doesn't make sense in animation, as it is not possible to layout mipmaps in a way, that would load correctly both the animation and the mipmaps (besides animations with just one frame).[https://forums.factorio.com/viewtopic.php?p=549058#p549058]

=== 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

Unused.

=== 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 input files with too high width.
The game engine limits the width of any input files to 8192px, so it is compatible with most graphics cards.
0 means that all the pictures are in one horizontal line.

=== 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.
If <code>layers</code> are used then the <code>animation_speed</code> only has to be defined in one layer. All layers will run at the same speed.

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

'''Default''': MAX_FLOAT

If <code>layers</code> are used then <code>max_advance</code> only has to be defined in one layer.

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

'''Default''': 1

How many times to repeat the animation to complete an animation cycle. E.g. if one layer is 10 frames, a second layer of 1 frame would need repeat_count = 10 to match the complete cycle.

Can't be 0.

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

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.

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

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

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

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

=== 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/SimpleEntity

2023-03-12T14:21:58Z

Curiosity: pictures/picture/animations priority by word of Klonan plus styling

{{Prototype parent|Prototype/EntityWithHealth}}
An extremely basic entity with no special functionality. Used for minable rocks.

{{Prototype TOC|simple-entity}}

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

{{Prototype property|count_as_rock_for_filtered_deconstruction|[[Types/bool|bool]]|false|optional=true}}
Whether this entity should be treated as a rock for the purpose of deconstruction and for [[Prototype/Car#immune_to_rock_impacts]].

{{Prototype property|render_layer|[[Types/RenderLayer|RenderLayer]]|"object"|optional=true}}

{{Prototype property|secondary_draw_order|[[Types/int8|int8]]|0|optional=true}}
Used to determine render order for entities with the same <code>render_layer</code> in the same position. Entities with a higher <code>secondary_draw_order</code> are drawn on top.

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

{{Prototype property|random_variation_on_create|[[Types/bool|bool]]|true|optional=true}}
Whether a random graphics variation is chosen when placing the entity/creating it via script/creating it via map generation. If this is false, the entity will use the first variation instead of a random one.

{{Prototype property|pictures|[[Types/SpriteVariations|SpriteVariations]]|optional=true}}
Simple entity must have one of <code>picture</code>, <code>pictures</code> or <code>animations</code> defined.

This property takes priority over the other two.

{{Prototype property|picture|[[Types/Sprite|Sprite]]|optional=true}}
Simple entity must have one of <code>picture</code>, <code>pictures</code> or <code>animations</code> defined.

This property takes priority over <code>animations</code>.

{{Prototype property|animations|[[Types/AnimationVariations|AnimationVariations]]|optional=true}}
Simple entity must have one of <code>picture</code>, <code>pictures</code> or <code>animations</code> defined.

The other two properties take priority over this one.

Prototype/MiningDrill

2023-02-27T21:30:20Z

Curiosity: clarify base_productivity behavior

{{Prototype parent|Prototype/EntityWithOwner}}
A mining drill for automatically extracting resources from [[Prototype/ResourceEntity|resource entities]]. This prototype type is used by [[burner mining drill]], [[electric mining drill]] and [[pumpjack]] in vanilla.

{{Prototype TOC|mining-drill}}

== Mandatory properties ==
This prototype inherits the properties of [[Prototype/EntityWithOwner]].

{{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). If the drill does not produce any solid items but uses a fluidbox output instead (e.g. pumpjacks), a vector of {0,0} disables the yellow arrow alt-mode indicator for the placed item location.

{{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. Any values below 0 will be changed to 0.

{{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}}

Prototype/RocketSilo

2023-02-20T10:41:05Z

Curiosity: Clarify how rocket_parts_required works

{{Prototype parent|Prototype/AssemblingMachine}}
A [[rocket silo]].

{{Prototype TOC|rocket-silo}}

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

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

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

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

{{Prototype property|lamp_energy_usage|[[Types/Energy|Energy]]}}
May be 0.

{{Prototype property|rocket_entity|[[Types/string|string]]}}
Name of a [[Prototype/RocketSiloRocket]].

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{{Prototype property|hole_clipping_box|[[Types/BoundingBox|BoundingBox]]}}

{{Prototype property|door_back_open_offset|[[Types/vector|vector]]}}

{{Prototype property|door_front_open_offset|[[Types/vector|vector]]}}

{{Prototype property|silo_fade_out_start_distance|[[Types/double|double]]}}

{{Prototype property|silo_fade_out_end_distance|[[Types/double|double]]}}

{{Prototype property|times_to_blink|[[Types/uint8|uint8]]}}

{{Prototype property|light_blinking_speed|[[Types/double|double]]}}

{{Prototype property|door_opening_speed|[[Types/double|double]]}}

{{Prototype property|rocket_parts_required|[[Types/uint32|uint32]]}}
The number of crafts that must complete to produce a rocket. This includes bonus crafts from productivity. Recipe products are ignored.

== Optional properties ==

{{Prototype property|base_night_sprite|[[Types/Sprite|Sprite]]|optional=true}}

{{Prototype property|base_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}

{{Prototype property|base_engine_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}

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

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

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

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

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

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

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

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

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

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

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

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

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

{{Prototype property|rocket_result_inventory_size|[[Types/ItemStackIndex|ItemStackIndex]]|0|optional=true}}

Types/BaseAttackParameters

2023-01-17T05:51:27Z

Curiosity: /* ammo_categories */ improved wording

The abstract base of all [[Types/AttackParameters|attack parameters]].

== Extensions ==
* [[Types/ProjectileAttackParameters]]
* [[Types/BeamAttackParameters]]
* [[Types/StreamAttackParameters]]

== Mandatory properties ==
=== range ===
'''Type''': [[Types/float]]

Before an entity can attack, the distance (in tiles) between the entity and target must be less than or equal to this.

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

Number of ticks in which it will be possible to shoot again. If < 1, multiple shots can be performed in one tick.

== Optional properties ==
=== min_range ===
'''Type''': [[Types/float]]

'''Default''': 0

The minimum distance (in tiles) between an entity and target. If a unit's target is less than this, the unit will attempt to move away before attacking. A [[Flamethrower turret]] does not move, but has a minimum range. Less than this, it is unable to target an enemy.

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

'''Default''': 1

If this is <= 0, it is set to 1. Arc from 0 to 1, so for example 0.25 is 90°. Used by the [[flamethrower turret]] in the base game. Arcs greater than 0.5 but less than 1 will be clamped to 0.5 as targeting in arcs larger than half circle is not implemented.[https://forums.factorio.com/94654]

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

'''Default''': 0

Used when searching for the nearest enemy, when this is > 0, enemies that aren't burning are preferred over burning enemies. Definition of "burning" for this: Entity has sticker attached to it, and the sticker has a [[Prototype/Sticker#spread_fire_entity|spread_fire_entity]] set.

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

'''Default''': 0

A higher penalty will discourage turrets from targeting units that would take longer to turn to face.

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

'''Default''': 0

A higher penalty will discourage turrets from targeting units with higher health. A negative penalty will encourage turrets to target units with higher health.

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

'''Default''': "center-to-center"

Either "center-to-center" or "bounding-box-to-bounding-box".

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

'''Default''': <code>range</code>

If less than <code>range</code>, the entity will choose a random distance between <code>range</code> and <code>min_attack_distance</code> and attack from that distance.

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

'''Default''': 1

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

'''Default''': 1

Must be greater than or equal to 0.

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

'''Default''': 0

Must be between 0 and 1.

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

'''Default''': 0

Number of ticks it takes for the weapon to actually shoot after the order for shooting has been made. This also allows to "adjust" the shooting animation to the effect of shooting.

[[Types/CapsuleAction]]s cannot have attack_parameters with non-zero warmup.

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

'''Default''': 0

Setting this to anything but zero causes homing projectiles to aim for the predicted location based on enemy movement instead of the current enemy location.

Example from the base game flamethrower:
<syntaxhighlight lang="lua">lead_target_for_projectile_speed = 0.2* 0.75 * 1.5, -- this is same as particle horizontal speed of flamethrower fire stream</syntaxhighlight>

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

'''Default''': <code>cooldown</code>

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

'''Default''': 1

=== ammo_type ===
'''Type''': [[Types/AmmoType]]

Can be mandatory.

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

'''Default''': "shoot"

One of "shoot", "throw", "consume" or "activate". Used in tooltips to set the tooltip category. It is also used to get the locale keys for activation instructions and speed of the action for the tooltip.

For example, an activation_type of "throw" will result in the tooltip category "thrown" and the tooltip locale keys "gui.instruction-to-throw" and "description.throwing-speed".

=== sound ===
'''Type''': [[Types/LayeredSound]]

Played once at the start of the attack if this is a [[Types/ProjectileAttackParameters]].

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

=== cyclic_sound ===
'''Type''': [[Types/CyclicSound]]

Played during the attack.

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

'''Default''': false

=== ammo_categories ===
'''Type''': [[Types/table]] (array) of [[Types/string]]

Names of [[Prototype/AmmoCategory]].

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

The name of a [[Prototype/AmmoCategory]]. Mandatory if <code>ammo_type</code> and <code>ammo_categories</code> is not given, otherwise ignored.

Prototype/Character

2022-12-22T11:06:08Z

Curiosity: Some people in Discord have found this unclear

{{Prototype parent|Prototype/EntityWithOwner}}
Entity that you move around on the screen during the campaign and freeplay.

{{Prototype TOC|character}}

== Mandatory properties ==
Inherits all properties from [[Prototype/EntityWithOwner]].

{{Prototype property|mining_speed|[[Types/double|double]]}}

{{Prototype property|running_speed|[[Types/double|double]]}}

{{Prototype property|distance_per_frame|[[Types/double|double]]}}

{{Prototype property|maximum_corner_sliding_distance|[[Types/double|double]]}}

{{Prototype property|heartbeat|[[Types/Sound|Sound]]}}
The sound file played when the character's health is low.

{{Prototype property|eat|[[Types/Sound|Sound]]}}
The sound file played when the character eats (fish for example).

{{Prototype property|inventory_size|[[Types/ItemStackIndex|ItemStackIndex]]}}
Number of slots in the main inventory. May be 0.

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

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

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

{{Prototype property|reach_resource_distance|[[Types/double|double]]}}

{{Prototype property|item_pickup_distance|[[Types/double|double]]}}

{{Prototype property|loot_pickup_distance|[[Types/double|double]]}}

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

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

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

{{Prototype property|damage_hit_tint|[[Types/Color|Color]]}}

{{Prototype property|running_sound_animation_positions|[[Types/table|table]] of [[Types/float|float]]}}
List of positions in the running animation when the walking sound is played.
running_sound_animation_positions = {14, 29}

{{Prototype property|mining_with_tool_particles_animation_positions|[[Types/table|table]] of [[Types/float|float]]}}
List of positions in the mining with tool animation when the mining sound and mining particles are created.
mining_with_tool_particles_animation_positions = {28}

{{Prototype property|animations|[[Types/table|table]] of [[Types/CharacterArmorAnimation|CharacterArmorAnimation]]}}

== Optional properties ==

{{Prototype property|crafting_categories|[[Types/table|table]] of [[Types/string|string]]|empty table|optional=true}}
Names of the crafting categories the character can craft recipes from. The built-in categories can be found [[Data.raw#recipe-category|here]]. See also [[Prototype/RecipeCategory]].

{{Prototype property|mining_categories |[[Types/table|table]] of [[Types/string|string]]|empty table|optional=true}}
Names of the resource categories the character can mine resources from.

{{Prototype property|light|[[Types/LightDefinition|LightDefinition]]|optional=true}}

{{Prototype property|enter_vehicle_distance|[[Types/double|double]]|3.0|optional=true}}
Must be >= 0.

{{Prototype property|tool_attack_distance|[[Types/double|double]]|1.5|optional=true}}

{{Prototype property|respawn_time|[[Types/uint32|uint32]]|10|optional=true}}
Time in seconds. Must be positive

{{Prototype property|has_belt_immunity|[[Types/bool|bool]]|false|optional=true}}
Whether this character is moved by belts when standing on them.

{{Prototype property|character_corpse|[[Types/string|string]]|optional=true}}
Name of the character corpse that is spawned when this character dies.

{{Prototype property|footstep_particle_triggers|[[Types/FootstepTriggerEffectList|FootstepTriggerEffectList]]|optional=true}}
Triggered every tick of the running animation.

{{Prototype property|synced_footstep_particle_triggers|[[Types/FootstepTriggerEffectList|FootstepTriggerEffectList]]|optional=true}}
Triggered when the running animation ([[#animations]]) rolls over the frames defined in <code>right_footprint_frames</code> and <code>left_footprint_frames</code>.

{{Prototype property|footprint_particles|[[Types/table|table]] of [[Types/FootprintParticle|FootprintParticle]]|optional=true}}
Array of footprint particles. Triggered when the running animation ([[#animations]]) rolls over the frames defined in <code>right_footprint_frames</code> and <code>left_footprint_frames</code>.

{{Prototype property|left_footprint_offset|[[Types/vector|vector]]|optional=true}}
Offset from the center of the entity for the left footprint. Used by <code>footprint_particles</code>.

{{Prototype property|right_footprint_offset|[[Types/vector|vector]]|optional=true}}
Offset from the center of the entity for the right footprint. Used by <code>footprint_particles</code>.

{{Prototype property|right_footprint_frames|[[Types/table|table]] of [[Types/float|float]]|optional=true}}
An array of [[Types/float|float]]. The frames in the running animation ([[#animations]]) where the right foot touches the ground.

{{Prototype property|left_footprint_frames|[[Types/table|table]] of [[Types/float|float]]|optional=true}}
An array of [[Types/float|float]]. The frames in the running animation ([[#animations]]) where the left foot touches the ground.

{{Prototype property|tool_attack_result|[[Types/Trigger|Trigger]]|optional=true}}

Prototype/RocketSilo

2022-06-29T17:13:01Z

Curiosity: Document missing properties (see https://forums.factorio.com/viewtopic.php?f=65&t=92227 )

{{Prototype parent|Prototype/AssemblingMachine}}
A [[rocket silo]].

{{Prototype TOC|rocket-silo}}

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

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

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

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

{{Prototype property|lamp_energy_usage|[[Types/Energy|Energy]]}}
May be 0.

{{Prototype property|rocket_entity|[[Types/string|string]]}}
Name of a [[Prototype/RocketSiloRocket]].

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{{Prototype property|hole_clipping_box|[[Types/BoundingBox|BoundingBox]]}}

{{Prototype property|door_back_open_offset|[[Types/vector|vector]]}}

{{Prototype property|door_front_open_offset|[[Types/vector|vector]]}}

{{Prototype property|silo_fade_out_start_distance|[[Types/double|double]]}}

{{Prototype property|silo_fade_out_end_distance|[[Types/double|double]]}}

{{Prototype property|times_to_blink|[[Types/uint8|uint8]]}}

{{Prototype property|light_blinking_speed|[[Types/double|double]]}}

{{Prototype property|door_opening_speed|[[Types/double|double]]}}

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

== Optional properties ==

{{Prototype property|base_night_sprite|[[Types/Sprite|Sprite]]|optional=true}}

{{Prototype property|base_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}

{{Prototype property|base_engine_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}

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

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

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

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

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

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

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

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

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

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

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

{{Prototype property|rocket_result_inventory_size|[[Types/ItemStackIndex|ItemStackIndex]]|0|optional=true}}

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

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

Prototype/CustomInput

2022-05-27T16:32:22Z

Curiosity: Checking in game, some game controls are invalid. There's also one new, based on locale strings.

{{Prototype parent|PrototypeBase}}
Used for custom keyboard shortcuts/keybindings in mods. The key associated with the custom input can be changed in the options. This means that <code>key_sequence</code> is simply the default keybinding.

{{Prototype TOC|custom-input}}

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

=== name ===
:''See [[PrototypeBase#name]]''

Inherited from [[PrototypeBase]]. It is also the name for the event that is raised when they key (combination) is pressed and action is "lua", see [[Tutorial:Script interfaces]].

{{Prototype property|key_sequence|[[Types/string|string]]}}
The default key sequence for this custom input.

* "" (empty string) for unassigned
* "mouse-button-2" etc for mouse buttons, mouse-button-3 for middle mouse button
* "mouse-wheel-up", "mouse-wheel-down", "mouse-wheel-left", "mouse-wheel-right" for mouse wheel
* " + " is used to separate modifier keys from normal keys: <code>"ALT + G"</code>
* For modifier keys, the following names are used: "CONTROL", "SHIFT", "ALT", "COMMAND"
* A keybinding can contain an unlimited amount of modifier keys (listed above) but only one normal key (listed below).

<div class="toccolours mw-collapsible mw-collapsed" style="width: 40em;">
These names are available for the normal keys
<pre class="mw-collapsible-content">
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
1
2
3
4
5
6
7
8
9
0
RETURN
ESCAPE
BACKSPACE
TAB
SPACE
MINUS
EQUALS
LEFTBRACKET
RIGHTBRACKET
BACKSLASH
NONUSHASH
SEMICOLON
APOSTROPHE
GRAVE
COMMA
PERIOD
SLASH
CAPSLOCK
F1
F2
F3
F4
F5
F6
F7
F8
F9
F10
F11
F12
PRINTSCREEN
SCROLLLOCK
PAUSE
INSERT
HOME
PAGEUP
DELETE
END
PAGEDOWN
RIGHT
LEFT
DOWN
UP
NUMLOCKCLEAR
KP_DIVIDE
KP_MULTIPLY
KP_MINUS
KP_PLUS
KP_ENTER
KP_1
KP_2
KP_3
KP_4
KP_5
KP_6
KP_7
KP_8
KP_9
KP_0
KP_PERIOD
NONUSBACKSLASH
APPLICATION
POWER
KP_EQUALS
F13
F14
F15
F16
F17
F18
F19
F20
F21
F22
F23
F24
EXECUTE
HELP
MENU
SELECT
STOP
AGAIN
UNDO
CUT
COPY
PASTE
FIND
MUTE
VOLUMEUP
VOLUMEDOWN
KP_COMMA
KP_EQUALSAS400
INTERNATIONAL1
INTERNATIONAL2
INTERNATIONAL3
INTERNATIONAL4
INTERNATIONAL5
INTERNATIONAL6
INTERNATIONAL7
INTERNATIONAL8
INTERNATIONAL9
LANG1
LANG2
LANG3
LANG4
LANG5
LANG6
LANG7
LANG8
LANG9
ALTERASE
SYSREQ
CANCEL
CLEAR
PRIOR
RETURN2
SEPARATOR
OUT
OPER
CLEARAGAIN
CRSEL
EXSEL
KP_00
KP_000
THOUSANDSSEPARATOR
DECIMALSEPARATOR
CURRENCYUNIT
CURRENCYSUBUNIT
KP_LEFTPAREN
KP_RIGHTPAREN
KP_LEFTBRACE
KP_RIGHTBRACE
KP_TAB
KP_BACKSPACE
KP_A
KP_B
KP_C
KP_D
KP_E
KP_F
KP_XOR
KP_POWER
KP_PERCENT
KP_LESS
KP_GREATER
KP_AMPERSAND
KP_DBLAMPERSAND
KP_VERTICALBAR
KP_DBLVERTICALBAR
KP_COLON
KP_HASH
KP_SPACE
KP_AT
KP_EXCLAM
KP_MEMSTORE
KP_MEMRECALL
KP_MEMCLEAR
KP_MEMADD
KP_MEMSUBTRACT
KP_MEMMULTIPLY
KP_MEMDIVIDE
KP_PLUSMINUS
KP_CLEAR
KP_CLEARENTRY
KP_BINARY
KP_OCTAL
KP_DECIMAL
KP_HEXADECIMAL
LCTRL
LSHIFT
LALT
LGUI
RCTRL
RSHIFT
RALT
RGUI
MODE
AUDIONEXT
AUDIOPREV
AUDIOSTOP
AUDIOPLAY
AUDIOMUTE
MEDIASELECT
WWW
MAIL
CALCULATOR
COMPUTER
AC_SEARCH
AC_HOME
AC_BACK
AC_FORWARD
AC_STOP
AC_REFRESH
AC_BOOKMARKS
BRIGHTNESSDOWN
BRIGHTNESSUP
DISPLAYSWITCH
KBDILLUMTOGGLE
KBDILLUMDOWN
KBDILLUMUP
EJECT
SLEEP
APP1
APP2
AUDIOREWIND
AUDIOFASTFORWARD
</pre>
</div>

== Optional properties ==

{{Prototype property|alternative_key_sequence|[[Types/string|string]]|optional=true}}
The alternative keybinding for this control. See [[#key_sequence]].

{{Prototype property|linked_game_control|[[Types/string|string]]|""|optional=true}}
When a custom-input is linked to a game control it won't show up in the control-settings GUI and will fire when the linked control is pressed. [https://forums.factorio.com/53591]

<div class="toccolours mw-collapsible mw-collapsed" style="width: 40em;">
List of internal names of game controls
<pre class="mw-collapsible-content">
action-bar-select-page-1
action-bar-select-page-10
action-bar-select-page-2
action-bar-select-page-3
action-bar-select-page-4
action-bar-select-page-5
action-bar-select-page-6
action-bar-select-page-7
action-bar-select-page-8
action-bar-select-page-9
activate-tooltip
add-station
add-temporary-station
alt-zoom-in
alt-zoom-out
build
build-ghost
build-with-obstacle-avoidance
cancel-craft
cancel-craft-5
cancel-craft-all
clear-cursor
confirm-gui
confirm-message
connect-train
controller-gui-crafting-tab
controller-gui-logistics-tab
copy
copy-entity-settings
craft
craft-5
craft-all
cursor-split
cut
cycle-blueprint-backwards
cycle-blueprint-forwards
cycle-clipboard-backwards
cycle-clipboard-forwards
debug-reset-zoom
debug-reset-zoom-2x
debug-toggle-atlas-gui
debug-toggle-basic
debug-toggle-debug-settings
decrease-ui-scale
disconnect-train
drag-map
drop-cursor
editor-clone-item
editor-delete-item
editor-next-variation
editor-previous-variation
editor-remove-scripting-object
editor-reset-speed
editor-set-clone-brush-destination
editor-set-clone-brush-source
editor-speed-down
editor-speed-up
editor-switch-to-surface
editor-tick-once
editor-toggle-pause
fast-entity-split
fast-entity-transfer
flip-blueprint-horizontal
flip-blueprint-vertical
focus-search
increase-ui-scale
inventory-split
inventory-transfer
larger-terrain-building-area
logistic-networks
mine
move-down
move-left
move-right
move-up
next-active-quick-bar
next-player-in-replay
next-weapon
open-character-gui
open-gui
open-item
open-prototype-explorer-gui
open-prototypes-gui
open-technology-gui
open-trains-gui
order-to-follow
paste
paste-entity-settings
pause-game
pick-item
pick-items
place-in-chat
place-ping
previous-active-quick-bar
previous-mod
previous-technology
production-statistics
quick-bar-button-1
quick-bar-button-1-secondary
quick-bar-button-10
quick-bar-button-10-secondary
quick-bar-button-2
quick-bar-button-2-secondary
quick-bar-button-3
quick-bar-button-3-secondary
quick-bar-button-4
quick-bar-button-4-secondary
quick-bar-button-5
quick-bar-button-5-secondary
quick-bar-button-6
quick-bar-button-6-secondary
quick-bar-button-7
quick-bar-button-7-secondary
quick-bar-button-8
quick-bar-button-8-secondary
quick-bar-button-9
quick-bar-button-9-secondary
remove-pole-cables
reset-ui-scale
reverse-rotate
reverse-select
rotate
rotate-active-quick-bars
select-for-blueprint
select-for-cancel-deconstruct
shoot-enemy
shoot-selected
show-info
smaller-terrain-building-area
smart-pipette
stack-split
stack-transfer
toggle-blueprint-library
toggle-console
toggle-driving
toggle-filter
toggle-gui-debug
toggle-gui-glows
toggle-gui-shadows
toggle-gui-style-view
toggle-map
toggle-menu
undo
zoom-in
zoom-out
</pre></div>

Example to use the same key sequence as the clear-cursor hotkey:
<syntaxhighlight lang="lua">key_sequence = ""
linked_game_control = "clear-cursor"</syntaxhighlight>

'''Note''': The CustomInputEvent occurs before the game control.

{{Prototype property|consuming|[[Types/ConsumingType|ConsumingType]]|"none"|optional=true}}

{{Prototype property|enabled|[[Types/bool|bool]]|true|optional=true}}
If this custom input is enabled. Disabled custom inputs exist but are not used by the game. If disabled, no event is raised when the input is used.

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

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

{{Prototype property|include_selected_prototype|[[Types/bool|bool]]|false|optional=true}}
If true, the type and name of the currently selected prototype will be provided as "selected_prototype" in the raised [https://lua-api.factorio.com/latest/events.html#Custom%20Input%20Events lua event]. This also works in GUI's, not just the game world.[https://forums.factorio.com/96125]

'''Note:''' This will also return an item in the cursor (or item of a ghost in cursor) such as copper-wire or rail-planner, if nothing is beneath the cursor.

{{Prototype property|item_to_spawn|[[Types/string|string]]|optional=true}}
Name of a [[Prototype/Item]]. It will be created when this input is pressed and action is set to "spawn-item". The item must have the [[Types/ItemPrototypeFlags#.22spawnable.22|"spawnable"]] flag set.

{{Prototype property|action|[[Types/string|string]]|"lua"|optional=true}}
One of "lua", "spawn-item", "toggle-personal-roboport", "toggle-personal-logistic-requests" and "toggle-equipment-movement-bonus".

A [https://lua-api.factorio.com/latest/events.html#Custom%20Input%20Events lua event] is only raised if the action is "lua".

Prototype/Generator

2022-04-16T07:18:33Z

Curiosity: explain effectivity better

{{Prototype parent|Prototype/EntityWithOwner}}
An entity that produces power from fluids, for example a [[steam engine]].

{{Prototype TOC|generator}}

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

{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
Must be an electric energy source.

{{Prototype property|fluid_box|[[Types/FluidBox|FluidBox]]}}
This must have a filter if <code>max_power_output</code> is not defined.

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

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

{{Prototype property|effectivity|[[Types/double|double]]}}
How much energy the generator produces compared to how much energy it consumes.

{{Prototype property|fluid_usage_per_tick|[[Types/double|double]]}}
The number of fluid units the generator uses per tick.

{{Prototype property|maximum_temperature|[[Types/double|double]]}}
Used to calculate the <code>max_power_output</code> if it is not defined and <code>burns_fluid</code> is false. Then, the max power output is <code>(min(fluid_max_temp, maximum_temperature) - fluid_default_temp) × fluid_usage_per_tick × fluid_heat_capacity × effectivity</code>, the fluid is the filter specified on the <code>fluid_box</code>.

The maximum temperature to which the efficiency can increase. At this temperature the generator will run at 100% efficiency. Note: Higher temperature fluid can still be consumed.

== Optional properties ==

{{Prototype property|smoke|[[Types/table|table]] of [[Types/SmokeSource|SmokeSource]]|optional=true}}
Array of 1 or more smoke sources.

{{Prototype property|burns_fluid|[[Types/bool|bool]]|false|optional=true}}
If set to true, the available power output is based on the [[Prototype/Fluid#fuel_value|fuel_value]] of the fluid. Otherwise, the available power output will be based on the fluid temperature.

{{Prototype property|scale_fluid_usage|[[Types/bool|bool]]|false|optional=true}}
Scales the generator's fluid usage to its maximum power output.

Setting this to true prevents the generator from overconsuming fluid, for example when higher than <code>maximum_temperature</code> fluid is fed to the generator.<br>
If scale_fluid_usage is false, the generator consumes the full <code>fluid_usage_per_tick</code> and any of the extra energy in the fluid (in the form of higher temperature) is wasted. The [[steam engine]] exhibits this behavior when fed steam from [[heat exchanger]]s.

{{Prototype property|destroy_non_fuel_fluid|[[Types/bool|bool]]|true|optional=true}}
This property is used when:
* <code>burns_fluid</code> is true and the fluid has a [[Prototype/Fluid#fuel_value|fuel_value]] of 0
* or <code>burns_fluid</code> is false and the fluid is at default temperature
In these cases, this property determines whether the fluid should be destroyed, meaning that the fluid is consumed at the rate of <code>fluid_usage_per_tick</code>, without producing any power.

{{Prototype property|min_perceived_performance|[[Types/double|double]]|0.25|optional=true}}
Animation runs at least this fast. This corresponds to the sound.

{{Prototype property|performance_to_sound_speedup|[[Types/double|double]]|0.5|optional=true}}

{{Prototype property|max_power_output|[[Types/Energy|Energy]]|optional=true}}
The power production of the generator is capped to this value. This is also the value that is shown as the maximum power output in the tooltip of the generator.

<code>fluid_box</code> must have a filter if this is not defined.

Prototype/TransportBeltConnectable

2022-03-18T19:11:44Z

Curiosity: missing word

{{Prototype parent|Prototype/EntityWithOwner}}
Abstract class that anything that is a belt or can connect to belts uses.

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

== Extensions ==

* [[Prototype/LinkedBelt]] '''linked-belt'''
* [[Prototype/Loader1x1]] '''loader-1x1'''
* [[Prototype/Loader1x2]] '''loader'''
* [[Prototype/Splitter]] '''splitter'''
* [[Prototype/TransportBelt]] '''transport-belt'''
* [[Prototype/UndergroundBelt]] '''underground-belt'''

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

{{Prototype property|speed|[[Types/double|double]]}}
The speed of the belt (since 0.17): <code>speed × 480 = x Items/second</code>

The raw value is expressed as the number of tiles traveled by each item on the belt per tick, relative to the belt's maximum density - e.g. <code>x items/second ÷ (4 items/lane × 2 lanes/belt × 60 ticks/second) = <speed> belts/tick</code> where a "belt" is the size of one tile. See [[Transport_belts/Physics]] for more details.

== Optional properties ==

{{Prototype property|animation_speed_coefficient|[[Types/double|double]]|1|optional=true}}

{{Prototype property|belt_animation_set|[[Types/table|table]]|optional=true}}
Either this, or all of the properties below this one have to be present.

Table with the following properties:

* animation_set - [[Types/RotatedAnimation|RotatedAnimation]] - Mandatory.
* east_index - [[Types/uint8|uint8]] - Optional. - Default: 1
* west_index - [[Types/uint8|uint8]] - Optional. - Default: 2
* north_index - [[Types/uint8|uint8]] - Optional. - Default: 3
* south_index - [[Types/uint8|uint8]] - Optional. - Default: 4
* starting_south_index - [[Types/uint8|uint8]] - Optional. - Default: 13
* ending_south_index - [[Types/uint8|uint8]] - Optional. - Default: 14
* starting_west_index - [[Types/uint8|uint8]] - Optional. - Default: 15
* ending_west_index - [[Types/uint8|uint8]] - Optional. - Default: 16
* starting_north_index - [[Types/uint8|uint8]] - Optional. - Default: 17
* ending_north_index - [[Types/uint8|uint8]] - Optional. - Default: 18
* starting_east_index - [[Types/uint8|uint8]] - Optional. - Default: 19
* ending_east_index - [[Types/uint8|uint8]] - Optional. - Default: 20
* ending_patch - [[Types/Sprite4Way|Sprite4Way]] - Optional.
* ends_with_stopper - [[Types/bool|bool]] - Optional. - Default: false

{{Prototype property|belt_horizontal|[[Types/Animation|Animation]]|optional=true}}
Mandatory if <code>belt_animation_set</code> is not present.

{{Prototype property|belt_vertical|[[Types/Animation|Animation]]|optional=true}}
Mandatory if <code>belt_animation_set</code> is not present.

{{Prototype property|ending_top|[[Types/Animation|Animation]]|optional=true}}
Mandatory if <code>belt_animation_set</code> is not present.

{{Prototype property|ending_bottom|[[Types/Animation|Animation]]|optional=true}}
Mandatory if <code>belt_animation_set</code> is not present.

{{Prototype property|ending_side|[[Types/Animation|Animation]]|optional=true}}
Mandatory if <code>belt_animation_set</code> is not present.

{{Prototype property|starting_top|[[Types/Animation|Animation]]|optional=true}}
Mandatory if <code>belt_animation_set</code> is not present.

{{Prototype property|starting_bottom|[[Types/Animation|Animation]]|optional=true}}
Mandatory if <code>belt_animation_set</code> is not present.

{{Prototype property|starting_side|[[Types/Animation|Animation]]|optional=true}}
Mandatory if <code>belt_animation_set</code> is not present.

{{Prototype property|ending_patch|[[Types/Sprite4Way|Sprite4Way]]|optional=true}}
Always optional. Only read if <code>belt_animation_set</code> is not present.

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

== Mandatory values ==
Transport belt connectables have additional requirements for the properties inherited from [[Prototype/Entity]]:
* Transport belt connectable entities must collide with [[Types/CollisionMask#Layers|"transport-belt-layer"]].
* Transport belt connectable entities must have [[Types/CollisionMask#Collision_options|collision mask]] that collides with itself.
* Transport belt connectable entities cannot have collision mask that collides only with tiles (must collide with entities in some way).
* Transport belt connectable entities must have collision box of an appropriate minimal size, they should occupy more than half of every tile the entity covers.
* Transport belt connectable entities cannot have the [[Types/EntityPrototypeFlags#.22placeable-off-grid.22|"placeable-off-grid"]] flag specified.