API:ColorPickerClear

UI Lua API · ColorPicker functions
Version: WAR 1.4.8

Removes all colour swatches from a ColorPicker.

ColorPickerClear(colorPickerName)

Arguments

colorPickerName

string – Name of the ColorPicker.

Returns

Nothing.

Details

• After the call the next ColorPickerAddColor starts again at the top-left grid position.
• Size, spacing and columns are kept.
• ColorPickerCreateWithColorTable clears the picker itself, so you do not need to call this first.
• The stock UI never calls this function.

Errors

• Error in function call 'ColorPickerClear': Window %s does not exist
• Error in function call 'ColorPickerClear': Window %s is not a ColorPicker

Example

A minimal example built from the signature:

ColorPickerClear( "MyColorPicker" )

See also

• ColorPickerAddColor
• ColorPickerCreateWithColorTable