[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.PickColour


Name PickColour
Type Method
Summary Invokes the MUSHclient colour picker dialog
Prototype long PickColour(long Suggested);

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.


Note: Available in version 3.22 onwards.


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)
Returns The chosen colour, or -1 if the dialog box was dismissed.
Introduced in version 3.22

See also ...

Function Description
BoldColour Gets/sets the RGB colour for one of the 8 ANSI bold colours
ColourNameToRGB Converts a named colour to a RGB colour code.
CustomColourBackground Sets the RGB value for the background of a custom colour
CustomColourText Sets the RGB value for the text of a custom colour
Debug Displays debugging information about the world
MapColour Changes the colour mapping - the way colours are displayed
NormalColour Gets/sets the RGB colour for one of the 8 ANSI normal colours
NoteColourBack Chooses which RGB colour will be used for world notes - background colour
NoteColourFore Chooses which RGB colour will be used for world notes - text colour
NoteColourName Chooses which RGB colour name will be used for world notes - text and background
NoteColourRGB Chooses which RGB colour will be used for world notes - text and background
RGBColourToName Converts an RGB colour code to its equivalent name

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.


Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes


Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes


View all functions

[Back]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]