AnsiNote
Script function

world.AnsiNote

DOC_scripting Read about scripting

Type

Method

Summary

Make a note in the output window from text with ANSI colour codes imbedded

Prototype

void AnsiNote(BSTR Text);

DOC_data_types View list of data type meanings

Description

Sends "Text" to the output window, changing colour, bold, underline etc. if it gets ANSI sequences in the text. ANSI sequences are things like ESC [ 30 m. You can use the ANSI function to set them up.

AnsiNote saves the current world note colour, and restores it afterwards, so that any colour changes do not persist to subsequent note lines.

The ANSI sequences defined in the ANSI function will be recognised.

VBscript example

AnsiNote ANSI (32) & ANSI (1) & ANSI (43) & _
          "This is bold green text on a yellow background"


Jscript example

AnsiNote (ANSI (32) + ANSI (1) + ANSI (43) + 
         "This is bold green text on a yellow background");


PerlScript example

AnsiNote (ANSI (32) . ANSI (1) . ANSI (43) . 
         "This is bold green text on a yellow background");


Python example

world.AnsiNote (world.ANSI (32) + world.ANSI (1) + world.ANSI (43) + 
"This is bold green text on a yellow background")


Lua example

AnsiNote (ANSI (32, 1, 43),
          "This is bold green text on a yellow background")


Lua notes

You can supply multiple arguments, which are concatenated together.


Return value

Nothing.



See Also ...

Topic

DOC_note Notes

Functions

FNC_ANSI ANSI (Generates an ANSI colour sequence)
FNC_ChatNote ChatNote (Does a note using ANSI codes for the chat system)
FNC_ColourNote ColourNote (Sends a message to the output window in specified colours)
FNC_DoAfterNote DoAfterNote (Adds a one-shot, temporary note timer - simplified interface)
FNC_GetNoteStyle GetNoteStyle (Gets the style for notes)
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_StripANSI StripANSI (Strips ANSI colour sequences from a string)
FNC_Tell Tell (Sends a message to the output window - not terminated by a newline)

(Help topic: function=AnsiNote)

DOC_contents Documentation contents page