|
|
| Line 1: |
Line 1: |
| {{Prototype parent|PrototypeBase}} | | {{Prototype parent|PrototypeBase}} |
| 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. | | The definition of the tutorial to be used in the tips and tricks, see [[Prototype/TipsAndTricksItem]]. The actual tutorial code is defined in the tutorials folder, in the folder that has the name of the scenario property. |
|
| |
|
| {{Prototype TOC|tutorial}} | | {{Prototype TOC|tutorial}} |
| Line 6: |
Line 6: |
| == Mandatory properties == | | == Mandatory properties == |
| Inherits all properties from [[PrototypeBase]]. | | Inherits all properties from [[PrototypeBase]]. |
|
| |
| {{Prototype property|icons, icon, icon_size (IconSpecification)|[[Types/IconSpecification|IconSpecification]]}}
| |
|
| |
|
| {{Prototype property|scenario|[[Types/string|string]]}} | | {{Prototype property|scenario|[[Types/string|string]]}} |
| Name of the folder for this tutorial in the tutorials folder. | | Name of the folder for this tutorial in the tutorials folder. |
|
| |
| {{Prototype property|trigger|[[Types/table|table]]}}
| |
| Table with the following properties:
| |
| * type - [[Types/string|string]] - Mandatory. - One of "research-technology", "build-entity", "craft-item" and "manual-transfer".
| |
| * technology - [[Types/string|string]] - Read if type is "research-technology". - Name of the technology that triggers this tutorial when it is researched.
| |
| * entity - [[Types/string|string]] - Read if type is "build-entity". - Name of the entity that triggers this tutorial when it is built.
| |
| * item - [[Types/string|string]] - Read if type is "craft-item". - Name of the item that triggers this tutorial when it is crafted.
| |
| * count - [[Types/uint32|uint32]] - Read if type is "manual-transfer". - Amount of times manual item transfer has to be done to trigger this tutorial.
| |
|
| |
| == Optional properties ==
| |
|
| |
| {{Prototype property|dependencies|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
| |
| 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.
| |
|
| |
| {{Prototype property|related_items|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
| |
| Items that are related to this tutorial, are shown below the tutorial icon in the tutorial list. Max number of related_items is 9.
| |
|
| |
| {{Prototype property|locked_when_dependencies_not_completed|[[Types/bool|bool]]|false|optional=true}}
| |
| Whether the tutorial should be locked when the [[#dependencies]] tutorials have not yet been completed.
| |
|
| |
| {{Prototype property|unlocked|[[Types/bool|bool]]|false|optional=true}}
| |
| Whether the tutorial is always unlocked, regardless of dependency tutorials.
| |
|
| |
| == Example ==
| |
| <syntaxhighlight lang="lua">{
| |
| 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"}
| |
| },</syntaxhighlight>
| |
Template:Prototype parent
The definition of the tutorial to be used in the tips and tricks, see Prototype/TipsAndTricksItem. The actual tutorial code is defined in the tutorials folder, in the folder that has the name of the scenario property.
Template:Prototype TOC
Mandatory properties
Inherits all properties from PrototypeBase.
Template:Prototype property
Name of the folder for this tutorial in the tutorials folder.