Prototype/Achievement

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/AchievementPrototype.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

This prototype definition is used for the in-game achievements.

Prototype/Achievement — 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)

Extensions

• Prototype/BuildEntityAchievement build-entity-achievement
• Prototype/CombatRobotCountAchievement combat-robot-count
• Prototype/ConstructWithRobotsAchievement construct-with-robots-achievement
• Prototype/DeconstructWithRobotsAchievement deconstruct-with-robots-achievement
• Prototype/DeliverByRobotsAchievement deliver-by-robots-achievement
• Prototype/DontBuildEntityAchievement dont-build-entity-achievement
• Prototype/DontCraftManuallyAchievement dont-craft-manually-achievement
• Prototype/DontUseEntityInEnergyProductionAchievement dont-use-entity-in-energy-production-achievement
• Prototype/FinishTheGameAchievement finish-the-game-achievement
• Prototype/GroupAttackAchievement group-attack-achievement
• Prototype/KillAchievement kill-achievement
• Prototype/PlayerDamagedAchievement player-damaged-achievement
• Prototype/ProduceAchievement produce-achievement
• Prototype/ProducePerHourAchievement produce-per-hour-achievement
• Prototype/ResearchAchievement research-achievement
• Prototype/TrainPathAchievement train-path-achievement

Mandatory properties

Inherits all properties from PrototypeBase.

icons, icon, icon_size (IconSpecification)

Type: IconSpecification

Optional properties

steam_stats_name

Type: string
Default: ""
Unusable by mods, as this refers to unlocking the achievement through Steam.

allowed_without_fight

Type: bool
Default: true
If this is set to false, it is not possible to complete the achievement on the peaceful difficulty setting or when the enemy base generation settings have been changed.

hidden

Type: bool
Default: false

Example

{
    type = "achievement",
    name = "so-long-and-thanks-for-all-the-fish",
    order = "g[secret]-a[so-long-and-thanks-for-all-the-fish]",
    icon = "__base__/graphics/achievement/so-long-and-thanks-for-all-the-fish.png",
    icon_size = 128
  }