ModEnc is currently in Maintenance Mode: Changes could occur at any given moment, without advance warning.

Difference between revisions of "Template:Values"

From ModEnc
Jump to: navigation, search
m (Fixing space)
(Added uint as another shorthand for unsigned integer)
 
(8 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
|signed integer
 
|signed integer
 
|signed integers
 
|signed integers
 +
|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 4294967296.
+
|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
 
|byte
 
|byte
−
|bytes = [[Help:Values#Bytes|Unsigned Bytes:]] All whole numbers from 0 to 255.
+
|bytes = [[Help:Values#Bytes|Unsigned Bytes]]: All whole numbers from 0 to 255.
 
|signed byte
 
|signed byte
−
|signed bytes = [[Help:Values#Bytes|Signed Bytes:]] All whole numbers from -128 to 127.
+
|signed bytes = [[Help:Values#Bytes|Signed Bytes]]: All whole numbers from -128 to 127.
 +
|bool
 
|boolean
 
|boolean
−
|booleans = [[Help:Values#Boolean values|Boolean values:]] yes or no, true or false, 1 or 0
+
|booleans = [[Help:Values#Boolean values|Boolean values]]: yes or no, true or false, 1 or 0
 +
|str
 
|string
 
|string
−
|strings = [[Help:Values#Strings|Strings:]] Normal text. {{#if: {{{2|}}} | (Limited to: {{{2}}})}}
+
|strings = [[Help:Values#Strings|Strings]]: Normal text. {{#if: {{{2|}}} | (Limited to: {{{2}}})}}
 
|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
 
|locomotor
 
|locomotor
−
|locomotors = [[Help:Values#CLSIDs/Locomotors|CLSIDs:]] Usually [[Locomotors]], but can be [[AIGenerals|AIGeneral-names]] as well.
+
|locomotors = [[Help:Values#CLSIDs/Locomotors|CLSIDs]]: Usually [[Locomotors]], but can be [[AIGenerals|AIGeneral-names]] as well.
−
|lepton
+
|percent
−
|leptons = [[Lepton|Leptons:]] Whole numbers - 1 lepton is 1/256th of a map cell.
+
|percents
 
|percentage
 
|percentage
 
|percentages
 
|percentages
−
|% = [[Help:Values#Percentages|Percentages:]] Either a direct percentage (e.g. "50%"), or a [[Help:Values#Floating Point Values|floating point value]] (e.g. "0.5").
+
|% = [[Help:Values#Percentages|Percentages]]: Either a direct percentage (e.g. "50%"), or a [[Help:Values#Floating Point Values|floating point value]] (e.g. "0.5").
−
|special = Values that don't conform to any typical format (see below)
+
|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 39: Line 47:
  
  
−
 
+
{| align="center" cellpadding="4" class="table_descrow"
−
Currently valid value types are:
+
|+'''Valid Value Type Codes'''
−
*<code>signed integers</code> '''or''' <code>integers</code>
+
!Value Type
−
*<code>unsigned integers</code>
+
!Codes
−
*<code>floats</code>
+
|-
−
*<code>unsigned bytes</code> '''or''' <code>bytes</code>
+
|[[Help:Values#Integers|Signed integers]]
−
*<code>signed bytes</code>
+
|<code>signed integers</code>, <code>signed integer</code>, <code>integers</code>, <code>integer</code>, or <code>int</code>
−
*<code>booleans</code>
+
|-
−
*<code>strings</code>
+
|[[Help:Values#Integers|Unsigned integers]]
−
*<code>stringlist</code> '''or''' <code>listofstrings</code>
+
|<code>unsigned integers</code>, <code>unsigned integer</code>, or <code>uint</code>  
−
*<code>colors</code>
+
|-
−
*<code>clsids</code> '''or''' <code>locomotors</code>
+
|[[Help:Values#Floating Point Values|Floating point values]]
−
*<code>leptons</code>
+
|<code>floats</code> or <code>float</code>
−
*<code>percentages</code>
+
|-
−
*<code>special</code>
+
|[[Help:Values#Bytes|Unsigned Bytes]]
 +
|<code>unsigned bytes</code>, <code>unsigned byte</code>, <code>bytes</code>, or <code>byte</code>
 +
|-
 +
|[[Help:Values#Bytes|Signed Bytes]]
 +
|<code>signed bytes</code> or <code>signed byte</code>
 +
|-
 +
|[[Help:Values#Boolean values|Boolean values]]
 +
|<code>booleans</code>, <code>boolean</code>, or <code>bool</code>
 +
|-
 +
|[[Help:Values#Strings|Strings]]
 +
|<code>strings</code>, <code>string</code>, or <code>str</code>
 +
|-
 +
|List of [[Help:Values#Strings|strings]]
 +
|<code>stringlist</code> or <code>listofstrings</code>
 +
|-
 +
|List of [[Help:Values#Integers|integers]]
 +
|<code>intlist</code> or <code>listofints</code>
 +
|-
 +
|[[Help:Values#Colors|Colors]]
 +
|<code>colors</code> or <code>color</code>
 +
|-
 +
|[[Help:Values#CLSIDs/Locomotors|CLSIDs]]
 +
|<code>clsids</code>, <code>clsid</code>, <code>locomotors</code>, or <code>locomotor</code>
 +
|-
 +
|[[Help:Values#Percentages|Percentages]]
 +
|<code>percentages</code>, <code>percentage</code>, <code>percents</code>, <code>percent</code>, or <code>%</code>
 +
|-
 +
|Non conforming values
 +
|<code>special</code>
 +
|}
  
 
In the case of <code>strings</code> and <code>stringlist</code>, a second parameter can be added to note what the strings are limited to. For example:
 
In the case of <code>strings</code> and <code>stringlist</code>, a second parameter can be added to note what the strings are limited to. For example:
Line 59: Line 96:
 
yields "{{Values|stringlist|[[Animations]]}}".
 
yields "{{Values|stringlist|[[Animations]]}}".
  
−
In cause of <code>stringlist</code>, an additional argument <code>separator</code> can be provided. It defaults to "Comma" and describes the separator between the list entries. For example:  
+
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}}


Valid Value Type Codes
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)

".

Retrieved from "https://modenc.renegadeprojects.com/index.php?title=Template:Values&oldid=22188"