SetCycleTable(cycle[, t])

Low:

The pen index that marks that start of the color range.

High:

The pen index that marks the end of the color range.

Rate:

The desired speed of the color cycling effect. A value of 16384 indicates 60 frames per second. All other speeds scale linearly from this base, e.g. a value of 8192 indicates 30 frames per second, and so on.

Reverse:

If this tag is set to True, the colors should be cycled in reverse. Defaults to False.

Active:

If this tag is set to False, the color range will be marked as inactive. Defaults to True.

By default, SetCycleTable() will copy the color cycling table to the current display's palette which is the default active palette but of course only in case the current display is a palette mode display. See Palette mode displays for details. You can select a different palette as the active one by using the SelectPalette() command.

Alternatively, the specified color cycling table can also be set to a different palette object. To do so, you need to pass the optional table argument to SetCyclingTable() and specify the Type and ID tags.

The following tags are supported by the optional table argument t:

Type:

Set this to the type identifier of the object whose color cycling table you want to set. This can be one of the following object types:

#BGPIC #BRUSH #PALETTE

Type defaults to the type of the currently active palette selected using SelectPalette(). See SelectPalette for details.

ID:

Set this tag to the identifier of the object whose cycle table you want to set. The default is the identifier of the currently active palette selected using SelectPalette(). See SelectPalette for details.

cycle

table containing color cycling ranges (see above)

t

optional: table for specifying further options (see above)