Optional Arguments

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.

If you do not want to specify the previous arguments, use "nil", which is what tells LUA not to set the argument to anything.

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.