Prototype/UpgradeItem

Prototype definitions » PrototypeBase » Prototype/Item » Prototype/ItemWithLabel » Prototype/SelectionTool » Prototype/UpgradeItem

An upgrade planner.

Prototype/UpgradeItem — upgrade-item
mapper_count	::	ItemStackIndex (optional)
Inherited from Prototype/SelectionTool
alt_selection_color	::	Color
alt_selection_cursor_box_type	::	CursorBoxType
alt_selection_mode	::	table of string
selection_color	::	Color
selection_cursor_box_type	::	CursorBoxType
selection_mode	::	table of string
alt_entity_filter_mode	::	string (optional)
alt_entity_filters	::	table of string (optional)
alt_entity_type_filters	::	table of string (optional)
alt_reverse_entity_filter_mode	::	string (optional)
alt_reverse_entity_filters	::	table of string (optional)
alt_reverse_entity_type_filters	::	table of string (optional)
alt_reverse_selection_color	::	Color (optional)
alt_reverse_selection_count_button_color	::	Color (optional)
alt_reverse_selection_cursor_box_type	::	CursorBoxType (optional)
alt_reverse_selection_mode	::	table of string (optional)
alt_reverse_tile_filter_mode	::	string (optional)
alt_reverse_tile_filters	::	table of string (optional)
alt_selection_count_button_color	::	Color (optional)
alt_tile_filter_mode	::	string (optional)
alt_tile_filters	::	table of string (optional)
always_include_tiles	::	bool (optional)
chart_alt_reverse_selection_color	::	Color (optional)
chart_alt_selection_color	::	Color (optional)
chart_reverse_selection_color	::	Color (optional)
chart_selection_color	::	Color (optional)
entity_filter_mode	::	string (optional)
entity_filters	::	table of string (optional)
entity_type_filters	::	table of string (optional)
mouse_cursor	::	string (optional)
reverse_entity_filter_mode	::	string (optional)
reverse_entity_filters	::	table of string (optional)
reverse_entity_type_filters	::	table of string (optional)
reverse_selection_color	::	Color (optional)
reverse_selection_count_button_color	::	Color (optional)
reverse_selection_cursor_box_type	::	CursorBoxType (optional)
reverse_selection_mode	::	table of string (optional)
reverse_tile_filter_mode	::	string (optional)
reverse_tile_filters	::	table of string (optional)
selection_count_button_color	::	Color (optional)
tile_filter_mode	::	string (optional)
tile_filters	::	table of string (optional)
Inherited from Prototype/ItemWithLabel
default_label_color	::	Color (optional)
draw_label_for_cursor_render	::	bool (optional)
Inherited from Prototype/Item
icons, icon, icon_size (IconSpecification)	::	IconSpecification
stack_size	::	ItemCountType
burnt_result	::	string (optional)
close_sound	::	Sound (optional)
dark_background_icons, dark_background_icon, icon_size (IconSpecification)	::	IconSpecification (optional)
default_request_amount	::	ItemCountType (optional)
flags	::	ItemPrototypeFlags (optional)
fuel_acceleration_multiplier	::	double (optional)
fuel_category	::	string (optional)
fuel_emissions_multiplier	::	double (optional)
fuel_glow_color	::	Color (optional)
fuel_top_speed_multiplier	::	double (optional)
fuel_value	::	Energy (optional)
open_sound	::	Sound (optional)
pictures	::	SpriteVariations (optional)
place_as_tile	::	PlaceAsTile (optional)
place_result	::	string (optional)
placed_as_equipment_result	::	string (optional)
rocket_launch_product	::	ItemProductPrototype (optional)
rocket_launch_products	::	table (array) of ItemProductPrototype (optional)
subgroup	::	string (optional)
wire_count	::	ItemCountType (optional)
Inherited from PrototypeBase
name	::	string
type	::	string
localised_description	::	LocalisedString (optional)
localised_name	::	LocalisedString (optional)
order	::	Order (optional)

Optional properties

This prototype inherits all the properties from Prototype/SelectionTool.

mapper_count

Type: ItemStackIndex
Default: 0
Can't be > 255.

Differing defaults

show_in_library defaults to true instead of false. show_in_library is unused as of 0.18.13 as the ability to show any selection tools in the blueprint library was removed.

Mandatory values

Upgrade items must have a stack size of 1.

Ignored properties

Prototype/UpgradeItem ignores the following properties that it inherits from Prototype/SelectionTool:

• selection_mode (forced to be "upgrade")
• alt_selection_mode (forced to be "cancel-upgrade")
• always_include_tiles (forced to be false)
• entity_filters
• entity_type_filters
• tile_filters
• entity_filter_mode
• tile_filter_mode
• alt_entity_filters
• alt_entity_type_filters
• alt_tile_filters
• alt_entity_filter_mode
• alt_tile_filter_mode