Prototype/CraftingMachine: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
m (grammar)
(Removed old prototype docs)
Tag: Replaced
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Prototype parent|Prototype/EntityWithHealth}}
<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/CraftingMachinePrototype.html https://lua-api.factorio.com/latest/prototypes/CraftingMachinePrototype.html]
The abstract basis of the assembling machines and furnaces. Contains the properties that both of them have.


Note that a crafting machine cannot be rotated unless it has at least one of the following: a fluid box, a heat energy source, a fluid energy source, or a non-square collision box. Crafting machines with non-square collision boxes can only be rotated before placement, not after.
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
 
{{Prototype TOC|''abstract''}}
 
== Extensions ==
 
* [[Prototype/AssemblingMachine]] '''assembling-machine'''
** [[Prototype/RocketSilo]] '''rocket-silo'''
* [[Prototype/Furnace]] '''furnace'''
 
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].
 
{{Prototype property|energy_usage|[[Types/Energy|Energy]]}}
Sets how much energy this machine uses while crafting. Energy usage has to be positive.
 
{{Prototype property|crafting_speed|[[Types/double|double]]}}
How fast this crafting machine can craft. 1 means that for example a 1 second long recipe take 1 second to craft. 0.5 means it takes 2 seconds, and 2 means it takes 0.5 seconds.
 
Crafting speed has to be positive.
 
{{Prototype property|crafting_categories|[[Types/table|table]] of [[Types/string|string]]s}}
A list of [[Prototype/RecipeCategory|recipe categories]] this crafting machine can use.
 
Example:
<pre>
crafting_categories = {"crafting", "smelting"}
</pre>
 
{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
Defines how the crafting machine is powered.
 
When using an electric energy source and <code>drain</code> is not specified, it will be set to <code>energy_usage ÷ 30</code> automatically.
 
== Optional properties ==
 
{{Prototype property|animation|[[Types/Animation4Way|Animation4Way]]|optional=true}}
The animation played when crafting. When the crafting machine is idle, the animation will be paused.
 
When a crafting machine cannot be rotated, only the north rotation of the animation will be used.
 
{{Prototype property|idle_animation|[[Types/Animation4Way|Animation4Way]]|optional=true}}
Idle animation must have the same frame count as animation. It is used for drawing the machine in idle state, but the is animation frozen on a single frame when the machine is idle.<br>
This is an animation and not just sprite to make it possible for idle state and working state to match their visuals when the machine switches from one state to another.
 
When a crafting machine cannot be rotated, only the north rotation of the idle animation will be used.
 
{{Prototype property|fluid_boxes|[[Types/table|table]] of [[Types/FluidBox|FluidBox]]|optional=true}}
Can have off_when_no_fluid_recipe key that has a [[Types/bool|bool]] value. off_when_no_fluid_recipe defaults to false. off_when_no_fluid_recipe is ignored by [[Prototype/Furnace]]s and considered to always be false.
 
If a crafting machine has fluid boxes ''and'' off_when_no_fluid_recipe is true, the crafting machine can only be rotated when a recipe consuming or producing fluid is set, or it has one of the other properties listed at the top of the page.
 
<syntaxhighlight lang="lua">fluid_boxes =
    {
      {
        production_type = "input",
        pipe_picture = assembler2pipepictures(),
        pipe_covers = pipecoverspictures(),
        base_area = 10,
        base_level = -1,
        pipe_connections = {{ type="input", position = {0, -2} }},
        secondary_draw_orders = { north = -1 }
      },
      {
        production_type = "output",
        pipe_picture = assembler2pipepictures(),
        pipe_covers = pipecoverspictures(),
        base_area = 10,
        base_level = 1,
        pipe_connections = {{ type="output", position = {0, 2} }},
        secondary_draw_orders = { north = -1 }
      },
      off_when_no_fluid_recipe = true
    },</syntaxhighlight>
 
{{Prototype property|allowed_effects|[[Types/EffectTypeLimitation|EffectTypeLimitation]]|optional=true}}
Sets the module effects that are allowed to be used on this machine.
 
{{Prototype property|scale_entity_info_icon|[[Types/bool|bool]]|false|optional=true}}
Whether the "alt-mode icon" should be scaled to the size of the machine.
 
{{Prototype property|show_recipe_icon|[[Types/bool|bool]]|true|optional=true}}
Whether the "alt-mode icon" should be drawn at all.
 
{{Prototype property|always_draw_idle_animation|[[Types/bool|bool]]|false|optional=true}}
 
{{Prototype property|default_recipe_tint|[[Types/table|table]] of [[Types/Color|Color]]|optional=true}}
Format:
<syntaxhighlight lang="lua">crafting_machine_tint = { primary = {r=1,g=1,b=1,a=1}, secondary = {r=1,g=1,b=1,a=1}, tertiary = {r=1,g=1,b=1,a=1}, quaternary = {r=1,g=1,b=1,a=1}}</syntaxhighlight>
Each key/value pair is optional and defaults to the above value.
 
{{Prototype property|return_ingredients_on_change|[[Types/bool|bool]]|false|optional=true}}
Controls whether the ingredients of an in-progress recipe are destroyed when mining the machine/changing the recipe. If set to true, the ingredients do not get destroyed. This affects only the ingredients of the recipe that is currently in progress, so those that visually have already been consumed while their resulting product has not yet been produced.
 
{{Prototype property|entity_info_icon_shift|[[Types/vector|vector]]|<nowiki>{0, -0.3}</nowiki> for [[Prototype/AssemblingMachine]] and <nowiki>{0, -0.1}</nowiki> for [[Prototype/Furnace]]|optional=true}}
Shift of the "alt-mode icon" relative to the machine's center.
 
{{Prototype property|draw_entity_info_icon_background|[[Types/bool|bool]]|true|optional=true}}
Whether the "alt-mode icon" should have a black background.
 
{{Prototype property|match_animation_speed_to_activity|[[Types/bool|bool]]|false|optional=true}}
Whether the speed of the animation and working visualization should be based on the machine's speed (boosted or slowed by modules).
 
{{Prototype property|base_productivity|[[Types/float|float]]|0|optional=true}}
Productivity bonus that this machine always has.
 
{{Prototype property|module_specification|[[Types/ModuleSpecification|ModuleSpecification]]|optional=true}}
The number of module slots in this machine, and their icon positions.
 
<syntaxhighlight lang="lua">module_specification = {
  module_info_icon_shift = {
    0,
    0.8
  },
  module_slots = 2
},</syntaxhighlight>
 
{{Prototype property|working_visualisations|[[Types/table|table]] of [[Types/WorkingVisualisation|WorkingVisualisation]]|optional=true}}

Latest revision as of 14:32, 25 October 2024

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

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

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/CraftingMachine&oldid=202865"