Prototype/Tutorial: Difference between revisions
(This doesnt inherit from prototype... isnt that great?) |
(This doesnt inherit from prototype... isnt that great?) |
||
| Line 2: | Line 2: | ||
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 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 == | == Mandatory properties == | ||
=== type === | |||
'''Type''': [[Types/string]] | |||
Must be "tutorial". | |||
=== name === | |||
'''Type''': [[Types/string]] | |||
Name of the tutorial. | |||
=== order === | |||
'''Type''': [[Types/Order]] | |||
=== icon === | === icon === | ||
| Line 18: | Line 30: | ||
== Optional properties == | == Optional properties == | ||
''Either technology, build_entity, or craft_item has to exist.'' | ''Either technology, build_entity, or craft_item has to exist.'' | ||
=== technology === | === technology === | ||
Revision as of 16:13, 5 February 2018
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
The size of the square icon, in pixels, e.g. 32 for a 32px by 32px icon.
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.
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 unlcoked yet, the tutorial will show in a different color in the tutorial gui.
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 = "d[trains]-a[basic-train]",
technology = "railway",
icon = "__base__/graphics/technology/railway.png",
icon_size = 128,
related_items = {"rail", "locomotive"}
},