MUSHclient scripting

Description of MUSHclient world function: world.ReplaceNotepad

Name	ReplaceNotepad
Type	Method
Summary	Replaces text in a notepad window
Prototype	`boolean ReplaceNotepad(BSTR Title, BSTR Contents);` View list of data type meanings
Description	Replaces the text in a notepad window of the given title. If no such window exists, it is created. The function "ReplaceNotepad" does not activate (bring to the front) the notepad window. However the function "ActivateNotepad" can be used to do that. You can use world.activate to activate the world itself (eg. you might want to do that after creating a notepad window).
VBscript example	`world.ReplaceNotepad "Nick's window", "New contents" + vbcrlf`
Jscript example	`world.ReplaceNotepad("Nick's window", "New contents\r\n");`
PerlScript example	`$world->ReplaceNotepad("Nick's window", "New contents\r\n");`
Python example	`world.ReplaceNotepad("Nick's window", "New contents\r\n")`
Lua example	`ReplaceNotepad("Nick's window", "New contents\r\n")`
Lua notes	`You can supply multiple arguments after the notepad name, which are concatenated together.`
Returns	`0: Could not do it. 1: Replaced OK`

See also ...

Function	Description
Activate	Activates the world window
ActivateNotepad	Activates a notepad window
AppendToNotepad	Appends text to a notepad window
CloseNotepad	Closes a notepad window
GetNotepadLength	Gets the length of the text in a notepad window
GetNotepadList	Gets the list of open notepads - returning their titles
GetNotepadText	Gets the text from a notepad window
NotepadReadOnly	Make a selected notepad window read-only
SaveNotepad	Saves a notepad window to disk
SendToNotepad	Creates a notepad and sends text to it

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.

Leave blank to show all functions.

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

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

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