NoteColour
Script function

world.NoteColour

DOC_scripting Read about scripting

Type

Property

Summary

Chooses which custom colour will be used for world notes.

Prototype

short NoteColour;

DOC_data_types View list of data type meanings

Description

You can get or set this to change the colour (number) that the *next* world.note will be displayed in. The valid range is 0 to 16, where 0 is "no change", 1 is custom colour 1, through to 16 for custom colour 16.

If notes are currently being displayed in RGB mode (using NoteColourFore or NoteColourBack) then getting the NoteColour will return -1.

If notes are currently being displayed in RGB mode (using NoteColourFore or NoteColourBack) then setting the NoteColour will switch back to palette mode (the default).

It may be easier to use ColourNote to display notes in a different colour (in a single function) rather than changing the note colour and then doing a Note.

VBscript example

world.notecolour = 15  ' set note colour to use custom colour 15
world.note "This will be in custom colour 15"
world.note world.notecolour  ' display current note colour


Jscript example

world.notecolour = 15;  // set note colour to use custom colour 15
world.note("This will be in custom colour 15");
world.note(world.notecolour);  // display current note colour


PerlScript example

$world->{notecolour} = 15;  # set note colour to use custom colour 15
$world->note("This will be in custom colour 15");
$world->note($world->{notecolour});  # display current note colour


Python example

world.notecolour = 15  # set note colour to use custom colour 15
world.note("This will be in custom colour 15")
world.note(world.notecolour)  # display current note colour


Lua example

Note (GetNoteColour ())  
SetNoteColour (15) -- use custom colour 15


Lua notes

Lua implements this as two functions:

GetNoteColour - gets the note colour
SetNoteColour - sets the note colour


Return value

This is a property. You can use it to find the current note colour.



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_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_Note Note (Sends a note to the output window)
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_NoteStyle NoteStyle (Sets the style for notes)
FNC_PickColour PickColour (Invokes the MUSHclient colour picker dialog)
FNC_RGBColourToName RGBColourToName (Converts an RGB colour code to its equivalent name)
FNC_SetCustomColourName SetCustomColourName (Sets the name of a custom colour)
FNC_Tell Tell (Sends a message to the output window - not terminated by a newline)

(Help topic: function=NoteColour)

DOC_contents Documentation contents page