Template:Infobox clothing/doc: Difference between revisions
m (added bite defense) |
(added new parameters + Parameters section, basic for now, needs more attention) |
||
Line 40: | Line 40: | ||
| body_location = body_location | | body_location = body_location | ||
| condition = condition | | condition = condition | ||
| | | fabric = fabric <!-- or | fabirc_type = --> | ||
| | | metal_value = <!-- currently hidden; function not yet implemented --> | ||
| function = function | |||
| capacity = capacity | | capacity = capacity | ||
| weight_reduction = weight_reduction | | weight_reduction = weight_reduction | ||
Line 89: | Line 90: | ||
| body_location = | | body_location = | ||
| condition = | | condition = | ||
| | | fabric = fabric <!-- or | fabirc_type = --> | ||
| | | metal_value = <!-- currently hidden; function not yet implemented --> | ||
| function = function | |||
| capacity = | | capacity = | ||
| weight_reduction = | | weight_reduction = | ||
Line 110: | Line 112: | ||
| class_name = | | class_name = | ||
}}</pre> | }}</pre> | ||
==Parameters== | |||
===Header=== | |||
;display_name: The display name of the item as it appears in-game. Leaving blank will display the pagename. | |||
;name_colour: The background colour for the display name. Codes can be found at [[Template:Infobox nc]]. | |||
;name_text_colour: The text colour for the display name. Codes can be found at [[Template:Infobox nc]]. | |||
;image: An image of the icon displayed at 128px by default. Item model is preferred. | |||
;image_width: Customise the <code>image</code> width. ''Default: 128px'' | |||
;alternate_image: An alternate image displayed at 32px. Can be an empty, packaged, open or any other variant. | |||
;alternate_name: The name of the alternate item image. Leaving blank will display no name when the image is hovered over. | |||
;alternate_link: An optional link to the alternate image page. Leaving blank will have no link. | |||
===General=== | |||
;category: The in-game category the item is displayed in the inventory. ''Default: Clothing'' | |||
;weight: The base weight of the item. | |||
;body_location: Body location the item can be equipped. ''(remove if value is false)'' | |||
;fabric: Fabric type of the item. ''(remove if value is false)'' | |||
;metal_value: The amount of ''metal'' this item provides when used in metalworking/smithing. (currently hidden until feature is implemented) ''(remove if value is false)'' | |||
;function: What the item can be used for. Minor uses should be omitted. Combines the deprecated <code>primary_use</code> and <code>secondary_use</code>. The <code><nowiki><</nowiki>br></code> tag should be used instead to separate functions. ''(remove if value is empty)'' | |||
;{{tooltip|''primary_use''|Deprecated: use 'function' instead}}: The item's primary use. Can usually be removed if the item isn't considered a ''tool'' by the wiki. ''(remove if value is empty)'' | |||
;{{tooltip|''secondary_use''|Deprecated: use 'function' instead}}: The item's secondary use if it has one. Can usually be removed if the item isn't considered a ''tool'' by the wiki. ''(remove if value is empty)'' | |||
;condition: Item's condition value. ''(remove if value is false)'' | |||
;capacity: 'Item's capacity value. ''(remove if value is false)'' | |||
;weight_reduction: Weight reduction value. ''(remove if value is empty)'' | |||
;attachments_provided: Attachment slots provided by the item. ''(remove if value is empty)'' | |||
===Speed=== | |||
;run_speed: Run speed modifier. Note this is currently bugged/unimplemented, and has no in-game function. ''(remove if value is false)'' | |||
;combat_speed: Combat speed modifier. ''(remove if value is false)'' | |||
===Protection=== | |||
;scratch_defense: Scratch defense modifier. ''(remove if value is false)'' | |||
;bullet_defense: Bullet defense modifier. ''(remove if value is false)'' | |||
;neck_protection: Neck protection modifier. ''(remove if value is false)'' | |||
===Insulation=== | |||
;insulation: Insulation modifier. ''(remove if value is false)'' | |||
;wind_resistance: Wind resistance modifier. ''(remove if value is false)'' | |||
;water_resistance: Water resistance modifier. ''(remove if value is false)'' | |||
===Technical details=== | |||
;ingredients: A list of ingredients required to make this item. Please use the following format: <code>1 × <nowiki>[[</nowiki>Plank]]</code> and separate ingredients into a list with <code><nowiki><</nowiki>br></code>. | |||
;class_name: The item's ID. Should be: <code>[module].[name]</code>. E.g. <code>Base.Suit_Jacket</code> | |||
{{clear}} | {{clear}} |
Revision as of 08:40, 25 June 2023
This is a documentation subpage for Template:Infobox clothing.
It contains usage information and other content that is not part of the original template page. |
This template is used to create an infobox in an article about clothing.
Usage
To use this template in an article, copy the template below, then paste the template into an article.
All parameters are optional – those you do not populate with data will not show up in the infobox when the article is saved.
It is strongly advised to only include variables that are relevant to the specific item in question, i.e. parameters that do not display as false or 0.
{{Infobox clothing | display_name = | name_colour = | name_text_colour = | image = | image_width = | alternate_image = | alternate_name = | alternate_link = | alternate_image2 = | alternate_name2 = | alternate_link2 = | alternate_image3 = | alternate_name3 = | alternate_link3 = | alternate_image4 = | alternate_name4 = | alternate_link4 = | alternate_image5 = | alternate_name5 = | alternate_link5 = | alternate_image6 = | alternate_name6 = | alternate_link6 = | alternate_image7 = | alternate_name7 = | alternate_link7 = <!-- General --> | category = | weight = | body_location = | condition = | fabric = fabric <!-- or | fabirc_type = --> | metal_value = <!-- currently hidden; function not yet implemented --> | function = function | capacity = | weight_reduction = | attachments_provided = <!-- Speed --> | run_speed = | combat_speed = <!-- Protection --> | scratch_defense = | bite_defense = | bullet_defense = | neck_protection = <!-- Insulation --> | insulation = insulation | wind_resistance = wind_resistance | water_resistance = water_resistance <!-- Technical details --> | ingredients = | class_name = }}
Parameters
Header
- display_name
- The display name of the item as it appears in-game. Leaving blank will display the pagename.
- name_colour
- The background colour for the display name. Codes can be found at Template:Infobox nc.
- name_text_colour
- The text colour for the display name. Codes can be found at Template:Infobox nc.
- image
- An image of the icon displayed at 128px by default. Item model is preferred.
- image_width
- Customise the
image
width. Default: 128px - alternate_image
- An alternate image displayed at 32px. Can be an empty, packaged, open or any other variant.
- alternate_name
- The name of the alternate item image. Leaving blank will display no name when the image is hovered over.
- alternate_link
- An optional link to the alternate image page. Leaving blank will have no link.
General
- category
- The in-game category the item is displayed in the inventory. Default: Clothing
- weight
- The base weight of the item.
- body_location
- Body location the item can be equipped. (remove if value is false)
- fabric
- Fabric type of the item. (remove if value is false)
- metal_value
- The amount of metal this item provides when used in metalworking/smithing. (currently hidden until feature is implemented) (remove if value is false)
- function
- What the item can be used for. Minor uses should be omitted. Combines the deprecated
primary_use
andsecondary_use
. The<br>
tag should be used instead to separate functions. (remove if value is empty) - primary_use
- The item's primary use. Can usually be removed if the item isn't considered a tool by the wiki. (remove if value is empty)
- secondary_use
- The item's secondary use if it has one. Can usually be removed if the item isn't considered a tool by the wiki. (remove if value is empty)
- condition
- Item's condition value. (remove if value is false)
- capacity
- 'Item's capacity value. (remove if value is false)
- weight_reduction
- Weight reduction value. (remove if value is empty)
- attachments_provided
- Attachment slots provided by the item. (remove if value is empty)
Speed
- run_speed
- Run speed modifier. Note this is currently bugged/unimplemented, and has no in-game function. (remove if value is false)
- combat_speed
- Combat speed modifier. (remove if value is false)
Protection
- scratch_defense
- Scratch defense modifier. (remove if value is false)
- bullet_defense
- Bullet defense modifier. (remove if value is false)
- neck_protection
- Neck protection modifier. (remove if value is false)
Insulation
- insulation
- Insulation modifier. (remove if value is false)
- wind_resistance
- Wind resistance modifier. (remove if value is false)
- water_resistance
- Water resistance modifier. (remove if value is false)
Technical details
- ingredients
- A list of ingredients required to make this item. Please use the following format:
1 × [[Plank]]
and separate ingredients into a list with<br>
. - class_name
- The item's ID. Should be:
[module].[name]
. E.g.Base.Suit_Jacket