Prototype/KillAchievement: Difference between revisions
(Set prototype parent) |
(Updated styling of prototype doc migration note) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<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/KillAchievementPrototype.html https://lua-api.factorio.com/latest/prototypes/KillAchievementPrototype.html] | |||
</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|Prototype/Achievement}} | {{Prototype parent|Prototype/Achievement}} | ||
This prototype definition is used for receiving an achievement when the player destroys a certain amount of an entity, with a specific damage type. | |||
{{Prototype TOC|kill-achievement}} | |||
Prototype | |||
== Optional properties == | == Optional properties == | ||
{{Prototype property|to_kill|[[Types/string|string]]|""|optional=true}} | |||
This defines which entity (by name) needs to be destroyed in order to receive the achievement. | This defines which entity (by name) needs to be destroyed in order to receive the achievement. | ||
{{Prototype property|type_to_kill|[[Types/string|string]]|optional=true}} | |||
This defines what entity type needs to be destroyed in order to receive the achievement. | This defines what entity type needs to be destroyed in order to receive the achievement. | ||
type_to_kill = "inserter", | type_to_kill = "inserter", | ||
{{Prototype property|damage_type|[[Types/string|string]]|""|optional=true}} | |||
This defines how the player needs to destroy the specific entity. | This defines how the player needs to destroy the specific entity. | ||
damage_type = "impact", | damage_type = "impact", | ||
{{Prototype property|amount|[[Types/uint32|uint32]]|1|optional=true}} | |||
This is the amount of entity of the specified type the player needs to destroy to receive the achievement. | This is the amount of entity of the specified type the player needs to destroy to receive the achievement. | ||
amount = 100, | amount = 100, | ||
{{Prototype property|in_vehicle|[[Types/bool|bool]]|false|optional=true}} | |||
This defines if the player needs to be in a vehicle. | This defines if the player needs to be in a vehicle. | ||
in_vehicle = true, | in_vehicle = true, | ||
{{Prototype property|personally|[[Types/bool|bool]]|false|optional=true}} | |||
This defines to make sure you are the one driving, for instance, in a tank rather than an automated train. | This defines to make sure you are the one driving, for instance, in a tank rather than an automated train. | ||
personally = true, | personally = true, | ||
Latest revision as of 10:43, 21 September 2023
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/KillAchievementPrototype.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 on the forums.
Prototype definitions » PrototypeBase » Prototype/Achievement » Prototype/KillAchievement
This prototype definition is used for receiving an achievement when the player destroys a certain amount of an entity, with a specific damage type.
Prototype/KillAchievement — kill-achievement | ||
| amount | :: | uint32 (optional) |
| damage_type | :: | string (optional) |
| in_vehicle | :: | bool (optional) |
| personally | :: | bool (optional) |
| to_kill | :: | string (optional) |
| type_to_kill | :: | 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) |
Optional properties
to_kill
Type: string
Default: ""
This defines which entity (by name) needs to be destroyed in order to receive the achievement.
type_to_kill
Type: string
This defines what entity type needs to be destroyed in order to receive the achievement.
type_to_kill = "inserter",
damage_type
Type: string
Default: ""
This defines how the player needs to destroy the specific entity.
damage_type = "impact",
amount
Type: uint32
Default: 1
This is the amount of entity of the specified type the player needs to destroy to receive the achievement.
amount = 100,
in_vehicle
Type: bool
Default: false
This defines if the player needs to be in a vehicle.
in_vehicle = true,
personally
Type: bool
Default: false
This defines to make sure you are the one driving, for instance, in a tank rather than an automated train.
personally = true,