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

MUSHclient scripting

Description of MUSHclient world function: world.NotepadReadOnly


Name NotepadReadOnly
Type Method
Summary Make a selected notepad window read-only
Prototype long NotepadReadOnly(BSTR Title, BOOL ReadOnly);

View list of data type meanings

Description

This lets you mark a notepad window as read-only.

This might be useful for help screens or other "output-only" information.

You can specify true or false as the second argument. Under Lua, it defaults to true.


Note: Available in version 4.30 onwards.


VBscript example
NotepadReadOnly "test", vbTrue
Jscript example
NotepadReadOnly ("test", true);
Lua example
NotepadReadOnly ("test", true)
Lua notes
The ReadOnly argument is optional and defaults to true.
Returns 0 = Could not do it (eg. that notepad does not exist)
1 = Changed status OK.
Introduced in version 4.30

See also ...

Function Description
GetNotepadList Gets the list of open notepads - returning their titles
GetNotepadWindowPosition Returns the position and size of the specified notepad window
NotepadColour Changes the text and background colour of the selected notepad window
NotepadFont Changes the font and style 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]

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]