Prototype/BuildEntityAchievement: Difference between revisions
Jump to navigation
Jump to search
(Changed links going to the redirect Types/uint to go to Types/uint32.) |
m (typo) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Prototype parent|Prototype/Achievement}} | |||
This Prototype definition is used for receiving an achievement when you build an entity. | This Prototype definition is used for receiving an achievement when you build an entity. | ||
{{Prototype TOC|build-entity-achievement}} | |||
== Mandatory properties == | == Mandatory properties == | ||
{{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 11: | Line 13: | ||
== Optional properties == | == Optional properties == | ||
{{Prototype property|amount|[[Types/uint32|uint32]]|1|optional=true}} | |||
How many entities need to be built. | How many entities need to be built. | ||
{{Prototype property|limited_to_one_game|[[Types/bool|bool]]|false|optional=true}} | |||
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. | ||
{{Prototype property|until_second|[[Types/uint32|uint32]]|0 (Infinite time)|optional=true}} | |||
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 | 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.