Prototype/Item

Prototype definitions » PrototypeBase » Prototype/Item

Basics

Prototype type: item

Possible configuration for all items

Extensions

• Prototype/AmmoItem ammo
• Prototype/Capsule capsule
• Prototype/Gun gun
• Prototype/ItemWithEntityData item-with-entity-data
• Prototype/ItemWithLabel item-with-label
  • Prototype/ItemWithInventory item-with-inventory
    • Prototype/BlueprintBook blueprint-book
  • Prototype/ItemWithTags item-with-tags
  • Prototype/SelectionTool selection-tool
    • Prototype/BlueprintItem blueprint
    • Prototype/CopyPasteTool copy-paste-tool
    • Prototype/DeconstructionItem deconstruction-item
    • Prototype/UpgradeItem upgrade-item
• Prototype/Module module
• Prototype/RailPlanner rail-planner
• Prototype/Tool tool
  • Prototype/Armor armor
  • Prototype/MiningTool mining-tool (for migration, cannot be used)
  • Prototype/RepairTool repair-tool

Mandatory properties

Inherits all properties from PrototypeBase.

icons, icon, icon_size (IconSpecification)

Type: Types/IconSpecification

stack_size

Type: Types/ItemCountType

Count of items of the same name that can be stored in one inventory slot. Must be 1 when stackable is false.

 stack_size = 64

flags

Type: Types/ItemPrototypeFlags

Specifies some properties of the item.

 flags = { "hidden" }

Optional properties

place_result

Type: Types/string

Default: ""

Name of prototype/Entity that can be built using this item

 place_result = "wooden-chest"

placed_as_equipment_result

Type: Types/string

Default: ""

subgroup

Type: Types/string

Default: "other"

Empty text of subgroup is not allowed. (You can ommit the definition to get the default "other").

place_as_tile

Type: Types/PlaceAsTile

stackable

Type: Types/bool

Default: true

primary_place_result_item

Type: Types/bool

Default: false

can_be_mod_opened

Type: Types/bool

Default: false

Only works for Prototype/SelectionTool and derived classes.

default_request_amount

Type: Types/ItemCountType

Default: The stack size of this item.

wire_count

Type: Types/ItemCountType

Default: 0

fuel_value

Type: Types/Energy

Default: "0J"

Mandatory when fuel_acceleration_multiplier, fuel_top_speed_multiplier, fuel_emissions_multiplier, or fuel_glow_color are used. Amount of energy it gives when used as fuel.

fuel_category

Type: Types/string

Default: ""

Must exist when a fuel_value is defined. Name of one of the fuel categories.

burnt_result

Type: Types/string

Default: ""

The item that is the result when this item gets burned as fuel.

fuel_acceleration_multiplier

Type: Types/double

Default: 1.0

fuel_top_speed_multiplier

Type: Types/double

Default: 1.0

fuel_emissions_multiplier

Type: Types/double

Default: 1.0

fuel_glow_color

Type: Types/Color

Default: {r=0, g=0, b=0, a=1}

Colors the glow of the burner energy source when this fuel is burned.

pictures

Type: Types/SpriteVariations

Used to give the item multiple different icons so that they look less uniform on belts etc. For inventory icons and similar, icon/icons will be used. Maximum number of variations is 16.

dark_background_icons, dark_background_icon, icon_size (IconSpecification)

Type: Types/IconSpecification

A dark background sprite. Uses dark_background_icons instead of icons and dark_background_icon instead of icon. Inside dark_background_icons, the property for the file path is dark_background_icons instead of icons.

rocket_launch_products

Type: Types/table (array) of Types/ItemProductPrototype

rocket_launch_product

Type: Types/ItemProductPrototype