Difference between revisions of "Template:FunctionArgument"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Cipscis
(Fixed typos - Values -> Value)
imported>Cipscis
(→‎Example 4: Added default value)
 
Line 50: Line 50:
|Name = foo
|Name = foo
|Type = int
|Type = int
|Value = 0,1
|Value = 0, 1; Default = 0
|Optional = y
|Optional = y
}}</pre>
}}</pre>
Line 57: Line 57:
|Name = foo
|Name = foo
|Type = int
|Type = int
|Value = 0,1
|Value = 0, 1; Default = 0
|Optional = y
|Optional = y
}}
}}


</noinclude>
</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}