Template:NPCBox/doc: Difference between revisions

Revision as of 20:54, 14 April 2023

A template used in displaying NPC information.

Template parameters
This template has custom formatting.
Parameter		Description	Type	Status
name	`name`	The name of the NPC (if different than the page name).	String	optional
headercolor	`headercolor`	The header's background color. Example #3366CC	String	suggested
headerfontcolor	`headerfontcolor`	The header's text color. Example #ffffff	String	suggested
headerfontsize	`headerfontsize`	The header's font size. Example 40px	String	optional
image	`image`	An image representing the NPC.	String	required
imagewidth	`imagewidth`	A custom width for the NPC's image. Example 200px	String	optional
caption	`caption`	A caption describing the NPC's image.	String	optional
species	`species`	The in-game species of the NPC.	String	optional
role	`role`	The NPC's purpose.	Content	required
location	`location`	The NPC's location.	String	required
Effects	`Effects`	The effect that you can get from this NPC.	String	optional
Wallpapers	`Wallpapers`	Wallpapers that you can get from this NPC. Example WP #1	String	suggested
Menu	`Menu`	Menu themes that the NPC would you. Example Menu Theme #1	String	suggested
Events	`Events`	Events associated with this NPC.	String	suggested
size	`size`	The NPC's physical size.	String	optional
killable	`killable`	Whether the NPC can be killed.	String	required
notes	`notes`	Additional notes related to the NPC.	Content	suggested
EffectName	`EffectName`	The name of the effect associated with this NPC.	String	optional

@@ Line 5: / Line 5: @@
 			"description": "The header's background color.",
 			"type": "string",
-			"suggested": true
+			"suggested": true,
+			"example": "#3366CC"
 		},
 		"headerfontcolor": {
 			"description": "The header's text color.",
 			"type": "string",
-			"suggested": true
+			"suggested": true,
+			"example": "#ffffff"
 		},
 		"image": {
 			"description": "An image representing the NPC.",
 			"type": "string",
-			"suggested": true
+			"required": true
 		},
 		"caption": {
@@ Line 24: / Line 26: @@
 			"description": "The NPC's location.",
 			"type": "string",
-			"suggested": true
+			"required": true
 		},
 		"role": {
 			"description": "The NPC's purpose.",
 			"type": "content",
-			"suggested": true
+			"required": true
 		},
 		"size": {
 			"description": "The NPC's physical size.",
-			"type": "string",
+			"type": "string"
-			"suggested": true
 		},
 		"killable": {
 			"description": "Whether the NPC can be killed.",
 			"type": "string",
-			"suggested": true
+			"required": true
 		},
 		"notes": {
@@ Line 70: / Line 71: @@
 			"type": "string",
 			"suggested": true
+		},
+		"species": {
+			"description": "The in-game species of the NPC.",
+			"type": "string"
+		},
+		"name": {
+			"description": "The name of the NPC (if different than the page name).",
+			"type": "string"
+		},
+		"imagewidth": {
+			"description": "A custom width for the NPC's image.",
+			"example": "200px",
+			"type": "string"
+		},
+		"headerfontsize": {
+			"example": "40px",
+			"type": "string",
+			"description": "The header's font size."
 		}
 	},
 	"description": "A template used in displaying NPC information.",
-	"format": "{{_\n|_ = _\n}}"
+	"format": "{{_\n|_ = _\n}}",
+	"paramOrder": [
+		"name",
+		"headercolor",
+		"headerfontcolor",
+		"headerfontsize",
+		"image",
+		"imagewidth",
+		"caption",
+		"species",
+		"role",
+		"location",
+		"Effects",
+		"Wallpapers",
+		"Menu",
+		"Events",
+		"size",
+		"killable",
+		"notes",
+		"EffectName"
+	]
 }
 </templatedata>