Prototype/PlayerDamagedAchievement: Difference between revisions
(Converted to SMW format) |
(Updated styling of prototype doc migration note) |
||
| (3 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/PlayerDamagedAchievementPrototype.html https://lua-api.factorio.com/latest/prototypes/PlayerDamagedAchievementPrototype.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 receives damage. | This prototype definition is used for receiving an achievement when the player receives damage. | ||
| Line 6: | Line 12: | ||
== Mandatory properties == | == Mandatory properties == | ||
{{Prototype property|minimum_damage |[[Types/float|float]]}} | {{Prototype property|minimum_damage|[[Types/float|float]]}} | ||
This will trigger the achievement, if the amount of damage taken by the dealer, is more than this. | This will trigger the achievement, if the amount of damage taken by the dealer, is more than this. | ||
minimum_damage = 500, | minimum_damage = 500, | ||
{{Prototype property|should_survive |[[Types/bool|bool]]}} | {{Prototype property|should_survive|[[Types/bool|bool]]}} | ||
This sets the achievement to only trigger, if you survive the minimum amount of damage. If you don't need to survive, false. | This sets the achievement to only trigger, if you survive the minimum amount of damage. If you don't need to survive, false. | ||
| Line 18: | Line 24: | ||
== Optional properties == | == Optional properties == | ||
{{Prototype property|type_of_dealer |[[Types/string|string]]|""|optional=true}} | {{Prototype property|type_of_dealer|[[Types/string|string]]|""|optional=true}} | ||
This will trigger the achievement, if the player takes damage from this specific entity type. | This will trigger the achievement, if the player takes damage from this specific entity type. | ||
type_of_dealer = "locomotive", | type_of_dealer = "locomotive", | ||
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/PlayerDamagedAchievementPrototype.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/PlayerDamagedAchievement
This prototype definition is used for receiving an achievement when the player receives damage.
Prototype/PlayerDamagedAchievement — player-damaged-achievement | ||
| minimum_damage | :: | float |
| should_survive | :: | bool |
| type_of_dealer | :: | 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
minimum_damage
Type: float
This will trigger the achievement, if the amount of damage taken by the dealer, is more than this.
minimum_damage = 500,
should_survive
Type: bool
This sets the achievement to only trigger, if you survive the minimum amount of damage. If you don't need to survive, false.
should_survive = true,
Optional properties
type_of_dealer
Type: string
Default: ""
This will trigger the achievement, if the player takes damage from this specific entity type.
type_of_dealer = "locomotive",