Template:Drop/doc: Difference between revisions

Revision as of 15:51, 6 July 2025

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

No description.

Template 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

Notes

If used in a namespace, the store will fail with notice.
If any invalid arguments are provided, 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>
-== Purpose ==
-Template used for storing '''items and their drop locations''' in Cargo.
-== Parameter List ==
+<templatedata>
-<pre>
+{
-{{Drop
+	"params": {
-|source      <!-- The source of the drop. Only accepts a string, maximum 32 characters. -->
+		"source": {
-|table label <!-- The label of the table (e.g. "Clear Box", "Area Drops", "Mid-Mission Box", etc). Used to disambiguate sub-sources within a source. Only accepts a string, maximum 32 characters. -->
+			"label": {
-|item id     <!-- The ID of the item. Only accepts a string, maximum 8 characters. -->
+				"en-ca": "Source"
-|tickets     <!-- The number of tickets allocated for the item, as an integer. -->
+			},
-}}
+			"description": {
-</pre>
+				"en-ca": "The source of the drop. Maximum 32 characters."
+			},
+			"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. Max 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
+		}
+	}
+}
+</templatedata>
 == Notes ==