Prototype/Tutorial

Basics

Prototype type: 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.

Mandatory properties

type

Type: Types/string

Must be "tutorial".

name

Type: Types/string

Name of the tutorial.

order

Type: Types/Order

Default: The name of this tutorial

icons, icon, icon_size (IconSpecification)

Type: Types/IconSpecification

scenario

Type: Types/string

Name of the folder for this tutorial in the tutorials folder.

trigger

Type: Types/table

Table with the following properties:

• type - Types/string - Mandatory. - One of "research-technology", "build-entity", "craft-item" and "manual-transfer".
• technology - Types/string - Read if type is "research-technology". - Name of the technology that triggers this tutorial when it is researched.
• entity - Types/string - Read if type is "build-entity". - Name of the entity that triggers this tutorial when it is built.
• item - Types/string - Read if type is "craft-item". - Name of the item that triggers this tutorial when it is crafted.
• count - Types/uint32 - Read if type is "manual-transfer". - Amount of times manual item transfer has to be done to trigger this tutorial.

Optional properties

localised_name

Type: Types/LocalisedString

localised_description

Type: Types/LocalisedString

dependencies

Type: Types/table of Types/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.

related_items

Type: Types/table of Types/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.

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"}
  },