GuiStyle 'gui-style'
The available GUI styles.
Prototype limited to 1 total instances.
| Inherits from PrototypeBase |
| default_tileset optional | :: FileName | |
| default_sprite_scale optional | :: double | |
| default_sprite_priority optional | :: SpritePriority |
| Custom properties | :: string → StyleSpecification | Styles are defined as uniquely named StyleSpecification properties of the prototype. [...] |
Styles are defined as uniquely named StyleSpecification properties of the prototype. [...] | ||
Inherited from PrototypeBase
| type | :: string | Specifies the kind of prototype this is. [...] |
Specifies the kind of prototype this is. [...] | ||
| name | :: string | Unique textual identification of the prototype. [...] |
Unique textual identification of the prototype. [...] | ||
| order optional | :: Order | Used to order prototypes in inventory, recipes and GUIs. [...] |
Used to order prototypes in inventory, recipes and GUIs. [...] | ||
| localised_name optional | :: LocalisedString | Overwrites the name set in the locale file. [...] |
Overwrites the name set in the locale file. [...] | ||
| localised_description optional | :: LocalisedString | Overwrites the description set in the locale file. [...] |
Overwrites the description set in the locale file. [...] | ||
| factoriopedia_description optional | :: LocalisedString | Provides additional description used in factoriopedia. |
Provides additional description used in factoriopedia. | ||
| subgroup optional | :: ItemSubGroupID | The name of an ItemSubGroup. |
The name of an ItemSubGroup. | ||
| hidden optional | :: boolean | |
| hidden_in_factoriopedia optional | :: boolean | |
| parameter optional | :: boolean | Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function. |
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function. | ||
| factoriopedia_simulation optional | :: SimulationDefinition | The simulation shown when looking at this prototype in the Factoriopedia GUI. |
The simulation shown when looking at this prototype in the Factoriopedia GUI. | ||
| default_sprite_priority optional | :: SpritePriority | |
| default_sprite_scale optional | :: double | |
| default_tileset optional | :: FileName |
| Custom properties | :: string → StyleSpecification | Styles are defined as uniquely named StyleSpecification properties of the prototype. [...] |
Styles are defined as uniquely named StyleSpecification properties of the prototype. [...] | ||
Inherited from PrototypeBase
| name | :: string | Unique textual identification of the prototype. [...] |
Unique textual identification of the prototype. [...] | ||
| type | :: string | Specifies the kind of prototype this is. [...] |
Specifies the kind of prototype this is. [...] | ||
| factoriopedia_description optional | :: LocalisedString | Provides additional description used in factoriopedia. |
Provides additional description used in factoriopedia. | ||
| factoriopedia_simulation optional | :: SimulationDefinition | The simulation shown when looking at this prototype in the Factoriopedia GUI. |
The simulation shown when looking at this prototype in the Factoriopedia GUI. | ||
| hidden optional | :: boolean | |
| hidden_in_factoriopedia optional | :: boolean | |
| localised_description optional | :: LocalisedString | Overwrites the description set in the locale file. [...] |
Overwrites the description set in the locale file. [...] | ||
| localised_name optional | :: LocalisedString | Overwrites the name set in the locale file. [...] |
Overwrites the name set in the locale file. [...] | ||
| order optional | :: Order | Used to order prototypes in inventory, recipes and GUIs. [...] |
Used to order prototypes in inventory, recipes and GUIs. [...] | ||
| parameter optional | :: boolean | Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function. |
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function. | ||
| subgroup optional | :: ItemSubGroupID | The name of an ItemSubGroup. |
The name of an ItemSubGroup. | ||
Properties
default_tileset :: FileName optional 
Default: ""
default_sprite_scale :: double optional
Default: 1
default_sprite_priority :: SpritePriority optional
Default: "medium"
Custom properties :: string → StyleSpecification
Styles are defined as uniquely named StyleSpecification properties of the prototype.
Styles with certain names are mandatory, as they are used by the base game GUI. A list is found below.
Mandatory styles:
|
Example
-- Adding a custom frame_style-type style
data.raw["gui-style"]["default"]["custom_style_for_a_frame"] =
{
type = "frame_style",
parent = "frame",
use_header_filler = false,
drag_by_title = false
}
