Prototype/ProduceAchievement: Difference between revisions

Latest revision as of 16:39, 26 July 2019

Prototype definitions » PrototypeBase » Prototype/Achievement » Prototype/ProduceAchievement

This prototype definition is used for receiving an achievement when the player produces more than the specified amount of items.

Prototype/ProduceAchievement — `produce-achievement`
amount	::	MaterialAmountType
limited_to_one_game	::	bool
fluid_product	::	string (optional)
item_product	::	string (optional)
Inherited from Prototype/Achievement
icons, icon, icon_size (IconSpecification)	::	IconSpecification
allowed_without_fight	::	bool (optional)
hidden	::	bool (optional)
steam_stats_name	::	string (optional)
Inherited from PrototypeBase
name	::	string
type	::	string
localised_description	::	LocalisedString (optional)
localised_name	::	LocalisedString (optional)
order	::	Order (optional)

Mandatory properties

amount

Type: MaterialAmountType
This will set the amount of items or fluids needed to craft, for the player to complete the achievement.

 amount = 100,

limited_to_one_game

Type: bool
If this is false, the player carries over their statistics from this achievement through all their saves.

Optional properties

At least one and only one of fluid_product or item_product must exist.

item_product

Type: string
This will tell the achievement what item the player needs to craft, to get the achievement.

 item_product = "pistol",

fluid_product

Type: string
This will tell the achievement what fluid the player needs to craft, to get the achievement.

 fluid_product = "heavy-oil",

@@ Line 1: / Line 1: @@
-==Basics==
+{{Prototype parent|Prototype/Achievement}}
-This Prototype Definition is used for receiving an achievement, when you produce more than the specified amount of items. This is an extension of [[Prototype/Achievement]]
+This prototype definition is used for receiving an achievement when the player produces more than the specified amount of items.
-==Properties==
-===item_produce===
-'''Type''': [[Types/string]]
-This will tell the achievement what the player needs to craft, to get the achievement.
+{{Prototype TOC|produce-achievement}}
-  item_produce = "pistol",
+== Mandatory properties ==
-===amount===
-'''Type''': [[Types/unsigned]]
-This will set the amount of items needed to craft, for the player to complete the achievement.
+{{Prototype property|amount|[[Types/MaterialAmountType|MaterialAmountType]]}}
+This will set the amount of items or fluids needed to craft, for the player to complete the achievement.
    amount = 100,
+{{Prototype property|limited_to_one_game|[[Types/bool|bool]]}}
+If this is false, the player carries over their statistics from this achievement through all their saves.
+== Optional properties ==
+At least one and only one of fluid_product or item_product must exist.
+{{Prototype property|item_product|[[Types/string|string]]|optional=true}}
+This will tell the achievement what item the player needs to craft, to get the achievement.
+  item_product = "pistol",
+{{Prototype property|fluid_product|[[Types/string|string]]|optional=true}}
+This will tell the achievement what fluid the player needs to craft, to get the achievement.
+  fluid_product = "heavy-oil",