Prototype/TipsAndTricksItem

From Official Factorio Wiki
Revision as of 15:57, 2 December 2020 by Bilka (talk | contribs) (starting_status and dependencies defaults)
Jump to navigation Jump to search

Prototype definitions » PrototypeBase » Prototype/TipsAndTricksItem


A tips and tricks entry.


Prototype/TipsAndTricksItem — tips-and-tricks-item
category::string (optional)
dependencies::array of string (optional)
image::FileName (optional)
indent::uint8 (optional)
is_title::bool (optional)
simulation::SimulationDefinition (optional)
skip_trigger::TipTrigger (optional)
starting_status::TipStatus (optional)
tag::string (optional)
trigger::TipTrigger (optional)
tutorial::string (optional)
Inherited from PrototypeBase
name::string
type::string
localised_description::LocalisedString (optional)
localised_name::LocalisedString (optional)
order::Order (optional)

Optional properties

image

Type: FileName
Default: ""

simulation

Type: SimulationDefinition

tag

Type: string
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

Type: string
Default: the name of this prototype
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 order within that category.

indent

Type: uint8
Default: 0
The tips and tricks entry is indented by indent×6 spaces.

is_title

Type: bool
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

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

skip_trigger

Type: TipTrigger
Condition for never showing the tip notification to the player.

tutorial

Type: string
Default: ""
Name of a Prototype/Tutorial.

starting_status

Type: string
Default: "locked"
One of "optional", "locked", "dependencies-not-met", "unlocked", "suggested", "not-to-be-suggested", "completed-without-tutorial", "completed".

dependencies

Type: array of string
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.