Prototype/ItemWithLabel: Difference between revisions

Latest revision as of 15:09, 26 July 2019

Prototype definitions » PrototypeBase » Prototype/Item » Prototype/ItemWithLabel

Like a normal item but with the ability to have a colored label.

Prototype/ItemWithLabel — `item-with-label`
default_label_color	::	Color (optional)
draw_label_for_cursor_render	::	bool (optional)
Inherited from Prototype/Item
icons, icon, icon_size (IconSpecification)	::	IconSpecification
stack_size	::	ItemCountType
burnt_result	::	string (optional)
close_sound	::	Sound (optional)
dark_background_icons, dark_background_icon, icon_size (IconSpecification)	::	IconSpecification (optional)
default_request_amount	::	ItemCountType (optional)
flags	::	ItemPrototypeFlags (optional)
fuel_acceleration_multiplier	::	double (optional)
fuel_category	::	string (optional)
fuel_emissions_multiplier	::	double (optional)
fuel_glow_color	::	Color (optional)
fuel_top_speed_multiplier	::	double (optional)
fuel_value	::	Energy (optional)
open_sound	::	Sound (optional)
pictures	::	SpriteVariations (optional)
place_as_tile	::	PlaceAsTile (optional)
place_result	::	string (optional)
placed_as_equipment_result	::	string (optional)
rocket_launch_product	::	ItemProductPrototype (optional)
rocket_launch_products	::	table (array) of ItemProductPrototype (optional)
subgroup	::	string (optional)
wire_count	::	ItemCountType (optional)
Inherited from PrototypeBase
name	::	string
type	::	string
localised_description	::	LocalisedString (optional)
localised_name	::	LocalisedString (optional)
order	::	Order (optional)

Extensions

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

Optional properties

This prototype inherits all the properties from Prototype/Item.

default_label_color

Type: Color
Default: Default item text color
The default label color the item will use.

draw_label_for_cursor_render

Type: bool
Default: false
If the item will draw its label when held in the cursor in place of the item count.

@@ Line 1: / Line 1: @@
-==Basics==
+{{Prototype parent|Prototype/Item}}
-Inherits from [[prototype/Item]]. Like a normal item but with the ability to have a colored label.
+Like a normal item but with the ability to have a colored label.
-  type = "item-with-label"
+{{Prototype TOC|item-with-label}}
+== Extensions ==
+* [[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'''
 == Optional properties ==
+This prototype inherits all the properties from [[Prototype/Item]].
-=== default_label_color ===
+{{Prototype property|default_label_color|[[Types/Color|Color]]|Default item text color|optional=true}}
-The default label color the item will use or if not provided it uses the game default item text color.
+The default label color the item will use.
-  default_label_color = {r=1, g=1, b=0, a=1}
-=== draw_label_for_cursor_render ===
+{{Prototype property|draw_label_for_cursor_render|[[Types/bool|bool]]|false|optional=true}}
-If true, the item will draw its label when held in the cursor in place of the item count. Defaults to false if not defined.
+If the item will draw its label when held in the cursor in place of the item count.
-  draw_label_for_cursor_render = true