Prototype/Tutorial: Difference between revisions
(Created page with "== Basics == 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...") |
(→related_items: found the use of this, lol) |
||
| Line 48: | Line 48: | ||
'''Type''': [[Types/table]] of [[Types/string]] | '''Type''': [[Types/table]] of [[Types/string]] | ||
Items that are related to this tutorial | Items that are related to this tutorial, are shown below the tutorial icon in the tutorial list. | ||
== Example == | == Example == | ||
Revision as of 08:41, 25 October 2017
Basics
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
icon
Type: Types/FileName
icon_size
Type: Types/uint
scenario
Type: Types/string
Name of the folder for this tutorial in the tutorials folder.
Optional properties
Either technology, build_entity, or craft_item has to exist.
technology
Type: Types/string
Name of the technology that unlocks/triggers this tutorial when it is researched.
build_entity
Type: Types/string
Name of the entity that unlocks/triggers this tutorial when it is built.
craft_item
Type: Types/string
Name of the item that unlocks/triggers this tutorial when it is crafted.
Type: Types/table of Types/string
Items that are related to this tutorial, are shown below the tutorial icon in the tutorial list.
Example
{
type = "tutorial",
name = "trains-basics",
scenario = "trains-basics",
order = "a[trains]-a[basic-train]",
technology = "railway",
icon = "__base__/graphics/technology/railway.png",
icon_size = 128,
related_items = {"rail", "locomotive"}
},