Template:BTD6 changes/doc: Difference between revisions
No edit summary |
more documentation |
||
| Line 21: | Line 21: | ||
"type": "content", | "type": "content", | ||
"required": true | "required": true | ||
}, | }, | ||
"names": { | "names": { | ||
| Line 37: | Line 31: | ||
"type": "string", | "type": "string", | ||
"required": true | "required": true | ||
}, | |||
"show quote": { | |||
"label": "Show quote?", | |||
"description": "If set to \"0\", the quote will not be displayed on this page, but will still be stored and used for cargo queries.", | |||
"type": "boolean" | |||
}, | |||
"version note": { | |||
"label": "Version note", | |||
"description": "Adds text in parentheses after the version number in cargo queries. For example, if this change is from a future update, this can be used to specify that the change is \"upcoming\".", | |||
"example": "upcoming", | |||
"type": "string" | |||
}, | |||
"priority": { | |||
"label": "Priority", | |||
"description": "Determines the order that changes within each version will be displayed in cargo queries.", | |||
"type": "number" | |||
}, | |||
"changes store": { | |||
"label": "Changes store", | |||
"description": "The value in this parameter will be stored in the cargo table instead of the value of the \"changes\" parameter if this is set to anything. This can be used to display a different value on the page this template is used on than on the pages that use cargo queries.", | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
| Line 42: | Line 57: | ||
"paramOrder": [ | "paramOrder": [ | ||
"version", | "version", | ||
"version note", | |||
"quote", | "quote", | ||
"show quote", | |||
"changes", | "changes", | ||
" | "changes store", | ||
"names" | "names", | ||
"priority" | |||
], | ], | ||
"format": "block" | "format": "block" | ||
Revision as of 03:48, 28 March 2025
This template formats a list of changes and stores it using Cargo. This is a generic template for listing changes to most gameplay features (maps, powers, knowledge, etc). Changes to towers and heroes should use their dedicated changes template instead.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Version number | version | The version number of these changes. This determines which version header to list these changes under in a Cargo query.
| Number | required |
| Version note | version note | Adds text in parentheses after the version number in cargo queries. For example, if this change is from a future update, this can be used to specify that the change is "upcoming".
| String | optional |
| Quote | quote | A quote from official patch notes accompanying these changes. The text is formatted as a quotation from "Version <x> update notes".
| String | optional |
| Show quote? | show quote | If set to "0", the quote will not be displayed on this page, but will still be stored and used for cargo queries. | Boolean | optional |
| Changes | changes | A list of changes. This text is copied and transcluded verbatim when using Cargo queries, so you have to format it as an unordered list and use the appropriate buff/nerf/change templates as needed.
| Content | required |
| Changes store | changes store | The value in this parameter will be stored in the cargo table instead of the value of the "changes" parameter if this is set to anything. This can be used to display a different value on the page this template is used on than on the pages that use cargo queries. | String | optional |
| Names | names name | A list of comma-separated names of subjects. This is the "key" used to list changes using Cargo; for example, creating a list of changes with the name "Dark Castle" and querying a list of changes with the name "Dark Castle" will only display changes under the name "Dark Castle". If using multiple names, separate them with commas with one space.
| String | required |
| Priority | priority | Determines the order that changes within each version will be displayed in cargo queries. | Number | optional |