Prototype/Tutorial - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:33:06Z

Removed old prototype docs

← Older revision		Revision as of 14:33, 25 October 2024
Line 2:		Line 2:

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



	~~{{Prototype parent\|PrototypeBase}}~~
	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}}~~

	~~== Mandatory properties ==~~
	~~Inherits all properties from [[PrototypeBase]].~~

	~~{{Prototype property\|scenario\|[[Types/string\|string]]}}~~
	~~Name of the folder for this tutorial in the tutorials folder.~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:43:37Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:43, 21 September 2023
Line 1:		Line 1:
	'''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]		<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]

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

BilkaBot: Protected "Prototype/Tutorial": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:53:25Z

Protected "Prototype/Tutorial": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision		Revision as of 17:53, 16 August 2023
(No difference)

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:53:25Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:53, 16 August 2023
Line 1:		Line 1:
			'''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]

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



	{{Prototype parent\|PrototypeBase}}		{{Prototype parent\|PrototypeBase}}
	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.		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.

Bilka: 1.1

2020-12-11T20:18:31Z

1.1

@@ Line 1: / Line 1: @@
 {{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}}
@@ Line 6: / Line 6: @@
 == Mandatory properties ==
 Inherits all properties from [[PrototypeBase]].
 {{Prototype property|scenario|[[Types/string|string]]}}
 Name of the folder for this tutorial in the tutorials folder.

Bilka: 0.18.33: removed visible_when_dependencies_not_completed, added locked_when_dependencies_not_completed, unlocked

2020-07-08T07:52:12Z

0.18.33: removed visible_when_dependencies_not_completed, added locked_when_dependencies_not_completed, unlocked

← Older revision		Revision as of 07:52, 8 July 2020
Line 28:		Line 28:
	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.

	{{Prototype property\|~~visible_when_dependencies_not_completed~~\|[[Types/bool\|bool]] \|~~true~~\|optional=true}}		{{Prototype property\|locked_when_dependencies_not_completed\|[[Types/bool\|bool]]\|false\|optional=true}}
	Whether the tutorial should be ~~visible~~ when the [[#dependencies]] tutorials have not yet been completed.		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 ==		== Example ==

Bilka: 0.18.26: added visible_when_dependencies_not_completed

2020-05-21T14:31:11Z

0.18.26: added visible_when_dependencies_not_completed

← Older revision		Revision as of 14:31, 21 May 2020
Line 27:		Line 27:
	{{Prototype property\|related_items\|[[Types/table\|table]] of [[Types/string\|string]]\|optional=true}}		{{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.		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\|visible_when_dependencies_not_completed\|[[Types/bool\|bool]] \|true\|optional=true}}
			Whether the tutorial should be visible when the [[#dependencies]] tutorials have not yet been completed.

	== Example ==		== Example ==

Bilka: Converted to SMW format

2019-08-06T18:42:35Z

Converted to SMW format

← Older revision		Revision as of 18:42, 6 August 2019
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.

Bilka: Set prototype parent

2019-07-24T14:51:14Z

Set prototype parent

← Older revision		Revision as of 14:51, 24 July 2019
Line 1:		Line 1:
			{{Prototype parent\|PrototypeBase}}

	== Basics ==		== Basics ==
	Prototype type: '''tutorial'''		Prototype type: '''tutorial'''

Bilka: Inherits from PrototypeBase

2019-07-16T12:03:21Z

Inherits from PrototypeBase

@@ Line 4: / Line 4: @@
 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 [[PrototypeBase]].
 === icons, icon,  icon_size (IconSpecification) ===