Prototype/BuildEntityAchievement: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
m (typo)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Basics ==
{{Prototype parent|Prototype/Achievement}}
Prototype type: '''build-entity-achievement'''
This Prototype definition is used for receiving an achievement when you build an entity.
 
{{Prototype TOC|build-entity-achievement}}


This Prototype definition is used for receiving an achievement when you build an entity. This is an extension of [[Prototype/Achievement]]
== Mandatory properties ==
== Mandatory properties ==
=== to_build ===
'''Type''': [[Types/string]]


{{Prototype property|to_build|[[Types/string|string]]}}
This will trigger the achievement, if this entity is placed.
This will trigger the achievement, if this entity is placed.


Line 13: Line 13:
== Optional properties ==
== Optional properties ==


=== amount ===
{{Prototype property|amount|[[Types/uint32|uint32]]|1|optional=true}}
'''Type''': [[Types/uint32]]
 
'''Default''': 1
 
How many entities need to be built.
How many entities need to be built.


=== limited_to_one_game ===
{{Prototype property|limited_to_one_game|[[Types/bool|bool]]|false|optional=true}}
'''Type''': [[Types/bool]]
 
'''Default''': false
 
If this is false, the player carries over their statistics from this achievement through all their saves.
If this is false, the player carries over their statistics from this achievement through all their saves.


=== until_second ===
{{Prototype property|until_second|[[Types/uint32|uint32]]|0 (Infinite time)|optional=true}}
'''Type''': [[Types/uint32]]
 
'''Default''': 0 (Infinite time)
 
This lets the game know how long into a game, before you can no longer complete the achievement.
This lets the game know how long into a game, before you can no longer complete the achievement.


   until_second = 60 * 60 * 8, --8 hours. 60 seconds per minute times 60 minutes per hour times the amount of hours.
   until_second = 60 * 60 * 8, --8 hours. 60 seconds per minute times 60 minutes per hour times the amount of hours.

Latest revision as of 16:19, 26 July 2019

Prototype definitions » PrototypeBase » Prototype/Achievement » Prototype/BuildEntityAchievement


This Prototype definition is used for receiving an achievement when you build an entity.


Prototype/BuildEntityAchievement — build-entity-achievement
to_build::string
amount::uint32 (optional)
limited_to_one_game::bool (optional)
until_second::uint32 (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

to_build

Type: string
This will trigger the achievement, if this entity is placed.

 to_build = "locomotive",

Optional properties

amount

Type: uint32
Default: 1
How many entities need to be built.

limited_to_one_game

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

until_second

Type: uint32
Default: 0 (Infinite time)
This lets the game know how long into a game, before you can no longer complete the achievement.

 until_second = 60 * 60 * 8, --8 hours. 60 seconds per minute times 60 minutes per hour times the amount of hours.