Prototype/Tutorial: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Set prototype parent)
(Converted to SMW format)
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.


== Basics ==
{{Prototype TOC|tutorial}}
Prototype type: '''tutorial'''


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 ==
Inherits all properties from [[PrototypeBase]].
Inherits all properties from [[PrototypeBase]].


=== icons, icon, icon_size (IconSpecification) ===
{{Prototype property|icons, icon, icon_size (IconSpecification)|[[Types/IconSpecification|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.


=== trigger ===
{{Prototype property|trigger|[[Types/table|table]]}}
'''Type''': [[Types/table]]
 
Table with the following properties:
Table with the following properties:
* type - [[Types/string]] - Mandatory. - One of "research-technology", "build-entity", "craft-item" and "manual-transfer".
* type - [[Types/string|string]] - Mandatory. - One of "research-technology", "build-entity", "craft-item" and "manual-transfer".
* technology - [[Types/string]] - Read if type is "research-technology". - Name of the technology that triggers this tutorial when it is researched.
* 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]] - Read if type is "build-entity". - Name of the entity that triggers this tutorial when it is built.
* 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]] - Read if type is "craft-item". - Name of the item that triggers this tutorial when it is crafted.
* 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]] - Read if type is "manual-transfer". - Amount of times manual item transfer has to be done to trigger this tutorial.
* 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 ==
== Optional properties ==


=== localised_name ===
{{Prototype property|dependencies|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
'''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.
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 ===
{{Prototype property|related_items|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
'''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.
Items that are related to this tutorial, are shown below the tutorial icon in the tutorial list. Max number of related_items is 9.


Revision as of 18:42, 6 August 2019

Template:Prototype parent 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.

Template:Prototype TOC

Mandatory properties

Inherits all properties from PrototypeBase.

Template:Prototype property

Template:Prototype property Name of the folder for this tutorial in the tutorials folder.

Template:Prototype property Table with the following properties:

  • type - string - Mandatory. - One of "research-technology", "build-entity", "craft-item" and "manual-transfer".
  • technology - string - Read if type is "research-technology". - Name of the technology that triggers this tutorial when it is researched.
  • entity - string - Read if type is "build-entity". - Name of the entity that triggers this tutorial when it is built.
  • item - string - Read if type is "craft-item". - Name of the item that triggers this tutorial when it is crafted.
  • count - uint32 - Read if type is "manual-transfer". - Amount of times manual item transfer has to be done to trigger this tutorial.

Optional properties

Template:Prototype property 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.

Template:Prototype property 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

{
    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"}
  },
Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/Tutorial&oldid=175335"