PickColour
Script function

world.PickColour

DOC_scripting Read about scripting

Type

Method

Summary

Invokes the MUSHclient colour picker dialog

Prototype

long PickColour(long Suggested);

DOC_data_types View list of 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.



See Also ...

Topics

DOC_colours Colour management
DOC_defaults Default triggers/aliases/timers/macros/colours

Functions

FNC_AdjustColour AdjustColour (Adjust an RGB colour)
FNC_ANSI ANSI (Generates an ANSI colour sequence)
FNC_BoldColour BoldColour (Gets/sets the RGB colour for one of the 8 ANSI bold colours)
FNC_ColourNameToRGB ColourNameToRGB (Converts a named colour to a RGB colour code.)
FNC_ColourNote ColourNote (Sends a message to the output window in specified colours)
FNC_ColourTell ColourTell (Sends a message to the output window in specified colours - not terminated by a newline)
FNC_CustomColourBackground CustomColourBackground (Sets the RGB value for the background of a custom colour)
FNC_CustomColourText CustomColourText (Sets the RGB value for the text of a custom colour)
FNC_Debug Debug (Displays debugging information about the world)
FNC_GetCustomColourName GetCustomColourName (Gets the name of a custom colour)
FNC_GetMapColour GetMapColour (Returns the mapping for how a particular colour will be displayed)
FNC_MapColour MapColour (Changes the colour mapping - the way colours are displayed)
FNC_MapColourList MapColourList (Returns an array of all the mapped colours)
FNC_NormalColour NormalColour (Gets/sets the RGB colour for one of the 8 ANSI normal colours)
FNC_NoteColour NoteColour (Chooses which custom colour will be used for world notes.)
FNC_NoteColourBack NoteColourBack (Chooses which RGB colour will be used for world notes - background colour)
FNC_NoteColourFore NoteColourFore (Chooses which RGB colour will be used for world notes - text colour)
FNC_NoteColourName NoteColourName (Chooses which RGB colour name will be used for world notes - text and background)
FNC_NoteColourRGB NoteColourRGB (Chooses which RGB colour will be used for world notes - text and background)
FNC_RGBColourToName RGBColourToName (Converts an RGB colour code to its equivalent name)
FNC_SetCustomColourName SetCustomColourName (Sets the name of a custom colour)

(Help topic: function=PickColour)

DOC_contents Documentation contents page