BlueprintBookPrototype - Prototype Docs

Home / Prototypes / BlueprintBookPrototype <>

BlueprintBookPrototype - 'blueprint-book'

A blueprint book.

Inherits from ItemWithInventoryPrototype « ItemWithLabelPrototype « ItemPrototype « PrototypeBase

Properties

default

sorted

No new properties

Inherited from ItemWithInventoryPrototype

inventory_size [overridden]	:: ItemStackIndex	The inventory size of the item.
The inventory size of the item.
item_filters optional	:: array[ItemID]	A list of explicit item names to be used as filters.
A list of explicit item names to be used as filters.
item_group_filters optional	:: array[ItemGroupID]	A list of explicit item group names to be used as filters.
A list of explicit item group names to be used as filters.
item_subgroup_filters optional	:: array[ItemSubGroupID]	A list of explicit item subgroup names to be used as filters.
A list of explicit item subgroup names to be used as filters.
filter_mode optional	:: `"blacklist"` or `"whitelist"`	This determines how filters are applied.
This determines how filters are applied.
filter_message_key optional	:: string	The locale key used when the player attempts to put an item that doesn't match the filter rules into the item-with-inventory.
The locale key used when the player attempts to put an item that doesn't match the filter rules into the item-with-inventory.
extends_inventory_by_default optional	:: bool	When true, this item-with-inventory will extend the inventory it sits in by default.
When true, this item-with-inventory will extend the inventory it sits in by default.
insertion_priority_mode optional	:: union	The insertion priority mode for this item.
The insertion priority mode for this item.

Inherited from ItemWithLabelPrototype

default_label_color optional	:: Color	The default label color the item will use.
The default label color the item will use.
draw_label_for_cursor_render [overridden] optional	:: bool	If the item will draw its label when held in the cursor in place of the item count.
If the item will draw its label when held in the cursor in place of the item count.

Inherited from ItemPrototype

stack_size [overridden]	:: ItemCountType	Count of items of the same name that can be stored in one inventory slot.
Count of items of the same name that can be stored in one inventory slot.
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, e.g.
The size of the square icon, in pixels, e.g.
icon_mipmaps optional	:: IconMipMapType	Icons of reduced size will be used at decreased scale.
Icons of reduced size will be used at decreased scale.
dark_background_icons optional	:: array[IconData]	Inside IconData, the property for the file path is `dark_background_icon` instead of `icon`.
Inside IconData, the property for the file path is `dark_background_icon` instead of `icon`.
dark_background_icon optional	:: FileName	Path to the icon file.
Path to the icon file.
place_result optional	:: EntityID	Name of the EntityPrototype that can be built using this item.
Name of the EntityPrototype that can be built using this item.
placed_as_equipment_result optional	:: EquipmentID
subgroup optional	:: ItemSubGroupID	Empty text of subgroup is not allowed.
Empty text of subgroup is not allowed.
fuel_category optional	:: FuelCategoryID	Must exist when a nonzero fuel_value is defined.
Must exist when a nonzero fuel_value is defined.
burnt_result optional	:: ItemID	The item that is the result when this item gets burned as fuel.
The item that is the result when this item gets burned as fuel.
place_as_tile optional	:: PlaceAsTile
pictures optional	:: SpriteVariations	Used to give the item multiple different icons so that they look less uniform on belts etc.
Used to give the item multiple different icons so that they look less uniform on belts etc.
flags optional	:: ItemPrototypeFlags	Specifies some properties of the item.
Specifies some properties of the item.
default_request_amount optional	:: ItemCountType
wire_count optional	:: ItemCountType	The number of items needed to connect 2 entities with this as wire.
The number of items needed to connect 2 entities with this as wire.
fuel_value optional	:: Energy	Mandatory when `fuel_acceleration_multiplier`, `fuel_top_speed_multiplier` or `fuel_emissions_multiplier` or `fuel_glow_color` are used.
Mandatory when `fuel_acceleration_multiplier`, `fuel_top_speed_multiplier` or `fuel_emissions_multiplier` or `fuel_glow_color` are used.
fuel_acceleration_multiplier optional	:: double
fuel_top_speed_multiplier optional	:: double
fuel_emissions_multiplier optional	:: double
fuel_glow_color optional	:: Color	Colors the glow of the burner energy source when this fuel is burned.
Colors the glow of the burner energy source when this fuel is burned.
open_sound optional	:: Sound
close_sound optional	:: Sound
rocket_launch_products optional	:: array[ItemProductPrototype]
rocket_launch_product optional	:: ItemProductPrototype	Only loaded if `rocket_launch_products` is not defined.
Only loaded if `rocket_launch_products` is not defined.

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.

No new properties

Inherited from ItemWithInventoryPrototype

