world.PickColour

MUSHclient script function (Method) — introduced in version 3.22

Invokes the MUSHclient colour picker dialog

Prototype

long PickColour(long Suggested);

Data type meanings

Description

This lets you call the MUSHclient colour picker from within a script. Note that doing this will pause script execution while the dialog is active, and is not recommended for scripts that should run to completion quickly.

eg.

newcolour = PickColour (254)

You supply an existing colour as the starting point, or -1 if none is required, and the function returns the chosen colour, or -1 if the dialog was cancelled. Note that -1 is not a valid colour.

VBscript example

newcolour = PickColour (255)

Jscript example

newcolour = PickColour (255);

PerlScript example

newcolour  = $world->PickColour (255)

Python example

newcolour = world.PickColour (255);

Lua example

newcolour = PickColour (255)

Return value

The chosen colour, or -1 if the dialog box was dismissed.

Related topic

Colour management

See also