Name NoteColour
Type Property
Summary Chooses which custom colour will be used for world notes.
Prototype short NoteColour;
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).
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
Returns This is a property. You can use it to find the current note colour.

See also ...