Difference between revisions of "Template:FunctionArgument"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>SnakeChomp
(Move template code to the top. Add Value to example 4.)
imported>Cipscis
(Fixed typos - Values -> Value)
Line 8: Line 8:
|Type = The type of the function argument (int, float, ref, string, ...)
|Type = The type of the function argument (int, float, ref, string, ...)
|Optional = If specified, the argument is optional
|Optional = If specified, the argument is optional
|Values = If specified, appears after the name and type information.
|Value = If specified, appears after the name and type information.
}}
}}
</pre>
</pre>
Line 26: Line 26:


<pre>{{FunctionArgument
<pre>{{FunctionArgument
|Values = 0, 1
|Value = 0, 1
}}</pre>
}}</pre>


Line 37: Line 37:
<pre>{{FunctionArgument
<pre>{{FunctionArgument
|Name = flag
|Name = flag
|Values = 0, 1
|Value = 0, 1
}}</pre>
}}</pre>



Revision as of 01:57, 15 May 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, string, ...)
|Optional = If specified, the argument is optional
|Value = If specified, appears after the name and type information.
}}

Example 1

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

 foo:int

Example 2

{{FunctionArgument
|Value = 0, 1
}}

 {0, 1}

Example 3

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

 flag{0, 1}

Example 4

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

 foo:int{0,1}