Prototype/Item: Difference between revisions
(Added prototype type to page) |
|||
| Line 1: | Line 1: | ||
==Basics== | ==Basics== | ||
Prototype type: '''item''' | |||
Possible configuration for all items | Possible configuration for all items | ||
== Extensions == | == Extensions == | ||
Revision as of 16:28, 21 January 2019
Basics
Prototype type: item
Possible configuration for all items
Extensions
- Prototype/AmmoItem ammo
- Prototype/Capsule capsule (Capsule such as the combat capsules, but also grenades (and the raw fish).)
- Prototype/Gun gun (Ammunition for guns.)
- Prototype/ItemWithEntityData item-with-entity-data (Can be used to store arbitrary data using script.)
- Prototype/ItemWithLabel item-with-label (Similar to a standard item but with the ability to be labeled.)
- Prototype/ItemWithInventory item-with-inventory (An item type that itself has an inventory of other items.)
- Prototype/BlueprintBook blueprint-book
- Prototype/ItemWithTags item-with-tags
- Prototype/SelectionTool selection-tool (An item type used for selecting entities in the world.)
- Prototype/BlueprintItem blueprint
- Prototype/DeconstructionItem deconstruction-item
- Prototype/ItemWithInventory item-with-inventory (An item type that itself has an inventory of other items.)
- Prototype/Module module
- Prototype/RailPlanner rail-planner
- Prototype/Tool tool (Items with a "durability".)
- Prototype/Armor armor (Used as player protection.)
- Prototype/MiningTool mining-tool (Used for mining resources and/or as a melee weapon.)
- Prototype/RepairTool repair-tool
Mandatory properties
Inherits all properties from Prototype.
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 = { "goes-to-quickbar" }
Possible values are:
| Item | meaning |
|---|---|
| goes-to-quickbar | Item is moved to quick bar by default |
| goes-to-main-inventory | Item is moved to main inventory by default |
| hidden | Item will not appear in lists of all items such as those for logistics requests, filters, etc. |
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
default_request_amount
Type: Types/ItemCountType
Default: The stack size of this item.
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_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_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.
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.