Template:FunctionArgument

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search


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}