Official Factorio Wiki - User contributions [en]

Types/EnergySource

2020-09-17T19:49:30Z

Raiguard: /* Electric energy source */ Remove inaccurate info

== Basics ==
Specifies the way the entity gets its energy.
=== type ===
'''Type''': [[Types/string]]

Mandatory. Only valid values are "electric", "burner", "heat", "fluid" or "void", it specifies the type of the energy source to be used.

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

'''Default''': 0

Optional. The pollution an entity emits per minute at full energy consumption. <code>emissions_per_minute</code> is exactly the value that is shown in the entity tooltip.

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

'''Default''': true

Optional. Whether to render the [[File:Electricity-icon-red.png|50px]] icon on the entity if it is low on power. Also applies to [[File:Fuel-icon-red.png|50px]] when using a burner energy source.

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

'''Default''': true

Optional. Whether to render the [[File:Electricity-icon-unplugged.png|50px]] icon on the entity if it is not connected to a electric network.

== Electric energy source ==
=== buffer_capacity ===
'''Type''': [[Types/Energy]]

Optional. How much power the entity holds.
=== usage_priority ===
'''Type''': [[Types/ElectricUsagePriority]]

Mandatory.
=== input_flow_limit ===
'''Type''': [[Types/Energy]]

'''Default''': max double

Optional. How fast the energy can flow into the entity. 0 means 0.
=== output_flow_limit ===
'''Type''': [[Types/Energy]]

'''Default''': max double

Optional. How fast the energy can flow out of the entity. 0 means 0.

=== drain ===
'''Type''': [[Types/Energy]]

Optional. How much energy the entity will "drain" from the network when not in use.

== Burner ==
=== fuel_inventory_size ===
'''Type''': [[Types/ItemStackIndex]]

Mandatory.

=== burnt_inventory_size ===
'''Type''': [[Types/ItemStackIndex]]

'''Default''': 0

Optional.

=== smoke ===
'''Type''': [[Types/table]] of [[Types/SmokeSource]]

Optional. Array of 1 or more smoke sources.

=== light_flicker ===
'''Type''': [[Types/LightFlickeringDefinition]]

Optional.

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

'''Default''': 1

Optional. 1 means 100% effectivity. Must be greater than 0. Multiplier of the energy output.

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

'''Default''': "chemical"

