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

NoteStyle

Script function

world.NoteStyle

Read about scripting

Type

Method

Summary

Sets the style for notes

Prototype

void NoteStyle(short Style);

View list of data type meanings

Description

This sets 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
32 = strike-through

Therefore:

NoteStyle (0) resets to normal style.

NoteStyle (1) would be bold.

NoteStyle (3) would be bold and underlined.


Styles are reset to normal when a newline is processed, so if you want to have bold/italic etc. over multiple lines you would need to do the NoteStyle at the start of each line.

You can also use AnsiNote to output styled text.

WARNING: Bold italic, and underlined styles will only be visible if the appropriate configurations are enabled in the world Appearance: Output configuration. Otherwise they will be ignored (the same as for text arriving from the MUD).


Available in MUSHclient version 3.42 onwards.



VBscript example

NoteStyle 5  ' bold italic
Note "hello"


Jscript example

NoteStyle (5);  // bold italic
Note ("hello");


PerlScript example

NoteStyle (5)  # bold italic
Note ("hello")


Python example

NoteStyle (5)  # bold italic
Note ("hello")


Lua example

NoteStyle (5)  -- bold italic
Note ("hello")


Return value

Nothing.


See Also ...

Topic

Notes

Functions

(AnsiNote) Make a note in the output window from text with ANSI colour codes imbedded
(ColourNote) Sends a message to the output window in specified colours
(ColourTell) Sends a message to the output window in specified colours - not terminated by a newline
(DoAfterNote) Adds a one-shot, temporary note timer - simplified interface
(GetNoteStyle) Gets the style for notes
(Hyperlink) Creates a hyperlink in the output window
(Note) Sends a note to the output window
(NoteHr) Draws a horizontal rule in the output window
(SetNotes) Sets the notes for the world.
(Tell) Sends a message to the output window - not terminated by a newline

(Help topic: function=NoteStyle)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

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]