KillAchievementPrototype - Prototype Docs

Home / Prototypes / KillAchievementPrototype><

KillAchievementPrototype 'kill-achievement'

This prototype is used for receiving an achievement when the player destroys a certain amount of an entity, with a specific damage type.

Inherits from AchievementPrototype « Prototype « PrototypeBase

Properties

default

sorted

to_kill optional	:: EntityID or array[EntityID]	This defines which entity needs to be destroyed in order to receive the achievement.
This defines which entity needs to be destroyed in order to receive the achievement.
type_to_kill optional	:: string	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.
damage_type optional	:: DamageTypeID	This defines how the player needs to destroy the specific entity.
This defines how the player needs to destroy the specific entity.
damage_dealer optional	:: EntityID or array[EntityID]	The killer of the entity must be one of these entities.
The killer of the entity must be one of these entities.
amount optional	:: uint32	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.
in_vehicle optional	:: boolean	This defines if the player needs to be in a vehicle.
This defines if the player needs to be in a vehicle.
personally optional	:: boolean	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.

Inherited from AchievementPrototype

icons optional	:: array[IconData]	Can't be an empty array.
Can't be an empty array.
icon optional	:: FileName	Path to the icon file. [...]
Path to the icon file. [...]
icon_size optional	:: SpriteSizeType	The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
steam_stats_name optional	:: string	Unusable by mods, as this refers to unlocking the achievement through Steam.
Unusable by mods, as this refers to unlocking the achievement through Steam.
allowed_without_fight optional	:: boolean	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.
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.

Inherited from Prototype

factoriopedia_alternative optional	:: string	The ID type corresponding to the prototype that inherits from this. [...]
The ID type corresponding to the prototype that inherits from this. [...]
custom_tooltip_fields optional	:: array[CustomTooltipField]	Allows to add extra description items to the tooltip and Factoriopedia.
Allows to add extra description items to the tooltip and Factoriopedia.

Inherited from PrototypeBase

type	:: string	Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
name	:: string	Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
order optional	:: Order	Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
localised_name optional	:: LocalisedString	Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
localised_description optional	:: LocalisedString	Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
factoriopedia_description optional	:: LocalisedString	Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
subgroup optional	:: ItemSubGroupID	The name of an ItemSubGroup.
The name of an ItemSubGroup.
hidden optional	:: boolean
hidden_in_factoriopedia optional	:: boolean
parameter optional	:: boolean	Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
factoriopedia_simulation optional	:: SimulationDefinition	The simulation shown when looking at this prototype in the Factoriopedia GUI.
The simulation shown when looking at this prototype in the Factoriopedia GUI.

amount optional	:: uint32	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.
damage_dealer optional	:: EntityID or array[EntityID]	The killer of the entity must be one of these entities.
The killer of the entity must be one of these entities.
damage_type optional	:: DamageTypeID	This defines how the player needs to destroy the specific entity.
This defines how the player needs to destroy the specific entity.
in_vehicle optional	:: boolean	This defines if the player needs to be in a vehicle.
This defines if the player needs to be in a vehicle.
personally optional	:: boolean	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.
to_kill optional	:: EntityID or array[EntityID]	This defines which entity needs to be destroyed in order to receive the achievement.
This defines which entity needs to be destroyed in order to receive the achievement.
type_to_kill optional	:: string	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.

Inherited from AchievementPrototype

allowed_without_fight optional	:: boolean	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.
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.
icon optional	:: FileName	Path to the icon file. [...]
Path to the icon file. [...]
icon_size optional	:: SpriteSizeType	The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
icons optional	:: array[IconData]	Can't be an empty array.
Can't be an empty array.
steam_stats_name optional	:: string	Unusable by mods, as this refers to unlocking the achievement through Steam.
Unusable by mods, as this refers to unlocking the achievement through Steam.

Inherited from Prototype

custom_tooltip_fields optional	:: array[CustomTooltipField]	Allows to add extra description items to the tooltip and Factoriopedia.
Allows to add extra description items to the tooltip and Factoriopedia.
factoriopedia_alternative optional	:: string	The ID type corresponding to the prototype that inherits from this. [...]
The ID type corresponding to the prototype that inherits from this. [...]

Inherited from PrototypeBase

name	:: string	Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
type	:: string	Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
factoriopedia_description optional	:: LocalisedString	Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
factoriopedia_simulation optional	:: SimulationDefinition	The simulation shown when looking at this prototype in the Factoriopedia GUI.
The simulation shown when looking at this prototype in the Factoriopedia GUI.
hidden optional	:: boolean
hidden_in_factoriopedia optional	:: boolean
localised_description optional	:: LocalisedString	Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
localised_name optional	:: LocalisedString	Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
order optional	:: Order	Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
parameter optional	:: boolean	Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
subgroup optional	:: ItemSubGroupID	The name of an ItemSubGroup.
The name of an ItemSubGroup.

Properties

to_kill :: EntityID or array[EntityID] optional

This defines which entity needs to be destroyed in order to receive the achievement.

type_to_kill :: string optional

This defines what entity type needs to be destroyed in order to receive the achievement.

Example

type_to_kill = "inserter"

damage_type :: DamageTypeID optional

This defines how the player needs to destroy the specific entity.

Example

damage_type = "impact"

damage_dealer :: EntityID or array[EntityID] optional

The killer of the entity must be one of these entities.

Examples

damage_dealer = "artillery-turret"

damage_dealer = {"artillery-turret", "artillery-wagon"}

amount :: uint32 optional

Default: 1

This is the amount of entity of the specified type the player needs to destroy to receive the achievement.

Example

amount = 100

in_vehicle :: boolean optional

Default: false

This defines if the player needs to be in a vehicle.

Example

in_vehicle = true

personally :: boolean optional

Default: false

This defines to make sure you are the one driving, for instance, in a tank rather than an automated train.

Example

personally = true

Factorio Prototype Docs Version 2.0.72

KillAchievementPrototype 'kill-achievement'

Properties

Properties

to_kill :: EntityID or array[EntityID] optional

type_to_kill :: string optional

Example

damage_type :: DamageTypeID optional

Example

damage_dealer :: EntityID or array[EntityID] optional

Examples

amount :: uint32 optional

Example

in_vehicle :: boolean optional

Example

personally :: boolean optional

Example

Prototypes

Types

Defines

Factorio Prototype DocsVersion 2.0.72

KillAchievementPrototype 'kill-achievement'

Properties

Properties

to_kill :: EntityID or array[EntityID] optional

type_to_kill :: string optional

Example

damage_type :: DamageTypeID optional

Example

damage_dealer :: EntityID or array[EntityID] optional

Examples

amount :: uint32 optional

Example

in_vehicle :: boolean optional

Example

personally :: boolean optional

Example

Prototypes

Types

Defines

Factorio Prototype Docs Version 2.0.72