Toggle menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:Player/doc: Difference between revisions

Template page
m (BakiDance moved page Template:Player/doc to Template:Player/doc)
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Documentation}}
{{Documentation}}


{{t|Staff}} is a template for displaying a graphical card that represents a staff member of the server. Given a name, UUID, and rank, it will generate a card with the appropriate image and profile link.
{{t|Staff}} 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.




Line 10: Line 10:
"UUID": {
"UUID": {
"label": "UUID",
"label": "UUID",
"description": "The UUID of the player",
"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",
"example": "bb317801-c2c4-4e18-8e26-ee21e03f4c69",
"type": "string",
"type": "string",
"required": true
"default": "ec561538-f3fd-461d-aff5-086b22154bce"
},
},
"Name": {
"Name": {
Line 20: Line 20:
"example": "BakiDance",
"example": "BakiDance",
"type": "string",
"type": "string",
"required": true
"required": true,
"default": "Steve"
},
},
"Rank": {
"Rank": {
"label": "Rank",
"label": "Rank",
"description": "The rank of the user",
"description": "The rank of the user in-game. This is used to display the correct background for the user.",
"example": "Owner",
"example": "Owner",
"type": "string",
"type": "string",
"required": true
"required": true,
"default": "Pebble"
},
},
"Profile": {
"Profile": {
"label": "Profile Link",
"label": "Profile Link",
"description": "The username of the user on the site. This field is not required if the \"User\" parameter matches their username on the site.",
"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",
"example": "BakiDance",
"type": "wiki-user-name"
"type": "wiki-user-name",
"default": "Cubey"
},
},
"Staff": {
"ShowProfile": {
"label": "Staff",
"label": "Show Profile",
"description": "Whether the user is staff or not. Accepts true or false as inputs and is used to generate the correct background.",
"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",
"example": "true",
"type": "boolean",
"type": "boolean",
"suggested": true
"default": "true"
}
}
},
},
"description": "Displays a card of the given staff member with an auto-generated image and profile link.",
"description": "Displays a card of the given player with an auto-generated image, rank data, and profile link.",
"format": "block"
"format": "block",
"paramOrder": [
"Name",
"UUID",
"Rank",
"Profile",
"ShowProfile"
]
}
}
</templatedata>
</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.

Latest revision as of 18:13, 30 April 2023

{{Template: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.


Displays a card of the given player with an auto-generated image, rank data, and profile link.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
NameName

The Minecraft name of the user

Default
Steve
Example
BakiDance
Stringrequired
UUIDUUID

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.

Default
ec561538-f3fd-461d-aff5-086b22154bce
Example
bb317801-c2c4-4e18-8e26-ee21e03f4c69
Stringoptional
RankRank

The rank of the user in-game. This is used to display the correct background for the user.

Default
Pebble
Example
Owner
Stringrequired
Profile LinkProfile

The username of the user on the site. This field is not required if the "Name" parameter matches their username on the site.

Default
Cubey
Example
BakiDance
Useroptional
Show ProfileShowProfile

Controls whether or not to show a link to the user's site profile. Overrides all other options. Accepts true or false as inputs.

Default
true
Example
true
Booleanoptional

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.