Prototype/Item: Difference between revisions
 Set prototype parent  | 
				 Converted to SMW format  | 
				||
| Line 1: | Line 1: | ||
{{Prototype parent|PrototypeBase}}  | {{Prototype parent|PrototypeBase}}  | ||
Possible configuration for all items.  | |||
{{Prototype TOC|item}}  | |||
Prototype   | |||
== Extensions ==  | == Extensions ==  | ||
* [[Prototype/AmmoItem]] '''ammo'''  | * [[Prototype/AmmoItem]] '''ammo'''  | ||
| Line 29: | Line 28: | ||
Inherits all properties from [[PrototypeBase]].  | Inherits all properties from [[PrototypeBase]].  | ||
{{Prototype property|icons, icon,  icon_size (IconSpecification)|[[Types/IconSpecification|IconSpecification]]}}  | |||
{{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 false.  | Count of items of the same name that can be stored in one inventory slot. Must be 1 when <code>stackable</code> is false.  | ||
   stack_size = 64  |    stack_size = 64  | ||
{{Prototype property|flags|[[Types/ItemPrototypeFlags|ItemPrototypeFlags]]}}  | |||
Specifies some properties of the item.  | Specifies some properties of the item.  | ||
   flags = { "hidden" }  |    flags = { "hidden" }  | ||
== Optional properties ==  | == Optional properties ==  | ||
{{Prototype property|place_result|[[Types/string|string]]|""|optional=true}}  | |||
Name of [[prototype/Entity]] that can be built using this item  | Name of [[prototype/Entity]] that can be built using this item  | ||
   place_result = "wooden-chest"  |    place_result = "wooden-chest"  | ||
{{Prototype property|placed_as_equipment_result|[[Types/string|string]]|""|optional=true}}  | |||
=  | |||
{{Prototype property|subgroup|[[Types/string|string]]|"other"|optional=true}}  | |||
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").  | ||
{{Prototype property|place_as_tile|[[Types/PlaceAsTile|PlaceAsTile]]|optional=true}}  | |||
{{Prototype property|stackable|[[Types/bool|bool]]|true|optional=true}}  | |||
{{Prototype property|primary_place_result_item|[[Types/bool|bool]]|false|optional=true}}  | |||
=  | |||
{{Prototype property|can_be_mod_opened|[[Types/bool|bool]]|false|optional=true}}  | |||
Only works for [[Prototype/SelectionTool]] and derived classes.  | Only works for [[Prototype/SelectionTool]] and derived classes.  | ||
{{Prototype property|default_request_amount|[[Types/ItemCountType|ItemCountType]]|The stack size of this item.|optional=true}}  | |||
{{Prototype property|wire_count|[[Types/ItemCountType|ItemCountType]]|0|optional=true}}  | |||
{{Prototype property|fuel_value|[[Types/Energy|Energy]]|"0J"|optional=true}}  | |||
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.  | 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.  | ||
{{Prototype property|fuel_category|[[Types/string|string]]|""|optional=true}}  | |||
Must exist when a fuel_value is defined. Name of one of the [[Prototype/FuelCategory|fuel categories]].  | Must exist when a fuel_value is defined. Name of one of the [[Prototype/FuelCategory|fuel categories]].  | ||
{{Prototype property|burnt_result|[[Types/string|string]]|""|optional=true}}  | |||
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.  | ||
{{Prototype property|fuel_acceleration_multiplier|[[Types/double|double]]|1.0|optional=true}}  | |||
=  | |||
{{Prototype property|fuel_top_speed_multiplier|[[Types/double|double]]|1.0|optional=true}}  | |||
{{Prototype property|fuel_emissions_multiplier|[[Types/double|double]]|1.0|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.  | ||
{{Prototype property|pictures|[[Types/SpriteVariations|SpriteVariations]]|optional=true}}  | |||
Used to give the item multiple different icons so that they look less uniform on belts etc. For inventory icons and similar, <code>icon/icons</code> will be used. Maximum number of variations is 16.  | Used to give the item multiple different icons so that they look less uniform on belts etc. For inventory icons and similar, <code>icon/icons</code> will be used. Maximum number of variations is 16.  | ||
{{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>dark_background_icons</code> instead of <code>icons</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_icons</code> instead of <code>icons</code>.  | ||
{{Prototype property|rocket_launch_products|[[Types/table]] (array) of [[Types/ItemProductPrototype|table]] (array) of [[Types/ItemProductPrototype]]|optional=true}}  | |||
{{Prototype property|rocket_launch_product|[[Types/ItemProductPrototype|ItemProductPrototype]]|optional=true}}  | |||
Revision as of 15:06, 26 July 2019
Template:Prototype parent 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/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.
Template:Prototype property
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
Template:Prototype property Specifies some properties of the item.
 flags = { "hidden" }
Optional properties
Template:Prototype property Name of prototype/Entity that can be built using this item
place_result = "wooden-chest"
Template:Prototype property Empty text of subgroup is not allowed. (You can ommit the definition to get the default "other").
Template:Prototype property Only works for Prototype/SelectionTool and derived classes.
Template:Prototype property 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.
Template:Prototype property Must exist when a fuel_value is defined. Name of one of the fuel categories.
Template:Prototype property The item that is the result when this item gets burned as fuel.
Template:Prototype property Colors the glow of the burner energy source when this fuel is burned.
Template:Prototype property
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.
Template:Prototype property
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.