Template:Drop/doc: Difference between revisions
mNo edit summary |
(add name) |
||
| Line 9: | Line 9: | ||
}, | }, | ||
"description": { | "description": { | ||
"en-ca": "The source of the drop. Maximum of 32 characters." | "en-ca": "The source of the drop. Maximum of 32 characters. Stored in Cargo." | ||
}, | }, | ||
"example": { | "example": { | ||
| Line 57: | Line 57: | ||
"type": "number", | "type": "number", | ||
"required": true | "required": true | ||
}, | |||
"name": { | |||
"label": { | |||
"en-ca": "Item Name" | |||
}, | |||
"description": { | |||
"en-ca": "The name of the item. Not stored in Cargo. If omitted, the template will not render." | |||
} | |||
} | } | ||
}, | }, | ||
"description": "Template used for storing items and their drop locations in Cargo. " | "description": "Template used for displaying and/or storing items and their drop locations in Cargo. All parameters within are stored in Cargo unless otherwise stated." | ||
} | } | ||
</templatedata> | </templatedata> | ||
== Notes == | == Notes == | ||
* If used in a namespace, the store will fail with notice. | * If used in a namespace, the store will fail with notice. | ||
* If '''any''' | * If name is provided, the template will render a table row. | ||
* If '''any''' arguments that would be passed to Cargo are invalid, the store will silently fail. | |||
** It is not known to me, at this time, if it is possible to make Cargo return an error if validation fails without duplicating the logic into the Drop template itself. As a stopgap, viewing page values will detail what fields are being sent to Cargo. | ** It is not known to me, at this time, if it is possible to make Cargo return an error if validation fails without duplicating the logic into the Drop template itself. As a stopgap, viewing page values will detail what fields are being sent to Cargo. | ||
* Additionally, if any stores are rejected on a page using this template, all subsequent stores (using this template?) on said page will automatically fail. | * Additionally, if any stores are rejected on a page using this template, all subsequent stores (using this template?) on said page will automatically fail. | ||
Revision as of 16:02, 6 July 2025
Template used for displaying and/or storing items and their drop locations in Cargo. All parameters within are stored in Cargo unless otherwise stated.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| source | source | no description | String | required |
| table label | table label | no description
| String | required |
| item id | item id | no description | String | required |
| tickets | tickets | no description | Number | required |
| name | name | no description | Unknown | optional |
Notes
- If used in a namespace, the store will fail with notice.
- If name is provided, the template will render a table row.
- If any arguments that would be passed to Cargo are invalid, the store will silently fail.
- It is not known to me, at this time, if it is possible to make Cargo return an error if validation fails without duplicating the logic into the Drop template itself. As a stopgap, viewing page values will detail what fields are being sent to Cargo.
- Additionally, if any stores are rejected on a page using this template, all subsequent stores (using this template?) on said page will automatically fail.