Navigation:  LuaScriptConfigurator >

AddArgument

Previous pageReturn to chapter overviewNext page

int AddArgument(string sName,string sDescription,int iFlags);

Return values

A handle that can be used referring to this argument in subsequent calls.

Parameters

sName

Name of the argument field

sDesc

Description of the field

iFlags

Flags controlling validation. See remarks for flags.

Remarks

These are the valid flags. Some of them can be combined.

CHECK_NOTHING                Default value, any type, including no text, is accepted.

CHECK_NOT_EMPTY                Check if argument is empty. Can not be combined with CHECK_NOTHING.

CHECK_RANGE_LOW                Must be used with CHECK_NUMERIC. Validates numeric value is within range (low range).

CHECK_RANGE_HIGH                Must be used with CHECK_NUMERIC. Validates numeric value is within range (high range).

CHECK_NUMERIC                Validates that value is numeric (real or integer)

ENUM_AVAIL                        Indicates that there is a enumeration callback with pre-defined values available for this field.