Editing Template:Player/doc

{{Documentation}}

{{t|Player}} is a template for displaying a graphical card that represents a member of the server. Given a name and rank, it will generate a card with the appropriate image and profile link.



<templatedata>
{
	"params": {
		"UUID": {
			"label": "UUID",
			"description": "The UUID of the player. This value is automatically determined from the Name value. You only need to set this manually if the username differs from the skin you want to display.",
			"example": "bb317801-c2c4-4e18-8e26-ee21e03f4c69",
			"type": "string",
			"default": "ec561538-f3fd-461d-aff5-086b22154bce"
		},
		"Name": {
			"label": "Name",
			"description": "The Minecraft name of the user",
			"example": "BakiDance",
			"type": "string",
			"required": true,
			"default": "Steve"
		},
		"Rank": {
			"label": "Rank",
			"description": "The rank of the user in-game. This is used to display the correct background for the user.",
			"example": "Owner",
			"type": "string",
			"required": true,
			"default": "Pebble"
		},
		"Profile": {
			"label": "Profile Link",
			"description": "The username of the user on the site. This field is not required if the \"Name\" parameter matches their username on the site.",
			"example": "BakiDance",
			"type": "wiki-user-name",
			"default": "Cubey"
		},
		"ShowProfile": {
			"label": "Show Profile",
			"description": "Controls whether or not to show a link to the user's site profile. Overrides all other options. Accepts true or false as inputs.",
			"example": "true",
			"type": "boolean",
			"default": "true"
		}
	},
	"description": "Displays a card of the given player with an auto-generated image, rank data, and profile link.",
	"format": "block",
	"paramOrder": [
		"Name",
		"UUID",
		"Rank",
		"Profile",
		"ShowProfile"
	]
}
</templatedata>

== Hidden functions ==
The template has an additional override parameter:

;Background
:When set, this parameter controls which background should display, regardless of the given value for Rank.