Optional. The energy source can be used with fuel from this [[Prototype/FuelCategory|fuel category]]. For a list on built-in categories, see [[Data.raw#fuel-category]].

=== fuel_categories ===
'''Type''': [[Types/table]] of [[Types/string]]

Optional. Same as above, only one of them can exist. For a list on built-in categories, see [[Data.raw#fuel-category]].

== Heat energy source ==
=== max_temperature ===
'''Type''': [[Types/double]]

Mandatory. max_temperature must be >= default_temperature.

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

'''Default''': 15

Optional.

=== specific_heat ===
'''Type''': [[Types/Energy]]

Mandatory.

=== max_transfer ===
'''Type''': [[Types/Energy]]

Mandatory.

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

'''Default''': 1

Optional.

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

'''Default''': 15

Optional. min_working_temperature must be >= default_temperature. min_working_temperature must be <= max_temperature.

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

'''Default''': 1

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

Optional.

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

Optional.

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

Optional.

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

Optional.

=== connections ===
'''Type''': [[Types/table]] of [[Types/HeatConnection]]

Optional. The table may only contain up to 32 connections.

== Void energy source ==
Void is free energy, there are no additional entries required.
<syntaxhighlight lang="lua">
energy_source = {type = "void"}
</syntaxhighlight>

== Fluid energy source ==
=== fluid_box ===
'''Type''': [[Types/FluidBox]]

Mandatory.
All standard fluid box configurations are acceptable, but the type must be "input" or "input-output" to function correctly.
Scale_fluid_usage, fluid_usage_per_tick or a filter on the fluidbox must be set to be able to calculate the fluid usage of the energy source.

=== smoke ===
'''Type''': [[Types/table]] of [[Types/SmokeSource]]

Optional. Array of 1 or more smoke sources.

=== light_flicker ===
'''Type''': [[Types/LightFlickeringDefinition]]

Optional.

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

'''Default''': 1

Optional. 1 means 100% effectivity. Must be greater than 0. Multiplier of the energy output.

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

'''Default''': false

Optional. If set to true, the energy source will calculate power based on the fluid's fuel_value entry, else it will calculate based on fluid temperature, like [[Prototype/Generator]].

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

'''Default''': false

Optional. If set to true, the energy source will consume as much fluid as required to produce the desired power, if set to false it will consume as much as it is allowed to, wasting any excess.

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

'''Default''': 0

Optional. The number of fluid units the energy source uses per tick.
If used with scale_fluid_usage, this specifies the maximum. If this value is not set, scale_energy_usage = false and a fluid box filter is set, the game will attempt to calculate this value from the fluid box filter's fluid's fuel_value or heat_capacity and the entity's energy_usage. If burns_fluid is false, maximum_temperature will also be used.

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

'''Default''': unlimited

If it is specified while scale_fluid_usage = false and fluid_usage_per_tick is not specified, the game will use this value to calculate fluid_usage_per_tick.

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

Types/EnergySource

2020-09-17T19:38:34Z

Raiguard: /* Electric energy source */ Default drain.

== Basics ==
Specifies the way the entity gets its energy.
=== type ===
'''Type''': [[Types/string]]

Mandatory. Only valid values are "electric", "burner", "heat", "fluid" or "void", it specifies the type of the energy source to be used.

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

'''Default''': 0

Optional. The pollution an entity emits per minute at full energy consumption. <code>emissions_per_minute</code> is exactly the value that is shown in the entity tooltip.

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

'''Default''': true

Optional. Whether to render the [[File:Electricity-icon-red.png|50px]] icon on the entity if it is low on power. Also applies to [[File:Fuel-icon-red.png|50px]] when using a burner energy source.

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

'''Default''': true

Optional. Whether to render the [[File:Electricity-icon-unplugged.png|50px]] icon on the entity if it is not connected to a electric network.

== Electric energy source ==
=== buffer_capacity ===
'''Type''': [[Types/Energy]]

Optional. How much power the entity holds.
=== usage_priority ===
'''Type''': [[Types/ElectricUsagePriority]]

Mandatory.
=== input_flow_limit ===
'''Type''': [[Types/Energy]]

'''Default''': max double

Optional. How fast the energy can flow into the entity. 0 means 0.
=== output_flow_limit ===
'''Type''': [[Types/Energy]]

'''Default''': max double

Optional. How fast the energy can flow out of the entity. 0 means 0.

=== drain ===
'''Type''': [[Types/Energy]]

Optional. If not specified, defaults to 1/30th of the prototype's energy usage.

== Burner ==
=== fuel_inventory_size ===
'''Type''': [[Types/ItemStackIndex]]

Mandatory.

=== burnt_inventory_size ===
'''Type''': [[Types/ItemStackIndex]]

'''Default''': 0

Optional.

=== smoke ===
'''Type''': [[Types/table]] of [[Types/SmokeSource]]

Optional. Array of 1 or more smoke sources.

=== light_flicker ===
'''Type''': [[Types/LightFlickeringDefinition]]

Optional.

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

'''Default''': 1

Optional. 1 means 100% effectivity. Must be greater than 0. Multiplier of the energy output.

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

'''Default''': "chemical"

Optional. The energy source can be used with fuel from this [[Prototype/FuelCategory|fuel category]]. For a list on built-in categories, see [[Data.raw#fuel-category]].

=== fuel_categories ===
'''Type''': [[Types/table]] of [[Types/string]]

Optional. Same as above, only one of them can exist. For a list on built-in categories, see [[Data.raw#fuel-category]].

== Heat energy source ==
=== max_temperature ===
'''Type''': [[Types/double]]

Mandatory. max_temperature must be >= default_temperature.

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

'''Default''': 15

Optional.

=== specific_heat ===
'''Type''': [[Types/Energy]]

Mandatory.

=== max_transfer ===
'''Type''': [[Types/Energy]]

Mandatory.

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

'''Default''': 1

Optional.

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

'''Default''': 15

Optional. min_working_temperature must be >= default_temperature. min_working_temperature must be <= max_temperature.

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

'''Default''': 1

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

Optional.

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

Optional.

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

Optional.

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

Optional.

=== connections ===
'''Type''': [[Types/table]] of [[Types/HeatConnection]]

Optional. The table may only contain up to 32 connections.

== Void energy source ==
Void is free energy, there are no additional entries required.
<syntaxhighlight lang="lua">
energy_source = {type = "void"}
</syntaxhighlight>

== Fluid energy source ==
=== fluid_box ===
'''Type''': [[Types/FluidBox]]

Mandatory.
All standard fluid box configurations are acceptable, but the type must be "input" or "input-output" to function correctly.
Scale_fluid_usage, fluid_usage_per_tick or a filter on the fluidbox must be set to be able to calculate the fluid usage of the energy source.

=== smoke ===
'''Type''': [[Types/table]] of [[Types/SmokeSource]]

Optional. Array of 1 or more smoke sources.

=== light_flicker ===
'''Type''': [[Types/LightFlickeringDefinition]]

Optional.

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

'''Default''': 1

Optional. 1 means 100% effectivity. Must be greater than 0. Multiplier of the energy output.

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

'''Default''': false

Optional. If set to true, the energy source will calculate power based on the fluid's fuel_value entry, else it will calculate based on fluid temperature, like [[Prototype/Generator]].

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

'''Default''': false

Optional. If set to true, the energy source will consume as much fluid as required to produce the desired power, if set to false it will consume as much as it is allowed to, wasting any excess.

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

'''Default''': 0

Optional. The number of fluid units the energy source uses per tick.
If used with scale_fluid_usage, this specifies the maximum. If this value is not set, scale_energy_usage = false and a fluid box filter is set, the game will attempt to calculate this value from the fluid box filter's fluid's fuel_value or heat_capacity and the entity's energy_usage. If burns_fluid is false, maximum_temperature will also be used.

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

'''Default''': unlimited

If it is specified while scale_fluid_usage = false and fluid_usage_per_tick is not specified, the game will use this value to calculate fluid_usage_per_tick.

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

User:Raiguard/Tutorial:Modding tutorial/GUI/Style guide

2020-07-14T18:29:39Z

Raiguard: Dialog row micro

'''THIS PAGE IS A WORK IN PROGRESS'''

This style guide is designed to give you an overview of the precepts and specific element styles used to create 0.18-esque GUIs. This guide is not to be taken as gospel - the contents are merely suggestions to help you improve your interfaces.

This style guide assumes you know how to create GUIs, assign styles to elements, and edit styles. If you do not know these things, this guide won't be of much use to you.

== Window ==

[[File:GUI tutorial window types.png|Standard vs. dialog windows.]]

Windows are created using the default frame style. Because of this, you need not specify a style when creating the element.

For windows that contain multiple sub-windows (e.g. most windows that hold a character inventory) <code>outer_frame</code> is used as the outer frame and <code>inner_frame_in_outer_frame</code> is used for each internal window.

Generally there are three kinds of windows:
* '''Standard''' windows have a close button in the top-right corner, and are opened/closed manually either by clicking something or using a hotkey.
* '''Dialog''' windows have a row of dialog buttons along the bottom, and do ''not'' have a close button. These are used when there is a clear hierarchy of actions - you go "back" to the previous action, or you "confirm" the current action. These windows '''must''' have a "Back" button in the bottom-left corner, and '''may''' have a "Confirm" button in the bottom-right corner. Other buttons on the bottom row are optional and should be used sparingly.
* '''Compact''' windows have neither a titlebar nor a dialog row. These are usually mini-GUIs that are opened/closed automatically as a result of some user action. There are no set rules for these kinds of GUIs, it entirely depends on what they're used for.

=== Titlebar ===

[[File:GUI tutorial dialog types.png|Draggable vs. non-draggable windows.]]

Each non-compact window '''must''' have a titlebar. All titlebars include a '''title''', and for windows that are meant to be draggable, the titlebar includes a drag handle. '''Standard''' windows also include a close button. Other frame action buttons may be added to the left of the close button, but should be used sparingly.

Titlebars are created using a simple '''horizontal flow''' with no special edits - the default style is perfect for this case.

* The title text is a <code>label</code> using the <code>frame_title</code> style. Set <code>ignored_by_interaction</code> on this element, so the dragging functionality will work.
* The "drag handle" is an <code>empty-widget</code> element with the <code>draggable_space_header</code> style. You will need to apply <code>horizontally_stretchable</code> to the element's style, and set the <code>height</code> to <code>24</code>. If adding a close button or other frame action button, set the <code>right_margin</code> to <code>4</code>. This element also requires <code>ignored_by_interaction</code> to be true, so the dragging functionality will work.
* Close buttons, or any other frame action buttons you are adding, are created with <code>sprite-button</code> using the <code>frame_action_button</code> style. The default sprite should be colored (RGB) <code>227,227,227</code>, and the hovered and clicked sprites should be colored (RGB) <code>29,29,29</code>. Custom frame action sprites should be 26x26 with a 3px padding around the edges, making for a file size of 32x32. As of the time of writing, the base game does not use mipmaps for these icons, but it would probably be a good idea to add them to your own icons just in case.
* When creating draggable windows, <code>drag_target</code> should be set on the '''flow element''' that comprises the titlebar, not the "drag handle" itself.
* If your window is not in <code>screen</code> or is otherwise non-draggable, '''DO NOT''' add a drag handle. Instead, use an <code>empty-widget</code> with <code>horizontally_stretchable</code> enabled.

=== Content frame ===

[[File:GUI tutorial content frame with padding.png|An example of <code>inside_shallow_frame_with_padding</code>, demonstrating the built-in 12px padding.]]

Each non-compact window '''must''' have at least one "content frame" (the light grey pane seen in the above screenshots). This is where the meat of your interface will go.

Content frames are created using the <code>inside_shallow_frame_with_padding</code> style. This will give you 12px of padding in the frame. If you need to have zero padding (i.e. for adding a scroll pane or a toolbar), use <code>inside_shallow_frame</code> instead.

It is good practice to separate different "purposes" in a GUI with different content panes. For example, Recipe Book uses different content panes for search and information:

TODO add image

If you add multiple content panes, add them to a flow element with <code>horizontal_spacing</code> or <code>vertical_spacing</code> set to <code>12</code>.

=== Dialog Row ===

The dialog row is the row of buttons at the bottom of a dialog window. Generally, a window will have one or two of these, but more can be added if necessary.

The game uses a left-to-right methodology for its navigation. Therefore, the leftmost dialog button is the "back" or "cancel" action, while the rightmost is the "confirm" action. Because dialogs have an actual "confirm" action, changes to the content of the dialog should not be saved until the "confirm" button is clicked and the window closed.

TODO list styles

== Toolbar ==

Toolbars are a great place to keep a content pane's "title" as well as tools used in that pane. You can see two examples of toolbars in the Recipe Book screenshot above.

Toolbars are created using the <code>subheader_frame</code> style. There are a few locations where they are acceptable:

* At the top of an <code>inside_shallow_frame</code> (no padding)
* At the top of an <code>inside_deep_frame</code> (usually above a tabbed pane)
* Below the tab row in a tabbed pane. In this case, use a custom style TODO SHOW STYLE

User:Raiguard/Tutorial:Modding tutorial/GUI/Style guide

2020-07-10T20:55:11Z

Raiguard: Toolbar micro

'''THIS PAGE IS A WORK IN PROGRESS'''

This style guide is designed to give you an overview of the precepts and specific element styles used to create 0.18-esque GUIs. This guide is not to be taken as gospel - the contents are merely suggestions to help you improve your interfaces.

This style guide assumes you know how to create GUIs, assign styles to elements, and edit styles. If you do not know these things, this guide won't be of much use to you.

== Window ==

[[File:GUI tutorial window types.png|Standard vs. dialog windows.]]

Windows are created using the default frame style. Because of this, you need not specify a style when creating the element.

For windows that contain multiple sub-windows (e.g. most windows that hold a character inventory) <code>outer_frame</code> is used as the outer frame and <code>inner_frame_in_outer_frame</code> is used for each internal window.

Generally there are three kinds of windows:
* '''Standard''' windows have a close button in the top-right corner, and are opened/closed manually either by clicking something or using a hotkey.
* '''Dialog''' windows have a row of dialog buttons along the bottom, and do ''not'' have a close button. These are used when there is a clear hierarchy of actions - you go "back" to the previous action, or you "confirm" the current action. These windows '''must''' have a "Back" button in the bottom-left corner, and '''may''' have a "Confirm" button in the bottom-right corner. Other buttons on the bottom row are optional and should be used sparingly.
* '''Compact''' windows have neither a titlebar nor a dialog row. These are usually mini-GUIs that are opened/closed automatically as a result of some user action. There are no set rules for these kinds of GUIs, it entirely depends on what they're used for.

=== Titlebar ===

[[File:GUI tutorial dialog types.png|Draggable vs. non-draggable windows.]]

Each non-compact window '''must''' have a titlebar. All titlebars include a '''title''', and for windows that are meant to be draggable, the titlebar includes a drag handle. '''Standard''' windows also include a close button. Other frame action buttons may be added to the left of the close button, but should be used sparingly.

Titlebars are created using a simple '''horizontal flow''' with no special edits - the default style is perfect for this case.

* The title text is a <code>label</code> using the <code>frame_title</code> style. Set <code>ignored_by_interaction</code> on this element, so the dragging functionality will work.
* The "drag handle" is an <code>empty-widget</code> element with the <code>draggable_space_header</code> style. You will need to apply <code>horizontally_stretchable</code> to the element's style, and set the <code>height</code> to <code>24</code>. If adding a close button or other frame action button, set the <code>right_margin</code> to <code>4</code>. This element also requires <code>ignored_by_interaction</code> to be true, so the dragging functionality will work.
* Close buttons, or any other frame action buttons you are adding, are created with <code>sprite-button</code> using the <code>frame_action_button</code> style. The default sprite should be colored (RGB) <code>227,227,227</code>, and the hovered and clicked sprites should be colored (RGB) <code>29,29,29</code>. Custom frame action sprites should be 26x26 with a 3px padding around the edges, making for a file size of 32x32. As of the time of writing, the base game does not use mipmaps for these icons, but it would probably be a good idea to add them to your own icons just in case.
* When creating draggable windows, <code>drag_target</code> should be set on the '''flow element''' that comprises the titlebar, not the "drag handle" itself.
* If your window is not in <code>screen</code> or is otherwise non-draggable, '''DO NOT''' add a drag handle. Instead, use an <code>empty-widget</code> with <code>horizontally_stretchable</code> enabled.

=== Content frame ===

[[File:GUI tutorial content frame with padding.png|An example of <code>inside_shallow_frame_with_padding</code>, demonstrating the built-in 12px padding.]]

Each non-compact window '''must''' have at least one "content frame" (the light grey pane seen in the above screenshots). This is where the meat of your interface will go.

Content frames are created using the <code>inside_shallow_frame_with_padding</code> style. This will give you 12px of padding in the frame. If you need to have zero padding (i.e. for adding a scroll pane or a toolbar), use <code>inside_shallow_frame</code> instead.

It is good practice to separate different "purposes" in a GUI with different content panes. For example, Recipe Book uses different content panes for search and information:

TODO add image

If you add multiple content panes, add them to a flow element with <code>horizontal_spacing</code> or <code>vertical_spacing</code> set to <code>12</code>.

=== Toolbar ===

Toolbars are a great place to keep a content pane's "title" as well as tools used in that pane. You can see two examples of toolbars in the Recipe Book screenshot above.

Toolbars are created using the <code>subheader_frame</code> style. There are a few locations where they are acceptable:

* At the top of an <code>inside_shallow_frame</code> (no padding)
* At the top of an <code>inside_deep_frame</code> (usually above a tabbed pane)
* Below the tab row in a tabbed pane. In this case, use a custom style TODO SHOW STYLE

User:Raiguard/Tutorial:Modding tutorial/GUI/Style guide

2020-07-10T18:29:24Z

Raiguard: More content frame, start on toolbar

'''THIS PAGE IS A WORK IN PROGRESS'''

This style guide is designed to give you an overview of the precepts and specific element styles used to create 0.18-esque GUIs. This guide is not to be taken as gospel - the contents are merely suggestions to help you improve your interfaces.

This style guide assumes you know how to create GUIs, assign styles to elements, and edit styles. If you do not know these things, this guide won't be of much use to you.

== Window ==

[[File:GUI tutorial window types.png|Standard vs. dialog windows.]]

Windows are created using the default frame style. Because of this, you need not specify a style when creating the element.

For windows that contain multiple sub-windows (e.g. most windows that hold a character inventory) <code>outer_frame</code> is used as the outer frame and <code>inner_frame_in_outer_frame</code> is used for each internal window.

Generally there are three kinds of windows:
* '''Standard''' windows have a close button in the top-right corner, and are opened/closed manually either by clicking something or using a hotkey.
* '''Dialog''' windows have a row of dialog buttons along the bottom, and do ''not'' have a close button. These are used when there is a clear hierarchy of actions - you go "back" to the previous action, or you "confirm" the current action. These windows '''must''' have a "Back" button in the bottom-left corner, and '''may''' have a "Confirm" button in the bottom-right corner. Other buttons on the bottom row are optional and should be used sparingly.
* '''Compact''' windows have neither a titlebar nor a dialog row. These are usually mini-GUIs that are opened/closed automatically as a result of some user action. There are no set rules for these kinds of GUIs, it entirely depends on what they're used for.

=== Titlebar ===

[[File:GUI tutorial dialog types.png|Draggable vs. non-draggable windows.]]

Each non-compact window '''must''' have a titlebar. All titlebars include a '''title''', and for windows that are meant to be draggable, the titlebar includes a drag handle. '''Standard''' windows also include a close button. Other frame action buttons may be added to the left of the close button, but should be used sparingly.

Titlebars are created using a simple '''horizontal flow''' with no special edits - the default style is perfect for this case.

* The title text is a <code>label</code> using the <code>frame_title</code> style. Set <code>ignored_by_interaction</code> on this element, so the dragging functionality will work.
* The "drag handle" is an <code>empty-widget</code> element with the <code>draggable_space_header</code> style. You will need to apply <code>horizontally_stretchable</code> to the element's style, and set the <code>height</code> to <code>24</code>. If adding a close button or other frame action button, set the <code>right_margin</code> to <code>4</code>. This element also requires <code>ignored_by_interaction</code> to be true, so the dragging functionality will work.
* Close buttons, or any other frame action buttons you are adding, are created with <code>sprite-button</code> using the <code>frame_action_button</code> style. The default sprite should be colored (RGB) <code>227,227,227</code>, and the hovered and clicked sprites should be colored (RGB) <code>29,29,29</code>. Custom frame action sprites should be 26x26 with a 3px padding around the edges, making for a file size of 32x32. As of the time of writing, the base game does not use mipmaps for these icons, but it would probably be a good idea to add them to your own icons just in case.
* When creating draggable windows, <code>drag_target</code> should be set on the '''flow element''' that comprises the titlebar, not the "drag handle" itself.
* If your window is not in <code>screen</code> or is otherwise non-draggable, '''DO NOT''' add a drag handle. Instead, use an <code>empty-widget</code> with <code>horizontally_stretchable</code> enabled.

=== Content frame ===

[[File:GUI tutorial content frame with padding.png|An example of <code>inside_shallow_frame_with_padding</code>, demonstrating the built-in 12px padding.]]

Each non-compact window '''must''' have at least one "content frame" (the light grey pane seen in the above screenshots). This is where the meat of your interface will go.

Content frames are created using the <code>inside_shallow_frame_with_padding</code> style. This will give you 12px of padding in the frame. If you need to have zero padding (i.e. for adding a scroll pane or a toolbar), use <code>inside_shallow_frame</code> instead.

It is good practice to separate different "purposes" in a GUI with different content panes. For example, Recipe Book uses different content panes for search and information:

TODO add image

If you add multiple content panes, add them to a flow element with <code>horizontal_spacing</code> or <code>vertical_spacing</code> set to <code>12</code>.

=== Toolbar ===

Toolbars are a great place to keep a content pane's "title" as well as tools used in that pane. You can see two examples of toolbars in the Recipe Book screenshot above.

Toolbars are created using the <code>subheader_frame</code> style. Toolbars '''must''' be placed in a content pane with the <code>inside_shallow_frame</code> style (no padding). Toolbars always take up the entire width of the content pane they are located in.

User:Raiguard/Tutorial:Modding tutorial/GUI/Style guide

2020-07-02T05:02:16Z

Raiguard: standalone_inner_frame_in_outer_frame no longer exists

This style guide is designed to give you an overview of the precepts and specific element styles used to create 0.18-esque GUIs. This guide is not to be taken as gospel - the contents are merely suggestions to help you improve your interfaces.

This style guide assumes you know how to create GUIs, assign styles to elements, and edit styles. If you do not know these things, this guide won't be of much use to you.

== Window ==

[[File:GUI tutorial window types.png|frame|Examples of standard vs. dialog windows.]]

Windows are created using the default frame style. Because of this, you don't actually need to specify a style when creating the element.

For windows that contain multiple sub-windows (e.g. most windows that hold a character inventory) <code>outer_frame</code> is used as the outer frame and <code>inner_frame_in_outer_frame</code> is used for each internal window.

Generally there are three kinds of windows:
* '''Standard''' windows have a close button in the top-right corner, and are opened/closed manually either by clicking something or using a hotkey.
* '''Dialog''' windows have a row of dialog buttons along the bottom, and do ''not'' have a close button. These are used when there is a clear hierarchy of actions - you go "back" to the previous action, or you "confirm" the current action. These windows '''must''' have a "Back" button in the bottom-left corner, and '''may''' have a "Confirm" button in the bottom-right corner. Other buttons on the bottom row are optional and should be used sparingly.
* '''Compact''' windows have neither a titlebar nor a dialog row. These are usually mini-GUIs that are opened/closed automatically as a result of some user action. There are no set rules for these kinds of GUIs, it entirely depends on what they're used for.

=== Titlebar ===

[[File:GUI tutorial dialog types.png|frame|Draggable vs. non-draggable windows.]]

Each non-compact window '''must''' have a titlebar. All titlebars include a '''title''', and for windows that are meant to be draggable, the titlebar includes a drag handle. '''Standard''' windows also include a close button. Other frame action buttons may be added to the left of the close button, but should be used sparingly.

Titlebars are created using a simple '''horizontal flow''' with no special edits - the default style is perfect for this case.

* The title text is a <code>label</code> using the <code>frame_title</code> style.
* The "drag handle" is an <code>empty-widget</code> element with the <code>draggable_space_header</code> style. You will need to apply <code>horizontally_stretchable</code> to the element's style, and set the <code>height</code> to <code>24</code>. If adding a close button or other frame action button, set the <code>right_margin</code> to <code>4</code>.
* Close buttons, or any other frame action buttons you are adding, are created with <code>sprite-button</code> using the <code>frame_action_button</code> style. The default sprite should be colored (RGB) <code>227,227,227</code>, and the hovered and clicked sprites should be colored (RGB) <code>29,29,29</code>. Custom frame action sprites should be 26x26 with a 3px padding around the edges, making for a file size of 32x32. As of the time of writing, the base game does not use mipmaps for these icons, but it would probably be a good idea to add them to your own icons just in case.
* When creating draggable windows, <code>drag_target</code> should be set on the flow element that comprises the titlebar, not the "drag handle" itself.
* If your window is not in <code>screen</code> or is otherwise non-draggable, '''DO NOT''' add a drag handle. Instead, use an <code>empty-widget</code> with <code>horizontally_stretchable</code> enabled.

=== Content frame ===

Each non-compact window '''must''' have a "content frame" (the light grey pane seen in the above screenshots). This is where the meat of your interface will go.

Content frames are created using the <code>inside_shallow_frame_with_padding</code> style. This will give you 12px of padding in the frame. If you need to have zero padding, use <code>inside_shallow_frame</code> instead.

[[File:GUI tutorial content frame with padding.png|frame|An example of <code>inside_shallow_frame_with_padding</code>, demonstrating the built-in 12px padding.]]

'''TO BE CONTINUED'''

User:Raiguard/Tutorial:Modding tutorial/GUI/Style guide

2020-05-30T03:35:48Z

Raiguard: Rework titlebar and content frame explanations, add more images.

This style guide is designed to give you an overview of the precepts and specific element styles used to create 0.18-esque GUIs. This guide is not to be taken as gospel - the contents are merely suggestions to help you improve your interfaces.

This style guide assumes you know how to create GUIs, assign styles to elements, and edit styles. If you do not know these things, this guide won't be of much use to you.

== Window ==

[[File:GUI tutorial window types.png|frame|Examples of standard vs. dialog windows.]]

Windows are created using <code>standalone_inner_frame_in_outer_frame</code>. For windows that contain multiple sub-windows (e.g. most windows that hold a character inventory) <code>outer_frame</code> is used as the outer frame and <code>inner_frame_in_outer_frame</code> is used for each internal window.

Generally there are three kinds of windows:
* '''Standard''' windows have a close button in the top-right corner, and are opened/closed manually either by clicking something or using a hotkey.
* '''Dialog''' windows have a row of dialog buttons along the bottom, and do ''not'' have a close button. These are used when there is a clear hierarchy of actions - you go "back" to the previous action, or you "confirm" the current action. These windows '''must''' have a "Back" button in the bottom-left corner, and '''may''' have a "Confirm" button in the bottom-right corner. Other buttons on the bottom row are optional and should be used sparingly.
* '''Compact''' windows have neither a titlebar nor a dialog row. These are usually mini-GUIs that are opened/closed automatically as a result of some user action. There are no set rules for these kinds of GUIs, it entirely depends on what they're used for.

=== Titlebar ===

[[File:GUI tutorial dialog types.png|frame|Draggable vs. non-draggable windows.]]

Each non-compact window '''must''' have a titlebar. All titlebars include a '''title''', and for windows that are meant to be draggable, the titlebar includes a drag handle. '''Standard''' windows also include a close button. Other frame action buttons may be added to the left of the close button, but should be used sparingly.

Titlebars are created using a simple '''horizontal flow''' with no special edits - the default style is perfect for this case.

* The title text is a <code>label</code> using the <code>frame_title</code> style.
* The "drag handle" is an <code>empty-widget</code> element with the <code>draggable_space_header</code> style. You will need to apply <code>horizontally_stretchable</code> to the element's style, and set the <code>height</code> to <code>24</code>. If adding a close button or other frame action button, set the <code>right_margin</code> to <code>4</code>.
* Close buttons, or any other frame action buttons you are adding, are created with <code>sprite-button</code> using the <code>frame_action_button</code> style. The default sprite should be colored (RGB) <code>227,227,227</code>, and the hovered and clicked sprites should be colored (RGB) <code>29,29,29</code>. Custom frame action sprites should be 26x26 with a 3px padding around the edges, making for a file size of 32x32. As of the time of writing, the base game does not use mipmaps for these icons, but it would probably be a good idea to add them to your own icons just in case.
* When creating draggable windows, <code>drag_target</code> should be set on the flow element that comprises the titlebar, not the "drag handle" itself.
* If your window is not in <code>screen</code> or is otherwise non-draggable, '''DO NOT''' add a drag handle. Instead, use an <code>empty-widget</code> with <code>horizontally_stretchable</code> enabled.

=== Content frame ===

Each non-compact window '''must''' have a "content frame" (the light grey pane seen in the above screenshots). This is where the meat of your interface will go.

Content frames are created using the <code>inside_shallow_frame_with_padding</code> style. This will give you 12px of padding in the frame. If you need to have zero padding, use <code>inside_shallow_frame</code> instead.

[[File:GUI tutorial content frame with padding.png|frame|An example of <code>inside_shallow_frame_with_padding</code>, demonstrating the built-in 12px padding.]]

'''TO BE CONTINUED'''

User:Raiguard/Tutorial:Modding tutorial/GUI/Style guide

2020-05-29T00:39:47Z

Raiguard: Initial stub page.

This style guide is designed to give you an overview of the precepts and specific element styles used to create 0.18-esque GUIs. This guide is not to be taken as gospel - the contents are merely suggestions to help you improve your interfaces.

This style guide assumes you know how to create GUIs, assign styles to elements, and edit styles. If you do not know these things, this guide won't be of much use to you.

== Window ==

Windows are created using <code>standalone_inner_frame_in_outer_frame</code>. For windows that contain multiple sub-windows (e.g. most windows that hold a character inventory) <code>outer_frame</code> is used as the outer frame and <code>inner_frame_in_outer_frame</code> is used for each internal window.

[[File:GUI style guide window and titlebar.png]]

=== Titlebar ===

Each window should usually have a titlebar. Setting <code>caption</code> on a <code>frame</code> element will automatically create the titlebar for you. In cases where all you need is a title, this is fine.

However, for non-dialog windows, you will need to add a close button to the titlebar. This necessitates creating your own titlebar instead of using the frame's built-in one. For this reason, I usually never set <code>caption</code> on frames.

Titlebars are created using a simple '''horizontal flow''' with no special edits - the default style is perfect for this case.

* The title text is a <code>label</code> using the <code>frame_title</code> style.
* The "drag handle" is an <code>empty-widget</code> element with the <code>draggable_space_header</code> style. You will need to apply <code>horizontally_stretchable</code> to the element's style, and set the <code>height</code> to <code>24</code>. If adding a close button or other frame action button, set the <code>right_margin</code> to <code>4</code>.
* Close buttons, or any other frame action buttons you are adding, are created with <code>sprite-button</code> using the <code>frame_action_button</code> style. The default sprite should be colored (RGB) <code>227,227,227</code>, and the hovered and clicked sprites should be colored (RGB) <code>29,29,29</code>. Custom frame action sprites should be 26x26 with a 3px padding around the edges, making for a file size of 32x32. As of the time of writing, the base game does not use mipmaps for these icons, but it would probably be a good idea to add them to your own icons just in case.
* <code>drag_target</code> should be set for both the "drag handle" '''and''' the title text, to keep consistency with the base game.
* If your window is not in <code>screen</code> or is otherwise non-draggable, '''DO NOT''' add a drag handle. Instead, use an <code>empty-widget</code> with <code>horizontally_stretchable</code> enabled.

=== Content frame ===

The game's GUI style dictates that most windows should have an inner content frame, seen in the above screenshot as the light grey pane. For this, use <code>inside_shallow_frame_with_padding</code>, or <code>inside_shallow_frame</code> if you wish to manage the paddings yourself.

'''TO BE CONTINUED'''

User:Raiguard/Tutorial:Modding tutorial/GUI

2020-05-28T23:55:25Z

Raiguard: Update

'''THIS PAGE IS A WORK-IN-PROGRESS.'''

While you cannot edit base game GUIs, the Lua API includes the ability to create your own, completely custom GUIs. This tutorial will get you up to speed with creating such GUIs.

== Before you Begin ==

Be sure you have the [https://lua-api.factorio.com/latest/LuaGui.html LuaGui], [https://lua-api.factorio.com/latest/LuaGuiElement.html LuaGuiElement], and [https://lua-api.factorio.com/latest/LuaStyle.html LuaStyle] pages handy.

=== Tutorial syntax ===

This tutorial will adapt some methods from [https://wiki.factorio.com/Tutorial:Modding_tutorial/Gangsir Modding tutorial/Gangsir], namely:

<pre style="background-color:#AAFFAA!important; color:black">
Code tinted green like this should be included into the mod this tutorial is going to create; If the reader follows along with it. The best way to do this is to copy and paste, to ensure faithful reproduction.
Whenever code is added to the mod, a Lua comment with the file name will be at the beginning of the green box. Place the code in the box into that file. Eg:
--control.lua
</pre>

<pre style="background-color:#DDA0DD!important; color:black">
Code tinted purple like this should not be included into the mod, it's just for educational/example purposes, and to boost understanding.
</pre>

For the purposes of the tutorial, it would be a good idea to create a fresh mod, separate from the mod you created in Gangsir's tutorial.

=== In-game tool: GUI border view ===

[[File:Modding tutorial Ctrl F5.png|500px]]

Hitting '''Control + F5''' on your keyboard will bring up the "GUI border view". This surrounds all GUI elements with red borders, and can help you visualize how things are laid out.

=== In-game tool: GUI style inspector ===

[[File:Modding tutorial Ctrl F6.png]]

Hitting '''Control + F6''' on your keyboard will allow you to use the "GUI style inspector". This allows you to view an element's style inheritances when you hover over it. Combined with the GUI border view, you can inspect normally hidden GUI elements.

=== Library: mod-gui ===

Add this require into your script file before you begin:

<pre style="background-color:#AAFFAA!important; color:black">
-- control.lua
local mod_gui = require("__core__.lualib.mod-gui")
</pre>

== The Root ==

To build a GUI, you must gain access to the GUI "root". The most common method of access is through [https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.gui LuaPlayer::gui]:

<pre style="background-color:#AAFFAA!important; color:black">
-- control.lua
script.on_event(defines.events.on_player_created, function(event)
local player = game.get_player(event.player_index)
local player_gui = player.gui
end)
</pre>

== Adding elements ==

'''TO BE CONTINUED...'''

User:Raiguard/Tutorial:Modding tutorial/GUI

2020-05-28T02:41:29Z

Raiguard: URL fix

'''THIS PAGE IS A WORK-IN-PROGRESS.'''

While you cannot edit base game GUIs, the Lua API includes the ability to create your own, completely custom GUIs. This tutorial will get you up to speed with creating such GUIs.

== Before you Begin ==

Be sure you have the [https://lua-api.factorio.com/latest/LuaGui.html LuaGui], [https://lua-api.factorio.com/latest/LuaGuiElement.html LuaGuiElement], and [https://lua-api.factorio.com/latest/LuaStyle.html LuaStyle] pages handy.

There are two in-game tools that are absolutely essential for creating GUIs:

=== GUI border view ===

[[File:Modding tutorial Ctrl F5.png|500px]]

Hitting '''Control + F5''' on your keyboard will bring up the "GUI border view". This surrounds all GUI elements with red borders, and can help you visualize how things are laid out.

=== GUI style inspector ===

[[File:Modding tutorial Ctrl F6.png]]

Hitting '''Control + F6''' on your keyboard will allow you to use the "GUI style inspector". This allows you to view an element's style inheritances when you hover over it. Combined with the GUI border view, you can inspect normally hidden GUI elements.

== The Root ==

Every GUI must start in one of the five GUI "roots", listed in [https://lua-api.factorio.com/latest/LuaGui.html LuaGui]:

* '''top:''' Aligns the GUI at the top of the screen. Multiple elements will be flowed next to each other so they don't overlap.
* '''left:''' Aligns the GUI at the left of the screen. Multiple elements will be flowed next to each other so they don't overlap.
* '''center:''' Centers the GUI on the player's screen. Multiple elements will be flowed next to each other so they don't overlap.
* '''goal:''' Where the objective GUI sits. It is recommended not to use this root unless creating a scenario. Multiple elements will be flowed next to each other so they don't overlap.
* '''screen:''' An empty element that allows you to position your GUI anywhere on the player's screen. Because of this, multiple elements may overlap. Elements are placed in the top-left corner by default.

You will want to place your GUI in '''screen''', unless you have a specific reason not to.

== Adding elements ==

'''TO BE CONTINUED...'''

User:Raiguard/Tutorial:Modding tutorial/GUI

2020-05-28T02:40:11Z

Raiguard: Initial stub page.

'''THIS PAGE IS A WORK-IN-PROGRESS.'''

While you cannot edit base game GUIs, the Lua API includes the ability to create your own, completely custom GUIs. This tutorial will get you up to speed with creating such GUIs.

== Before you Begin ==

Be sure you have the [https://lua-api.factorio.com/latest/LuaGui.html LuaGui], [https://lua-api.factorio.com/latest/LuaGuiElement.html LuaGuiElement], and https://lua-api.factorio.com/latest/LuaStyle.html LuaStyle] pages handy.

There are two in-game tools that are absolutely essential for creating GUIs:

=== GUI border view ===

[[File:Modding tutorial Ctrl F5.png|500px]]

Hitting '''Control + F5''' on your keyboard will bring up the "GUI border view". This surrounds all GUI elements with red borders, and can help you visualize how things are laid out.

=== GUI style inspector ===

[[File:Modding tutorial Ctrl F6.png]]

Hitting '''Control + F6''' on your keyboard will allow you to use the "GUI style inspector". This allows you to view an element's style inheritances when you hover over it. Combined with the GUI border view, you can inspect normally hidden GUI elements.

== The Root ==

Every GUI must start in one of the five GUI "roots", listed in [https://lua-api.factorio.com/latest/LuaGui.html LuaGui]:

* '''top:''' Aligns the GUI at the top of the screen. Multiple elements will be flowed next to each other so they don't overlap.
* '''left:''' Aligns the GUI at the left of the screen. Multiple elements will be flowed next to each other so they don't overlap.
* '''center:''' Centers the GUI on the player's screen. Multiple elements will be flowed next to each other so they don't overlap.
* '''goal:''' Where the objective GUI sits. It is recommended not to use this root unless creating a scenario. Multiple elements will be flowed next to each other so they don't overlap.
* '''screen:''' An empty element that allows you to position your GUI anywhere on the player's screen. Because of this, multiple elements may overlap. Elements are placed in the top-left corner by default.

You will want to place your GUI in '''screen''', unless you have a specific reason not to.

== Adding elements ==

'''TO BE CONTINUED...'''

User:Raiguard

2020-05-28T01:33:14Z

Raiguard:

I am a Factorio veteran with lots of experience in just about every facet of the game. After playing the game for over 1200 hours I turned to modding, and have been doing that for over a year.

I am almost always active over on the Factorio Discord server, in the '''#mod-making''' channel.