Prototype/Tutorial
Prototype definitions » PrototypeBase » Prototype/Tutorial
The definition of the tutorial as shown in the tutorial selection in-game. The actual tutorial code is defined in the tutorials folder, in the folder that has the name of the scenario property.
Prototype/Tutorial — tutorial | ||
scenario | :: | string |
Inherited from PrototypeBase | ||
name | :: | string |
type | :: | string |
localised_description | :: | LocalisedString (optional) |
localised_name | :: | LocalisedString (optional) |
order | :: | Order (optional) |
Mandatory properties
Inherits all properties from PrototypeBase.
icons, icon, icon_size (IconSpecification)
Type: IconSpecification
scenario
Type: string
Name of the folder for this tutorial in the tutorials folder.
trigger
Type: table
Table with the following properties:
- type - string - Mandatory. - One of "research-technology", "build-entity", "craft-item" and "manual-transfer".
- technology - string - Read if type is "research-technology". - Name of the technology that triggers this tutorial when it is researched.
- entity - string - Read if type is "build-entity". - Name of the entity that triggers this tutorial when it is built.
- item - string - Read if type is "craft-item". - Name of the item that triggers this tutorial when it is crafted.
- count - uint32 - Read if type is "manual-transfer". - Amount of times manual item transfer has to be done to trigger this tutorial.
Optional properties
dependencies
Type: table of string
Names of the tutorials this one depends on. If those are not unlocked yet, the tutorial will show in a different color in the tutorial gui.
Type: table of string
Items that are related to this tutorial, are shown below the tutorial icon in the tutorial list. Max number of related_items is 9.
locked_when_dependencies_not_completed
Type: bool
Default: false
Whether the tutorial should be locked when the #dependencies tutorials have not yet been completed.
unlocked
Type: bool
Default: false
Whether the tutorial is always unlocked, regardless of dependency tutorials.
Example
{
type = "tutorial",
name = "trains-basics",
scenario = "trains-basics",
order = "d[trains]-a[basic-train]",
technology = "railway",
icon = "__base__/graphics/technology/railway.png",
icon_size = 128,
related_items = {"rail", "locomotive"}
},