Template:Drop/doc: Difference between revisions

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.
Parameter		Description	Type	Status
source	`source`	no description	String	required
table label	`table label`	no description Suggested values `Clear Box` `Area Drops` `Mid-Mission Box`	String	required
item id	`item id`	no description	String	required
tickets	`tickets`	no description	Number	required
name	`name`	no description	String	optional
link	`link`	no description	Page name	suggested

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.

@@ Line 1: / Line 1: @@
 <noinclude>{{Documentation subpage}}</noinclude><includeonly>[[Category: Templates using Cargo]]</includeonly>
-Template used for storing '''item drop locations''' in Cargo, including their corresponding properties.<includeonly>[[Category: Templates using Cargo]]</includeonly>
+<templatedata>
+{
+	"params": {
+		"source": {
+			"label": {
+				"en-ca": "Source"
+			},
+			"description": {
+				"en-ca": "The source of the drop. Maximum of 32 characters. Stored in Cargo."
+			},
+			"example": {
+				"en-ca": "Unsafe Passage (Ultimate)"
+			},
+			"type": "string",
+			"required": true
+		},
+		"table label": {
+			"label": {
+				"en-ca": "Table Label"
+			},
+			"description": {
+				"en-ca": "The label of the table the drop belongs to. Maximum of 32 characters."
+			},
+			"example": {
+				"en-ca": "Clear Box"
+			},
+			"type": "string",
+			"suggestedvalues": [
+				"Clear Box",
+				"Area Drops",
+				"Mid-Mission Box"
+			],
+			"required": true
+		},
+		"item id": {
+			"label": {
+				"en-ca": "Item ID"
+			},
+			"description": {
+				"en-ca": "The ID of the item. Maximum of 8 characters."
+			},
+			"type": "string",
+			"required": true
+		},
+		"tickets": {
+			"label": {
+				"en-ca": "Tickets"
+			},
+			"description": {
+				"en-ca": "The number of tickets allocated for the item."
+			},
+			"example": {
+				"en-ca": "100000"
+			},
+			"type": "number",
+			"required": true
+		},
+		"name": {
+			"label": {
+				"en-ca": "Item Name"
+			},
+			"description": {
+				"en-ca": "The name of the item. Used for Template:Drop/Article."
+			},
+			"example": {
+				"en-ca": "Eternal Psychodrive/U+"
+			},
+			"type": "string"
+		},
+		"link": {
+			"label": {
+				"en-ca": "Link to Page"
+			},
+			"description": {
+				"en-ca": "The page of the item. Used for Template:Drop/Article. "
+			},
+			"example": {
+				"en-ca": "Eternal Psychodrive/U+"
+			},
+			"type": "wiki-page-name",
+			"suggested": true
+		}
+	},
+	"description": "Template used for displaying and/or storing items and their drop locations in Cargo.",
+	"paramOrder": [
+		"source",
+		"table label",
+		"item id",
+		"tickets",
+		"name",
+		"link"
+	],
+	"format": "block"
+}
+</templatedata>
+== 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.