Prototype/Tutorial: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(This doesnt inherit from prototype... isnt that great?)
(Updated styling of prototype doc migration note)
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Basics ==
<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/TutorialDefinition.html https://lua-api.factorio.com/latest/prototypes/TutorialDefinition.html]
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 ==
Inherits all properties from [[Prototype]].


=== icon ===
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
'''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 ===
{{Prototype parent|PrototypeBase}}
'''Type''': [[Types/string]]
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.


Name of the folder for this tutorial in the tutorials folder.
{{Prototype TOC|tutorial}}


== Optional properties ==
== Mandatory properties ==
Inherits all properties from [[Prototype]].
Inherits all properties from [[PrototypeBase]].


''Either technology, build_entity, or craft_item has to exist.''
{{Prototype property|scenario|[[Types/string|string]]}}
=== technology ===
Name of the folder for this tutorial in the tutorials folder.
'''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.
 
=== 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.
 
== 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 10:43, 21 September 2023

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/TutorialDefinition.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.


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://wiki.factorio.com/index.php?title=Prototype/Tutorial&oldid=193950"