ModEnc is currently in Maintenance Mode: Changes could occur at any given moment, without advance warning.
Difference between revisions of "Template:Values"
From ModEnc
m (Tabular formatting.) |
(Added uint as another shorthand for unsigned integer) |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 4: | Line 4: | ||
|int | |int | ||
|integer | |integer | ||
| − | |integers = [[Help:Values#Integers|Signed integers]]: All whole numbers from -2147483648 to 2147483647; in rare cases, only from -32768 to 32767. | + | |integers = [[Help:Values#Integers|Signed integers]]: All whole numbers from -2147483648 to 2147483647; in rare cases, only from -32768 to 32767. {{#if: {{{2|}}} | (Limited to: {{{2}}})}} |
| + | |uint | ||
|unsigned integer | |unsigned integer | ||
| − | |unsigned integers = [[Help:Values#Integers|Unsigned integers]]: All non-negative whole numbers from 0 to either 32767, 2147483647 or | + | |unsigned integers = [[Help:Values#Integers|Unsigned integers]]: All non-negative whole numbers from 0 to either 32767, 2147483647 or 4294967295. {{#if: {{{2|}}} | (Limited to: {{{2}}})}} |
|float | |float | ||
| − | |floats = [[Help:Values#Floating Point Values|Floating point values]]: Any decimal number (clearer range should be added in [[Template:Values]]) | + | |floats = [[Help:Values#Floating Point Values|Floating point values]]: Any decimal number (clearer range should be added in [[Template:Values]]). {{#if: {{{2|}}} | (Limited to: {{{2}}})}} |
|unsigned byte | |unsigned byte | ||
|unsigned bytes | |unsigned bytes | ||
| Line 23: | Line 24: | ||
|stringlist | |stringlist | ||
|listofstrings = {{{separator|Comma}}}-separated list of [[Help:Values#Strings|strings]]. {{#if: {{{2|}}} | (Limited to: {{{2}}})}} | |listofstrings = {{{separator|Comma}}}-separated list of [[Help:Values#Strings|strings]]. {{#if: {{{2|}}} | (Limited to: {{{2}}})}} | ||
| + | |intlist | ||
| + | |listofints = {{{separator|Comma}}}-separated list of [[Help:Values#Integers|integers]]. {{#if: {{{2|}}} | (Limited to: {{{2}}})}} | ||
|color | |color | ||
| − | |colors = [[Help:Values#Colors|Colors]] | + | |colors = [[Help:Values#Colors|Colors]]: {{#switch: {{lc:{{{2}}}}} |rgb = R,G,B |hsb = H,S,B |#default = R,G,B}} format |
|clsid | |clsid | ||
|clsids | |clsids | ||
| Line 36: | Line 39: | ||
|special = Values that don't conform to any typical format (see article) | |special = Values that don't conform to any typical format (see article) | ||
|#default = Warning: Unknown value type selected! Please [{{fullurl:{{FULLPAGENAME}}|action=edit}} edit] this page and fix the [[Template:Values|Values template]]. | |#default = Warning: Unknown value type selected! Please [{{fullurl:{{FULLPAGENAME}}|action=edit}} edit] this page and fix the [[Template:Values|Values template]]. | ||
| − | }}</includeonly><noinclude>This template generates standardized value type descriptions for a number of common types, to be used in the <code>values=</code> parameter of [[Template:Flag]]. | + | }}</includeonly> |
| + | |||
| + | <noinclude>This template generates standardized value type descriptions for a number of common types, to be used in the <code>values=</code> parameter of [[Template:Flag]]. | ||
==Usage== | ==Usage== | ||
| Line 51: | Line 56: | ||
|- | |- | ||
|[[Help:Values#Integers|Unsigned integers]] | |[[Help:Values#Integers|Unsigned integers]] | ||
| − | |<code>unsigned integers</code> | + | |<code>unsigned integers</code>, <code>unsigned integer</code>, or <code>uint</code> |
|- | |- | ||
|[[Help:Values#Floating Point Values|Floating point values]] | |[[Help:Values#Floating Point Values|Floating point values]] | ||
| Line 68: | Line 73: | ||
|<code>strings</code>, <code>string</code>, or <code>str</code> | |<code>strings</code>, <code>string</code>, or <code>str</code> | ||
|- | |- | ||
| − | | | + | |List of [[Help:Values#Strings|strings]] |
|<code>stringlist</code> or <code>listofstrings</code> | |<code>stringlist</code> or <code>listofstrings</code> | ||
| + | |- | ||
| + | |List of [[Help:Values#Integers|integers]] | ||
| + | |<code>intlist</code> or <code>listofints</code> | ||
|- | |- | ||
|[[Help:Values#Colors|Colors]] | |[[Help:Values#Colors|Colors]] | ||
| Line 88: | Line 96: | ||
yields "{{Values|stringlist|[[Animations]]}}". | yields "{{Values|stringlist|[[Animations]]}}". | ||
| − | + | The list separator defaults to "Comma", but can also be explicitly stated in the following way: | |
<pre>{{Values|stringlist|[[Sound filenames]]|separator=Whitespace}}</pre> | <pre>{{Values|stringlist|[[Sound filenames]]|separator=Whitespace}}</pre> | ||
| − | yields "{{Values|stringlist|[[Sound filenames]]|separator=Whitespace}}". | + | This yields "{{Values|stringlist|[[Sound filenames]]|separator=Whitespace}}". |
</noinclude> | </noinclude> | ||
Latest revision as of 21:23, 7 June 2023
This template generates standardized value type descriptions for a number of common types, to be used in the values= parameter of Template:Flag.
Usage
{{Values|VALUE TYPE}}
| Value Type | Codes |
|---|---|
| Signed integers | signed integers, signed integer, integers, integer, or int
|
| Unsigned integers | unsigned integers, unsigned integer, or uint
|
| Floating point values | floats or float
|
| Unsigned Bytes | unsigned bytes, unsigned byte, bytes, or byte
|
| Signed Bytes | signed bytes or signed byte
|
| Boolean values | booleans, boolean, or bool
|
| Strings | strings, string, or str
|
| List of strings | stringlist or listofstrings
|
| List of integers | intlist or listofints
|
| Colors | colors or color
|
| CLSIDs | clsids, clsid, locomotors, or locomotor
|
| Percentages | percentages, percentage, percents, percent, or %
|
| Non conforming values | special
|
In the case of strings and stringlist, a second parameter can be added to note what the strings are limited to. For example:
{{Values|stringlist|[[Animations]]}}
yields "Comma-separated list of strings. (Limited to: Animations)
".
The list separator defaults to "Comma", but can also be explicitly stated in the following way:
{{Values|stringlist|[[Sound filenames]]|separator=Whitespace}}
This yields "Whitespace-separated list of strings. (Limited to: Sound filenames)
".
