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

MUSHclient scripting

Description of MUSHclient world function: world.AppendToNotepad


Name AppendToNotepad
Type Method
Summary Appends text to a notepad window
Prototype boolean AppendToNotepad(BSTR Title, BSTR Contents);

View list of data type meanings

Description

Appends the text to a notepad window of the given title. If no such window exists, it is created.

The function "AppendToNotepad" 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).

You might use GetNotepadLength to check if there is likely to be room in the notepad for the new text.

VBscript example
world.AppendToNotepad "Nick's window", "More stuff" + vbcrlf
Jscript example
world.AppendToNotepad("Nick's window", "More stuff\r\n");
PerlScript example
$world->AppendToNotepad("Nick's window", "More stuff\r\n");
Python example
world.AppendToNotepad("Nick's window", "More stuff\r\n")
Lua example
AppendToNotepad("Nick's window", "More stuff\r\n",
                "another line")
Lua notes
You can supply multiple arguments after the notepad name, which are concatenated together.
Returns 0: Could not do it.
1: Appended OK

See also ...

Function Description
Activate Activates the world window
ActivateNotepad Activates 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
ReplaceNotepad Replaces text in a notepad window
SaveNotepad Saves a notepad window to disk
SendToNotepad Creates a notepad and sends text to it

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]