Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Runtime Docs Version 2.0.77

# LuaAchievementPrototype - Runtime Docs

## Class LuaAchievementPrototype extends LuaPrototypeBase

Prototype of a achievement.

Inherits from LuaPrototypeBase

## Members

allowed_without_fight | :: R boolean |
objective_condition | :: R string? |
amount | :: R uint32? |
limited_to_one_game | :: R boolean? |
within | :: R uint32? |
to_build | :: R LuaEntityPrototype? |
surface | :: R string? |
count | :: R uint32? |
more_than_manually | :: R boolean? |
dont_build | :: R array[LuaEntityPrototype]? |
excluded | :: R array[LuaEntityPrototype]? |
included | :: R array[LuaEntityPrototype]? |
dont_research | :: R array[LuaItemPrototype]? |
research_with | :: R array[LuaItemPrototype]? |
last_hour_only | :: R boolean? |
minimum_energy_produced | :: R double? |
armor | :: R LuaItemPrototype? |
alternative_armor | :: R LuaItemPrototype? |
limit_quality | :: R LuaQualityPrototype? |
damage_type | :: R LuaDamagePrototype? |
damage_dealer | :: R array[LuaEntityPrototype]? |
to_kill | :: R array[LuaEntityPrototype]? |
personally | :: R boolean? |
in_vehicle | :: R boolean? |
type_to_kill | :: R string? |
not_to_kill | :: R LuaEntityPrototype? |
type_not_to_kill | :: R string? |
module | :: R array[LuaItemPrototype]? |
limit_equip_quality | :: R LuaQualityPrototype? |
minimum_damage | :: R float? |
should_survive | :: R boolean? |
type_of_dealer | :: R string? |
item_product | :: R LuaItemPrototype? |
quality | :: R LuaQualityPrototype? |
fluid_product | :: R LuaFluidPrototype? |
technology | :: R LuaTechnologyPrototype? |
research_all | :: R boolean? |
science_pack | :: R LuaItemPrototype? |
ammo_type | :: R LuaItemPrototype? |
minimum_distance | :: R double? |
to_use | :: R LuaItemPrototype? |
valid | :: R boolean | Is this object valid? [...]
Is this object valid? [...]
object_name | :: R string | The class name of this object. [...]
The class name of this object. [...]

Inherited from LuaPrototypeBase

type | :: R string | Type of this prototype.
Type of this prototype.
name | :: R string | Name of this prototype.
Name of this prototype.
order | :: R string | The string used to alphabetically sort these prototypes. [...]
The string used to alphabetically sort these prototypes. [...]
localised_name | :: R LocalisedString |
localised_description | :: R LocalisedString |
factoriopedia_description | :: R LocalisedString | Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
group | :: R LuaGroup | Group of this prototype.
Group of this prototype.
subgroup | :: R LuaGroup | Subgroup of this prototype.
Subgroup of this prototype.
hidden | :: R boolean |
hidden_in_factoriopedia | :: R boolean |
parameter | :: R boolean |
custom_tooltip_fields | :: R array[CustomTooltipField]? | Extra description items in the tooltip and Factoriopedia.
Extra description items in the tooltip and Factoriopedia.

## Attributes

### allowed_without_fight :: Read boolean

### objective_condition :: Read string?

### amount :: Read uint32?

### limited_to_one_game :: Read boolean?

### within :: Read uint32?

### to_build :: Read LuaEntityPrototype?

### surface :: Read string?

### count :: Read uint32?

### more_than_manually :: Read boolean?

### dont_build :: Read array[LuaEntityPrototype]?

### excluded :: Read array[LuaEntityPrototype]?

### included :: Read array[LuaEntityPrototype]?

### dont_research :: Read array[LuaItemPrototype]?

### research_with :: Read array[LuaItemPrototype]?

### last_hour_only :: Read boolean?

### minimum_energy_produced :: Read double?

### armor :: Read LuaItemPrototype?

### alternative_armor :: Read LuaItemPrototype?

### limit_quality :: Read LuaQualityPrototype?

### damage_type :: Read LuaDamagePrototype?

### damage_dealer :: Read array[LuaEntityPrototype]?

### to_kill :: Read array[LuaEntityPrototype]?

### personally :: Read boolean?

### in_vehicle :: Read boolean?

### type_to_kill :: Read string?

### not_to_kill :: Read LuaEntityPrototype?

### type_not_to_kill :: Read string?

### module :: Read array[LuaItemPrototype]?

### limit_equip_quality :: Read LuaQualityPrototype?

### minimum_damage :: Read float?

### should_survive :: Read boolean?

### type_of_dealer :: Read string?

### item_product :: Read LuaItemPrototype?

### quality :: Read LuaQualityPrototype?

### fluid_product :: Read LuaFluidPrototype?

### technology :: Read LuaTechnologyPrototype?

### research_all :: Read boolean?

### science_pack :: Read LuaItemPrototype?

### ammo_type :: Read LuaItemPrototype?

### minimum_distance :: Read double?

### to_use :: Read LuaItemPrototype?

### valid :: Read boolean

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.

### object_name :: Read string

The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

Class used in

- LuaPrototypes::get_achievement_filtered()
- LuaPrototypes::achievement
- on_achievement_gained