Optional Arguments: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 5: | Line 5: | ||
Example: | Example: | ||
<syntaxhighlight lang="lua">vehicle createVehicle ( model, x, y, z, [rx, ry, rz] )</syntaxhighlight> | |||
In this example, '''rx''', '''ry''', and '''rz''' are [[Optional Arguments]]. | In this example, '''rx''', '''ry''', and '''rz''' are [[Optional Arguments]]. |
Revision as of 21:23, 17 May 2006
Optional Arguments are arguments that are passed to a function but are not required for the function to run. Often, if you do not specify them, default values will be used instead.
When loolking at the Syntax for an argument, Optional arguments are always enclosed in Square brackets
Example:
vehicle createVehicle ( model, x, y, z, [rx, ry, rz] )
In this example, rx, ry, and rz are Optional Arguments.
Using Optional Arguments
Optional Arguments have one limitation. You cannot use any optional arguments unless all previous arguments are also supplied.
This means that in the previous example, if you wanted to supply rz, you would also need to supply rx, and ry in order.