Prototype/Tutorial: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(0.16)
(1.1)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Basics ==
{{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.
== Mandatory properties ==


=== type ===
{{Prototype TOC|tutorial}}
'''Type''': [[Types/string]]


Must be "tutorial".
== Mandatory properties ==
 
Inherits all properties from [[PrototypeBase]].
=== name ===
'''Type''': [[Types/string]]
 
Name of the tutorial.
 
=== order ===
'''Type''': [[Types/Order]]
 
'''Default''': The <code>name</code> of this tutorial
 
=== icons, icon,  icon_size (IconSpecification) ===
'''Type''': [[Types/IconSpecification]]
 
=== scenario ===
'''Type''': [[Types/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.
== 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 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 ==
<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>

Latest revision as of 20:18, 11 December 2020

Prototype definitions » PrototypeBase » Prototype/Tutorial


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/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.

scenario

Type: string
Name of the folder for this tutorial in the tutorials folder.

Retrieved from "https://testing-wiki.factorio.com/index.php?title=Prototype/Tutorial&oldid=183970"