Prototype/Item: Difference between revisions
(0.18.10: place_result and localised_name behaviour) |
m (fuel_glow_color for reactors) |
||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 20: | Line 20: | ||
* [[Prototype/Module]] '''module''' | * [[Prototype/Module]] '''module''' | ||
* [[Prototype/RailPlanner]] '''rail-planner''' | * [[Prototype/RailPlanner]] '''rail-planner''' | ||
* [[Prototype/SpidertronRemote]] '''spidertron-remote''' | |||
* [[Prototype/Tool]] '''tool''' | * [[Prototype/Tool]] '''tool''' | ||
** [[Prototype/Armor]] '''armor''' | ** [[Prototype/Armor]] '''armor''' | ||
| Line 31: | Line 32: | ||
{{Prototype property|stack_size|[[Types/ItemCountType|ItemCountType]]}} | {{Prototype property|stack_size|[[Types/ItemCountType|ItemCountType]]}} | ||
Count of items of the same name that can be stored in one inventory slot. Must be 1 when <code>stackable</code> is | Count of items of the same name that can be stored in one inventory slot. Must be 1 when the <code>"not-stackable"</code> flag is set. | ||
stack_size = 64 | stack_size = 64 | ||
| Line 37: | Line 38: | ||
{{Prototype property|place_result|[[Types/string|string]]|""|optional=true}} | {{Prototype property|place_result|[[Types/string|string]]|""|optional=true}} | ||
Name of [[prototype/Entity]] that can be built using this item. The localised name of the entity will be used as the in-game item name. This behavior can be overwritten by specifying <code>localised_name</code> on this item, it will be used instead. | Name of [[prototype/Entity]] that can be built using this item. If this item should be the one that construction bots use to build the specified place_result, set the [[Types/ItemPrototypeFlags#"primary-place-result"|primary-place-result]] item flag. | ||
The localised name of the entity will be used as the in-game item name. This behavior can be overwritten by specifying <code>localised_name</code> on this item, it will be used instead. | |||
place_result = "wooden-chest" | place_result = "wooden-chest" | ||
| Line 43: | Line 46: | ||
{{Prototype property|subgroup|[[Types/string|string]]|"other"|optional=true}} | {{Prototype property|subgroup|[[Types/string|string]]|"other"|optional=true}} | ||
Name of a [[Prototype/ItemSubGroup]]. | |||
Empty text of subgroup is not allowed. (You can ommit the definition to get the default "other"). | Empty text of subgroup is not allowed. (You can ommit the definition to get the default "other"). | ||
| Line 63: | Line 68: | ||
{{Prototype property|wire_count|[[Types/ItemCountType|ItemCountType]]|0|optional=true}} | {{Prototype property|wire_count|[[Types/ItemCountType|ItemCountType]]|0|optional=true}} | ||
The number of items needed to connect 2 entities with this as wire. In the base game, [[green wire]], [[red wire]] and [[copper cable]] have this set to 1. | |||
{{Prototype property|fuel_value|[[Types/Energy|Energy]]|"0J"|optional=true}} | {{Prototype property|fuel_value|[[Types/Energy|Energy]]|"0J"|optional=true}} | ||
| Line 74: | Line 80: | ||
{{Prototype property|fuel_glow_color|[[Types/Color|Color]]|<nowiki>{r=0, g=0, b=0, a=1}</nowiki>|optional=true}} | {{Prototype property|fuel_glow_color|[[Types/Color|Color]]|<nowiki>{r=0, g=0, b=0, a=1}</nowiki>|optional=true}} | ||
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. Can also be used to color the glow of reactors burning the fuel, see [[Prototype/Reactor#use_fuel_glow_color]]. | ||
{{Prototype property|open_sound|[[Types/Sound|Sound]]|optional=true}} | |||
{{Prototype property|close_sound|[[Types/Sound|Sound]]|optional=true}} | |||
{{Prototype property|dark_background_icons, dark_background_icon, icon_size (IconSpecification)|[[Types/IconSpecification|IconSpecification]]|optional=true}} | {{Prototype property|dark_background_icons, dark_background_icon, icon_size (IconSpecification)|[[Types/IconSpecification|IconSpecification]]|optional=true}} | ||
A dark background sprite. Uses <code>dark_background_icons</code> instead of <code>icons</code> and <code>dark_background_icon</code> instead of <code>icon</code>. Inside <code>dark_background_icons</code>, the property for the file path is <code> | A dark background sprite. Uses <code>dark_background_icons</code> instead of <code>icons</code> and <code>dark_background_icon</code> instead of <code>icon</code>. Inside <code>dark_background_icons</code>, the property for the file path is <code>dark_background_icon</code> instead of <code>icon</code>. | ||
{{Prototype property|rocket_launch_products|[[Types/table|table]] (array) of [[Types/ItemProductPrototype|ItemProductPrototype]]|optional=true}} | {{Prototype property|rocket_launch_products|[[Types/table|table]] (array) of [[Types/ItemProductPrototype|ItemProductPrototype]]|optional=true}} | ||
{{Prototype property|rocket_launch_product|[[Types/ItemProductPrototype|ItemProductPrototype]]|optional=true}} | {{Prototype property|rocket_launch_product|[[Types/ItemProductPrototype|ItemProductPrototype]]|optional=true}} | ||
Latest revision as of 12:19, 3 December 2022
Prototype definitions » PrototypeBase » Prototype/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/ItemWithInventory item-with-inventory
- Prototype/Module module
- Prototype/RailPlanner rail-planner
- Prototype/SpidertronRemote spidertron-remote
- 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: IconSpecification
stack_size
Type: ItemCountType
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.
stack_size = 64
Optional properties
place_result
Type: string
Default: ""
Name of prototype/Entity that can be built using this item. If this item should be the one that construction bots use to build the specified place_result, set the primary-place-result item flag.
The localised name of the entity will be used as the in-game item name. This behavior can be overwritten by specifying localised_name on this item, it will be used instead.
place_result = "wooden-chest"
placed_as_equipment_result
Type: string
Default: ""
subgroup
Type: string
Default: "other"
Name of a Prototype/ItemSubGroup.
Empty text of subgroup is not allowed. (You can ommit the definition to get the default "other").
fuel_category
Type: string
Default: ""
Must exist when a fuel_value is defined. Name of one of the fuel categories.
burnt_result
Type: string
Default: ""
The item that is the result when this item gets burned as fuel.
place_as_tile
Type: PlaceAsTile
pictures
Type: 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.
flags
Type: ItemPrototypeFlags
Specifies some properties of the item.
flags = { "hidden" }
default_request_amount
Type: ItemCountType
Default: The stack size of this item.
wire_count
Type: ItemCountType
Default: 0
The number of items needed to connect 2 entities with this as wire. In the base game, green wire, red wire and copper cable have this set to 1.
fuel_value
Type: 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: double
Default: 1.0
fuel_top_speed_multiplier
Type: double
Default: 1.0
fuel_emissions_multiplier
Type: double
Default: 1.0
fuel_glow_color
Type: Color
Default: {r=0, g=0, b=0, a=1}
Colors the glow of the burner energy source when this fuel is burned. Can also be used to color the glow of reactors burning the fuel, see Prototype/Reactor#use_fuel_glow_color.
open_sound
Type: Sound
close_sound
Type: Sound
dark_background_icons, dark_background_icon, icon_size (IconSpecification)
Type: 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_icon instead of icon.
rocket_launch_products
Type: table (array) of ItemProductPrototype
rocket_launch_product
Type: ItemProductPrototype