TipsAndTricksItem - Prototype Docs

TipsAndTricksItem 'tips-and-tricks-item' changed

A tips and tricks entry.

Properties

image optional	:: FileName
simulation optional	:: SimulationDefinition
tag optional	:: string	String to add in front of the tips and trick entries name. [...]
String to add in front of the tips and trick entries name. [...]
category optional	:: string	Name of a TipsAndTricksItemCategory, used for the sorting of this tips and tricks entry. [...]
Name of a TipsAndTricksItemCategory, used for the sorting of this tips and tricks entry. [...]
indent optional	:: uint8	The tips and tricks entry is indented by `indent`×6 spaces.
The tips and tricks entry is indented by `indent`×6 spaces.
is_title optional	:: bool	Whether the tip title on the left in the tips and tricks GUI should use the "title_tip_item" style (semi bold font).
Whether the tip title on the left in the tips and tricks GUI should use the "title_tip_item" style (semi bold font).
trigger optional	:: TipTrigger	Condition for when the tip notification should be shown to the player.
Condition for when the tip notification should be shown to the player.
skip_trigger optional	:: TipTrigger	Condition for never showing the tip notification to the player.
Condition for never showing the tip notification to the player.
tutorial optional	:: string	Name of a TutorialDefinition.
Name of a TutorialDefinition.
starting_status optional	:: TipStatus
dependencies optional	:: array[string]	An array of names of other tips and tricks items. [...]
An array of names of other tips and tricks items. [...]
player_input_method_filter optional	:: PlayerInputMethodFilter
iconsnew optional	:: array[IconData]	Can't be an empty array.
Can't be an empty array.
iconnew optional	:: FileName	Path to the icon file. [...]
Path to the icon file. [...]
icon_sizenew optional	:: SpriteSizeType	The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]

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[overridden] 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_descriptionnew optional	:: LocalisedString	Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
subgroupnew optional	:: ItemSubGroupID	The name of an ItemSubGroup.
The name of an ItemSubGroup.
hiddennew optional	:: bool
hidden_in_factoriopedianew optional	:: bool
parameternew optional	:: bool	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_simulationnew 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.

category optional	:: string	Name of a TipsAndTricksItemCategory, used for the sorting of this tips and tricks entry. [...]
Name of a TipsAndTricksItemCategory, used for the sorting of this tips and tricks entry. [...]
dependencies optional	:: array[string]	An array of names of other tips and tricks items. [...]
An array of names of other tips and tricks items. [...]
iconnew optional	:: FileName	Path to the icon file. [...]
Path to the icon file. [...]
icon_sizenew optional	:: SpriteSizeType	The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
iconsnew optional	:: array[IconData]	Can't be an empty array.
Can't be an empty array.
image optional	:: FileName
indent optional	:: uint8	The tips and tricks entry is indented by `indent`×6 spaces.
The tips and tricks entry is indented by `indent`×6 spaces.
is_title optional	:: bool	Whether the tip title on the left in the tips and tricks GUI should use the "title_tip_item" style (semi bold font).
Whether the tip title on the left in the tips and tricks GUI should use the "title_tip_item" style (semi bold font).
player_input_method_filter optional	:: PlayerInputMethodFilter
simulation optional	:: SimulationDefinition
skip_trigger optional	:: TipTrigger	Condition for never showing the tip notification to the player.
Condition for never showing the tip notification to the player.
starting_status optional	:: TipStatus
tag optional	:: string	String to add in front of the tips and trick entries name. [...]
String to add in front of the tips and trick entries name. [...]
trigger optional	:: TipTrigger	Condition for when the tip notification should be shown to the player.
Condition for when the tip notification should be shown to the player.
tutorial optional	:: string	Name of a TutorialDefinition.
Name of a TutorialDefinition.

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_descriptionnew optional	:: LocalisedString	Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
factoriopedia_simulationnew 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.
hiddennew optional	:: bool
hidden_in_factoriopedianew optional	:: bool
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[overridden] optional	:: Order	Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
parameternew optional	:: bool	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.
subgroupnew optional	:: ItemSubGroupID	The name of an ItemSubGroup.
The name of an ItemSubGroup.

Properties

image :: FileName optional

Default: ""

simulation :: SimulationDefinition optional

tag :: string optional

Default: ""

String to add in front of the tips and trick entries name. Can be anything, the base game tends to use rich text tags for items, e.g. [item=wooden-chest] here.

category :: string optional

Default: the name of this prototype

Name of a TipsAndTricksItemCategory, used for the sorting of this tips and tricks entry. Tips and trick entries are sorted first by category and then by their order within that category.

indent :: uint8 optional

Default: 0

The tips and tricks entry is indented by indent×6 spaces.

is_title :: bool optional

Default: false

Whether the tip title on the left in the tips and tricks GUI should use the "title_tip_item" style (semi bold font).

trigger :: TipTrigger optional

Condition for when the tip notification should be shown to the player.

skip_trigger :: TipTrigger optional

Condition for never showing the tip notification to the player.

tutorial :: string optional

Default: ""

Name of a TutorialDefinition.

starting_status :: TipStatus optional

Default: "locked"

dependencies :: array[string] optional

Default: none

An array of names of other tips and tricks items. This tips and tricks entry is only shown to the player once they have marked all dependencies as read.

player_input_method_filter :: PlayerInputMethodFilter optional

Default: "all"

icons :: array[IconData] optional new

Can't be an empty array.

icon :: FileName optional new

Path to the icon file.

Only loaded if icons is not defined.

icon_size :: SpriteSizeType optional new

Default: 64

The size of the square icon, in pixels. E.g. 32 for a 32px by 32px icon. Must be larger than 0.

Only loaded if icons is not defined.

Overridden Properties

order :: Order optional new

Default: Value of name

Used to order prototypes in inventory, recipes and GUIs. May not exceed a length of 200 characters.

Factorio Prototype Docs Version 2.0.26

TipsAndTricksItem 'tips-and-tricks-item' changed

Properties

Properties

image :: FileName optional

simulation :: SimulationDefinition optional

tag :: string optional

category :: string optional

indent :: uint8 optional

is_title :: bool optional

trigger :: TipTrigger optional

skip_trigger :: TipTrigger optional

tutorial :: string optional

starting_status :: TipStatus optional

dependencies :: array[string] optional

player_input_method_filter :: PlayerInputMethodFilter optional

icons :: array[IconData] optional new

icon :: FileName optional new

icon_size :: SpriteSizeType optional new

Overridden Properties

order :: Order optional new

Prototypes

Types

Defines

Factorio Prototype DocsVersion 2.0.26

TipsAndTricksItem 'tips-and-tricks-item' changed

Properties

Properties

image :: FileName optional

simulation :: SimulationDefinition optional

tag :: string optional

category :: string optional

indent :: uint8 optional

is_title :: bool optional

trigger :: TipTrigger optional

skip_trigger :: TipTrigger optional

tutorial :: string optional

starting_status :: TipStatus optional

dependencies :: array[string] optional

player_input_method_filter :: PlayerInputMethodFilter optional

icons :: array[IconData] optional new

icon :: FileName optional new

icon_size :: SpriteSizeType optional new

Overridden Properties

order :: Order optional new

Prototypes

Types

Defines

Factorio Prototype Docs Version 2.0.26