Template:Drop/doc: Difference between revisions

From Phantasy Star Universe Clementine
No edit summary
(split rendering components to own page)
 
(2 intermediate revisions by the same user not shown)
Line 63: Line 63:
},
},
"description": {
"description": {
"en-ca": "The name of the item. Not stored in Cargo. If omitted, the template will not render."
"en-ca": "The name of the item. Used for Template:Drop/Article."
},
},
"example": {
"example": {
Line 75: Line 75:
},
},
"description": {
"description": {
"en-ca": "The page of the item. Not stored in Cargo. Dependent on item name for rendering. If omitted, no link will be provided. "
"en-ca": "The page of the item. Used for Template:Drop/Article. "
},
},
"example": {
"example": {
Line 84: Line 84:
}
}
},
},
"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.",
"description": "Template used for displaying and/or storing items and their drop locations in Cargo.",
"paramOrder": [
"paramOrder": [
"source",
"source",
Line 98: Line 98:


== Notes ==
== Notes ==
* If used in a namespace, the store will fail with notice.
* Calls [[Template:Drop/Article]].
* If name is provided, the template will render the relevant strings with a link if provided.
* If used in a namespace, the store will fail with notice, superseding all other functionality.
* If '''any''' arguments that would be passed to Cargo are invalid, the store will silently fail.
* 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.

Latest revision as of 17:05, 6 July 2025

This is a documentation subpage for the Template:Drop page.

Template used for displaying and/or storing items and their drop locations in Cargo.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
sourcesource

no description

Stringrequired
table labeltable label

no description

Suggested values
Clear Box Area Drops Mid-Mission Box
Stringrequired
item iditem id

no description

Stringrequired
ticketstickets

no description

Numberrequired
namename

no description

Stringoptional
linklink

no description

Page namesuggested

Notes

  • Calls Template:Drop/Article.
  • If used in a namespace, the store will fail with notice, superseding all other functionality.
  • 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.