Prototype/TipsAndTricksItem: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(1.1.83: player_input_method_filter added)
(Removed old prototype docs)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Prototype parent|PrototypeBase}}
<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/TipsAndTricksItem.html https://lua-api.factorio.com/latest/prototypes/TipsAndTricksItem.html]
A tips and tricks entry.


{{Prototype TOC|tips-and-tricks-item}}
</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>
 
== Optional properties ==
{{Prototype property|image|[[Types/FileName|FileName]]|""|optional=true}}
 
{{Prototype property|simulation|[[Types/SimulationDefinition|SimulationDefinition]]|optional=true}}
 
{{Prototype property|tag|[[Types/string|string]]|""|optional=true}}
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. <code>[item=wooden-chest]</code> here.
 
{{Prototype property|category|[[Types/string|string]]|the <code>name</code> of this prototype|optional=true}}
Name of a [[Prototype/TipsAndTricksItemCategory]], used for the sorting of this tips and tricks entry. Tips and trick entries are sorted first by category and then by their <code>order</code> within that category.
 
{{Prototype property|indent|[[Types/uint8|uint8]]|0|optional=true}}
The tips and tricks entry is indented by <code>indent</code>×6 spaces.
 
{{Prototype property|is_title|[[Types/bool|bool]]|false|optional=true}}
Whether the tip title on the left in the tips and tricks GUI should use the "title_tip_item" style (semi bold font).
 
{{Prototype property|trigger|[[Types/TipTrigger|TipTrigger]]|optional=true}}
Condition for when the tip notification should be shown to the player.
 
{{Prototype property|skip_trigger|[[Types/TipTrigger|TipTrigger]]|optional=true}}
Condition for never showing the tip notification to the player.
 
{{Prototype property|tutorial|[[Types/string|string]]|""|optional=true}}
Name of a [[Prototype/Tutorial]].
 
{{Prototype property|starting_status|[[Types/TipStatus|TipStatus]]|"locked"|optional=true}}
 
{{Prototype property|dependencies|[[Types/table|array]] of [[Types/string|string]]|none|optional=true}}
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.
 
{{Prototype property|player_input_method_filter|[[Types/string|string]]|"all"|optional=true}}
 
One of "all", "keyboard_and_mouse" and "game_controller".

Latest revision as of 14:33, 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/TipsAndTricksItem.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.