inventory_size [overridden]	:: ItemStackIndex	The inventory size of the item.
The inventory size of the item.
extends_inventory_by_default optional	:: bool	When true, this item-with-inventory will extend the inventory it sits in by default.
When true, this item-with-inventory will extend the inventory it sits in by default.
filter_message_key optional	:: string	The locale key used when the player attempts to put an item that doesn't match the filter rules into the item-with-inventory.
The locale key used when the player attempts to put an item that doesn't match the filter rules into the item-with-inventory.
filter_mode optional	:: `"blacklist"` or `"whitelist"`	This determines how filters are applied.
This determines how filters are applied.
insertion_priority_mode optional	:: union	The insertion priority mode for this item.
The insertion priority mode for this item.
item_filters optional	:: array[ItemID]	A list of explicit item names to be used as filters.
A list of explicit item names to be used as filters.
item_group_filters optional	:: array[ItemGroupID]	A list of explicit item group names to be used as filters.
A list of explicit item group names to be used as filters.
item_subgroup_filters optional	:: array[ItemSubGroupID]	A list of explicit item subgroup names to be used as filters.
A list of explicit item subgroup names to be used as filters.

Inherited from ItemWithLabelPrototype

default_label_color optional	:: Color	The default label color the item will use.
The default label color the item will use.
draw_label_for_cursor_render [overridden] optional	:: bool	If the item will draw its label when held in the cursor in place of the item count.
If the item will draw its label when held in the cursor in place of the item count.

Inherited from ItemPrototype

stack_size [overridden]	:: ItemCountType	Count of items of the same name that can be stored in one inventory slot.
Count of items of the same name that can be stored in one inventory slot.
burnt_result optional	:: ItemID	The item that is the result when this item gets burned as fuel.
The item that is the result when this item gets burned as fuel.
close_sound optional	:: Sound
dark_background_icon optional	:: FileName	Path to the icon file.
Path to the icon file.
dark_background_icons optional	:: array[IconData]	Inside IconData, the property for the file path is `dark_background_icon` instead of `icon`.
Inside IconData, the property for the file path is `dark_background_icon` instead of `icon`.
default_request_amount optional	:: ItemCountType
flags optional	:: ItemPrototypeFlags	Specifies some properties of the item.
Specifies some properties of the item.
fuel_acceleration_multiplier optional	:: double
fuel_category optional	:: FuelCategoryID	Must exist when a nonzero fuel_value is defined.
Must exist when a nonzero fuel_value is defined.
fuel_emissions_multiplier optional	:: double
fuel_glow_color optional	:: Color	Colors the glow of the burner energy source when this fuel is burned.
Colors the glow of the burner energy source when this fuel is burned.
fuel_top_speed_multiplier optional	:: double
fuel_value optional	:: Energy	Mandatory when `fuel_acceleration_multiplier`, `fuel_top_speed_multiplier` or `fuel_emissions_multiplier` or `fuel_glow_color` are used.
Mandatory when `fuel_acceleration_multiplier`, `fuel_top_speed_multiplier` or `fuel_emissions_multiplier` or `fuel_glow_color` are used.
icon optional	:: FileName	Path to the icon file.
Path to the icon file.
icon_mipmaps optional	:: IconMipMapType	Icons of reduced size will be used at decreased scale.
Icons of reduced size will be used at decreased scale.
icon_size optional	:: SpriteSizeType	The size of the square icon, in pixels, e.g.
The size of the square icon, in pixels, e.g.
icons optional	:: array[IconData]	Can't be an empty array.
Can't be an empty array.
open_sound optional	:: Sound
pictures optional	:: SpriteVariations	Used to give the item multiple different icons so that they look less uniform on belts etc.
Used to give the item multiple different icons so that they look less uniform on belts etc.
place_as_tile optional	:: PlaceAsTile
place_result optional	:: EntityID	Name of the EntityPrototype that can be built using this item.
Name of the EntityPrototype that can be built using this item.
placed_as_equipment_result optional	:: EquipmentID
rocket_launch_product optional	:: ItemProductPrototype	Only loaded if `rocket_launch_products` is not defined.
Only loaded if `rocket_launch_products` is not defined.
rocket_launch_products optional	:: array[ItemProductPrototype]
subgroup optional	:: ItemSubGroupID	Empty text of subgroup is not allowed.
Empty text of subgroup is not allowed.
wire_count optional	:: ItemCountType	The number of items needed to connect 2 entities with this as wire.
The number of items needed to connect 2 entities with this as wire.

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

Overridden Properties

inventory_size :: ItemStackIndex or `"dynamic"`

The inventory size of the item.

stack_size :: `1`

Count of items of the same name that can be stored in one inventory slot. Must be 1 when the "not-stackable" flag is set.

Example

stack_size = 1

draw_label_for_cursor_render :: bool optional

Default: true

If the item will draw its label when held in the cursor in place of the item count.

Factorio Prototype Docs Version 1.1.91

BlueprintBookPrototype - 'blueprint-book'

Properties

Overridden Properties

inventory_size :: ItemStackIndex or `"dynamic"`

stack_size :: `1`

Example

draw_label_for_cursor_render :: bool optional

Prototypes

Types

Factorio Prototype Docs Version 1.1.91

BlueprintBookPrototype - 'blueprint-book'

Properties

Overridden Properties

inventory_size :: ItemStackIndex or "dynamic"

stack_size :: 1

Example

draw_label_for_cursor_render :: bool optional

Prototypes

Types

inventory_size :: ItemStackIndex or `"dynamic"`

stack_size :: `1`