Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.NotepadFont

Name NotepadFont
Type Method
Summary Changes the font and style of the selected notepad window
Prototype long NotepadFont(BSTR Title, BSTR FontName, short Size, short Style, short Charset);

View list of data type meanings
Description

This lets you change the font, font size, style, and character set of the font for an open notepad window.

eg.

NotepadFont ("test", "Comic Sans MS", 11, 0, 0)

The arguments are:

notepad name
font name
font size
style bits
character set

If the font name is empty, then the font is unchanged.

If the font size is zero, then the font size is unchanged. The font size is in points.

The style should be a combination of the numbers below (zero is just plain text). For instance, bold and italic would be 3.

Style bits:

1 = bold
2 = italic
4 = underline
8 = strikeout

Note: Available in version 3.57 onwards.
VBscript example 
NotepadFont "test", "Comic Sans MS", 11, 0, 0
Jscript example 
NotepadFont ("test", "Comic Sans MS", 11, 0, 0);
Lua example 
NotepadFont ("test", "Comic Sans MS", 11, 0, 0)
Lua notes 
The charset argument is optional and defaults to zero.
Returns 0 = Could not do it (eg. that notepad does not exist)
1 = Font and style changed OK.
Introduced in version 3.57

See also ...

Function Description
GetMainWindowPosition Returns the position and size of the main MUSHclient window
GetNotepadList Gets the list of open notepads - returning their titles
GetNotepadWindowPosition Returns the position and size of the specified notepad window
GetWorldWindowPosition Returns the position and size of the current world window
MoveMainWindow Move and resize the main MUSHclient window
MoveWorldWindow Move and resize a world window
NotepadColour Changes the text and background colour of the selected notepad window

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions

[Back]

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

Home