GetNoteStyle
Script function

world.GetNoteStyle

DOC_scripting Read about scripting

Type

Method

Summary

Gets the style for notes

Prototype

short GetNoteStyle();

DOC_data_types View list of data type meanings


Description

This gets the text style for world.note and similar functions.

The styles are 1 bit each, which can be added or OR'ed together.

The style bits are:

1 = bold
2 = underline
4 = blink (italic)
8 = inverse



VBscript example

Note GetNoteStyle



Jscript example

Note (GetNoteStyle ());



PerlScript example

Note (GetNoteStyle ());



Python example

Note (GetNoteStyle ())



Lua example

Note (GetNoteStyle ())



Return value

The style currently in force for notes.




See Also ...

Topic

DOC_note Notes

Functions

FNC_AnsiNote AnsiNote (Make a note in the output window from text with ANSI colour codes imbedded)
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_DoAfterNote DoAfterNote (Adds a one-shot, temporary note timer - simplified interface)
FNC_Hyperlink Hyperlink (Creates a hyperlink in the output window)
FNC_Note Note (Sends a note to the output window)
FNC_NoteHr NoteHr (Draws a horizontal rule in the output window)
FNC_NoteStyle NoteStyle (Sets the style for notes)
FNC_SetNotes SetNotes (Sets the notes for the world.)
FNC_Tell Tell (Sends a message to the output window - not terminated by a newline)

(Help topic: function=GetNoteStyle)

DOC_contents Documentation contents page