Template:Itemicon insert: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
(add uid field)
Line 3: Line 3:
|icon={{#if:{{{icon|}}}|{{{icon}}}|{{{image|}}} }}
|icon={{#if:{{{icon|}}}|{{{icon}}}|{{{image|}}} }}
|rarity={{{rarity|common}}}
|rarity={{{rarity|common}}}
}}</onlyinclude></includeonly><noinclude>
|uid={{{uid|}}}
}}</onlyinclude></includeonly><noinclude>{{documentation|content=


Inserts an icon into the Cargo item_icon database. Enables use of [[Template:ItemIcon]].
Inserts an icon into the Cargo item_icon database. Enables use of [[Template:ItemIcon]].
Line 14: Line 15:


{{#cargo_attach:_table=item_icon}}
{{#cargo_attach:_table=item_icon}}
</noinclude>
 
==Template data==
<templatedata>
{
"params": {
"icon": {
"description": "The icon file name, without the File: namespace.",
"required": true
},
"image": {
"description": "An image for the item. This is usually a faded image. Unfaded images should be put into \"icon\". Is overridden by \"icon\"."
},
"rarity": {
"description": "The rarity of the item. Defaults to common.",
"suggestedvalues": [
"common",
"uncommon",
"rare",
"very rare"
],
"suggested": true
},
"uid": {
"description": "The unique id for the item. Can be used to query items that have multiple of the same display name.",
"suggested": true
}
}
}
</templatedata>
}}[[Category:Templates]]</noinclude>

Revision as of 13:41, 11 December 2023

Template documentation

Inserts an icon into the Cargo item_icon database. Enables use of Template:ItemIcon.

Usage:
{{ItemIcon Insert
|icon=filename of the icon to use, without the File: prefix
|image=(optional) filename of the image to use as an icon, without the File: prefix. Overridden if "icon" is defined. Used for item template pages which may have an image configured but not an icon.
|rarity=the rarity of the item. One of (common,uncommon,rare, very rare,legendary,story). Defaults to common if not specified.
}}

This template adds rows to the table "item_icon", which is declared by the template Itemicon insert. View table.

Template data

No description.

Template parameters

ParameterDescriptionTypeStatus
iconicon

The icon file name, without the File: namespace.

Unknownrequired
imageimage

An image for the item. This is usually a faded image. Unfaded images should be put into "icon". Is overridden by "icon".

Unknownoptional
rarityrarity

The rarity of the item. Defaults to common.

Suggested values
common uncommon rare very rare
Unknownsuggested
uiduid

The unique id for the item. Can be used to query items that have multiple of the same display name.

Unknownsuggested