Difference between revisions of "Template:FunctionArgument"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>SnakeChomp
(Add example for optional arg)
imported>SnakeChomp
(Document template syntax)
Line 1: Line 1:
<noinclude>
<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)
|Optional = If specified, the argument is optional
|Values = If specified, the given set of values is shown instead of the type
}}
</pre>
=Example 1=
=Example 1=



Revision as of 17:33, 30 January 2009


Template syntax

{{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)
|Optional = If specified, the argument is optional
|Values = If specified, the given set of values is shown instead of the type
}}

Example 1

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

 foo:int

Example 2

{{FunctionArgument
|Values = {0, 1}
}}

 {0, 1}

Example 3

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

 flag{0, 1}

Example 4

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

 foo:int