UseItemAchievementPrototype - Prototype Docs

Home / Prototypes / UseItemAchievementPrototype><

UseItemAchievementPrototype 'use-item-achievement' new

This prototype is used for receiving an achievement when the player uses a capsule.

Inherits from AchievementPrototype « Prototype « PrototypeBase

Properties

to_use	:: ItemID	This will trigger the achievement, if this capsule is used.
This will trigger the achievement, if this capsule is used.
limit_quality	:: QualityID
amount optional	:: uint32	How many capsules need to be used.
How many capsules need to be used.
limited_to_one_game optional	:: bool	If this is false, the player carries over their statistics from this achievement through all their saves.
If this is false, the player carries over their statistics from this achievement through all their saves.

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	:: bool	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. [...]

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_descriptionnew optional	:: LocalisedString	Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
subgroupnew optional	:: ItemSubGroupID	The name of an ItemSubGroup.
The name of an ItemSubGroup.
hiddennew optional	:: bool
hidden_in_factoriopedianew optional	:: bool
parameternew optional	:: bool	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_simulationnew 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.

limit_quality	:: QualityID
to_use	:: ItemID	This will trigger the achievement, if this capsule is used.
This will trigger the achievement, if this capsule is used.
amount optional	:: uint32	How many capsules need to be used.
How many capsules need to be used.
limited_to_one_game optional	:: bool	If this is false, the player carries over their statistics from this achievement through all their saves.
If this is false, the player carries over their statistics from this achievement through all their saves.

Inherited from AchievementPrototype

allowed_without_fight optional	:: bool	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

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_descriptionnew optional	:: LocalisedString	Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
factoriopedia_simulationnew 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.
hiddennew optional	:: bool
hidden_in_factoriopedianew optional	:: bool
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. [...]
parameternew optional	:: bool	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.
subgroupnew optional	:: ItemSubGroupID	The name of an ItemSubGroup.
The name of an ItemSubGroup.

Properties

to_use :: ItemID

This will trigger the achievement, if this capsule is used.

Example

to_use = "raw-fish"

limit_quality :: QualityID

amount :: uint32 optional

Default: 1

How many capsules need to be used.

limited_to_one_game :: bool optional

Default: false

If this is false, the player carries over their statistics from this achievement through all their saves.

Factorio Prototype Docs Version 2.0.20

UseItemAchievementPrototype 'use-item-achievement' new

Properties

Properties

to_use :: ItemID

Example

limit_quality :: QualityID

amount :: uint32 optional

limited_to_one_game :: bool optional

Prototypes

Types

Defines

Factorio Prototype DocsVersion 2.0.20

UseItemAchievementPrototype 'use-item-achievement' new

Properties

Properties

to_use :: ItemID

Example

limit_quality :: QualityID

amount :: uint32 optional

limited_to_one_game :: bool optional

Prototypes

Types

Defines

Factorio Prototype Docs Version 2.0.20