Template:Type: Difference between revisions

← Older edit

VisualWikitext

Latest revision as of 23:56, 29 October 2024

Displays a type widget.

All options are routed through Module:Type. (Edit to add aliases or custom links for matching types.)
Stylesheet: Template:Type/style.css. (Edit to add colors and decorations for custom types.)

Examples

nil {{type|nil}}
number
integer, double, float
numbers | nil (optional number)
numbers[] (array of numbers)
string
boolean
function
table
Vector (Vector2, Vector3, Vector4)
Matrix (Matrix2, Matrix3, Matrix4)
Event (custom type that exists)
CrashAPI (custom type that doesn't exist)
Main Page (links to Event) {{type|Main Page|link=Event}}

Testcases page.

Displays and links to types.

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Type name	`1` `name`	Type name ('table' etc.) Supports modifiers, like ? and []. Suggested values `nil` `boolean` `integer` `number` `string` `function` `table` `Vector` `Matrix`	String	required
Custom link target	`link`	no description	Page name	optional
Custom text	`text`	If provided, this text will be displayed instead of the type name. The link and styling will still be determined by the type name.	Content	optional
2	`2`	Type modifiers (compatibility)	Unknown	deprecated

@@ Line 1: / Line 1: @@
-<templatestyles src="Template:Type/style.css"/>{{#switch:{{{1}}}
+<includeonly><templatestyles src="Template:Type/style.css"/>{{#invoke:Type|run}}</includeonly><noinclude> <!-- Documentation starts here. -->
- | nil = {{type/nil}}
+'''Displays a ''type widget''.'''
- | number = {{type/builtin|{{{1}}}}}
- | integer = {{type/builtin|{{{1}}}}}
+* All options are routed through [[Module:Type]]. (Edit to add aliases or custom links for matching types.)
- | string = {{type/builtin|{{{1}}}}}
+* Stylesheet: [[Template:Type/style.css]]. (Edit to add colors and decorations for custom types.)
- | boolean = {{type/builtin|{{{1}}}}}
- | function = {{type/builtin|{{{1}}}}}
+== Examples ==
- | table = {{type/builtin|{{{1}}}}}
+* {{type|nil}} <code><nowiki>{{type|nil}}</nowiki></code>
- | <span class="lua-type" data-name="{{{1}}}">[[{{{1}}}]]</span>
+* {{type|number}}
-}}
+* {{type|integer}}, {{type|double}}, {{type|float}}
+* {{type|numbers|?}} (optional number)
+* {{type|numbers|[]}} (array of numbers)
+* {{type|string}}
+* {{type|boolean}}
+* {{type|function}}
+* {{type|table}}
+* {{type|Vector}} ({{type|Vector2}}, {{type|Vector3}}, {{type|Vector4}})
+* {{type|Matrix}} ({{type|Matrix2}}, {{type|Matrix3}}, {{type|Matrix4}})
+* {{type|Event}} (custom type that exists)
+* {{type|CrashAPI}} (custom type that doesn't exist)
+* {{type|Main Page|link=Event}} (links to [[Event]]) <code><nowiki>{{type|Main Page|link=Event}}</nowiki></code>
+[[Template:Type/testcases|Testcases page.]]
+<templatedata>
+{
+	"params": {
+		"1": {
+			"label": "Type name",
+			"suggestedvalues": [
+				"nil",
+				"boolean",
+				"integer",
+				"number",
+				"string",
+				"function",
+				"table",
+				"Vector",
+				"Matrix"
+			],
+			"required": true,
+			"aliases": [
+				"name"
+			],
+			"description": "Type name ('table' etc.) Supports modifiers, like ? and [].",
+			"type": "string"
+		},
+		"2": {
+			"description": "Type modifiers (compatibility)",
+			"deprecated": "Attach modifiers directly to the type name."
+		},
+		"link": {
+			"label": "Custom link target",
+			"type": "wiki-page-name"
+		},
+		"text": {
+			"label": "Custom text",
+			"description": "If provided, this text will be displayed instead of the type name. The link and styling will still be determined by the type name.",
+			"type": "content"
+		}
+	},
+	"description": "Displays and links to types.",
+	"paramOrder": [
+		"1",
+		"link",
+		"text",
+		"2"
+	],
+	"format": "inline"
+}
+</templatedata></noinclude>