Difference between revisions of "Template:FunctionArgument"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>SnakeChomp
(Testing whether we can use a sub template for function arguments)
 
imported>Cipscis
(→‎Example 4: Added default value)
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<noinclude>
<includeonly>&nbsp;{{#if: {{{Optional|}}} | '' |}}{{#if: {{{Name|}}} | {{{Name}}} |}}{{#if: {{{Type|}}}|<nowiki>:</nowiki>{{{Type}}}|}}{{#if: {{{Value|}}} | <nowiki>{</nowiki>{{{Value}}}<nowiki>}</nowiki>}}{{#if: {{{Optional|}}} | '' |}}</includeonly><noinclude>
 
=Template syntax=
 
<pre>{{FunctionArgument
|Name = The name of the function argument. May be omitted, but it only makes sense
        to do so when ''Values'' is specified.
|Type = The type of the function argument (int, float, ref, string, ...)
|Optional = If specified, the argument is optional
|Value = If specified, appears after the name and type information.
}}
</pre>
=Example 1=
 
<pre>{{FunctionArgument
|Name = foo
|Type = int
}}</pre>
 
{{FunctionArgument
|Name = foo
|Type = int
}}
 
=Example 2=
 
<pre>{{FunctionArgument
|Value = 0, 1
}}</pre>
 
{{FunctionArgument
|Value = 0, 1
}}
 
=Example 3=
 
<pre>{{FunctionArgument
|Name = flag
|Value = 0, 1
}}</pre>
 
{{FunctionArgument
|Name = flag
|Value = 0, 1
}}
 
=Example 4=


<pre>{{FunctionArgument
<pre>{{FunctionArgument
|Name = foo
|Name = foo
|Type = int
|Type = int
|Example = 0/1
|Value = 0, 1; Default = 0
|Optional = y
}}</pre>
}}</pre>


{{FunctionArgumentTest
{{FunctionArgument
|Name = foo
|Name = foo
|Type = int
|Type = int
|Example = 0/1/2
|Value = 0, 1; Default = 0
|Optional = y
}}
}}


</noinclude><includeonly>{{{Name}}}:{{{Type}}}{{#if: {{{Example|}}} | ({{{Example}}}) |}}</includeonly>
</noinclude>

Latest revision as of 01:10, 15 May 2009


Template syntax[edit source]

{{FunctionArgument
|Name = The name of the function argument. May be omitted, but it only makes sense
        to do so when ''Values'' is specified.
|Type = The type of the function argument (int, float, ref, string, ...)
|Optional = If specified, the argument is optional
|Value = If specified, appears after the name and type information.
}}

Example 1[edit source]

{{FunctionArgument
|Name = foo
|Type = int
}}

 foo:int

Example 2[edit source]

{{FunctionArgument
|Value = 0, 1
}}

 {0, 1}

Example 3[edit source]

{{FunctionArgument
|Name = flag
|Value = 0, 1
}}

 flag{0, 1}

Example 4[edit source]

{{FunctionArgument
|Name = foo
|Type = int
|Value = 0, 1; Default = 0
|Optional = y
}}

 foo:int{0, 1; Default = 0}