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

MUSHclient scripting

Description of MUSHclient world function: world.SendToNotepad

Name SendToNotepad
Type Method
Summary Creates a notepad and sends text to it
Prototype boolean SendToNotepad(BSTR Title, BSTR Contents);

View list of data type meanings


Creates a notepad window with the nominated title and contents.

The contents are copied "as is" without a trailing newline. If you want a newline you will need to add it yourself. The built-in constant "vbcrlf" can be used for this purpose in Visual Basic.

VBscript example
world.SendToNotepad "Nick's window", "Hello, world" & _
              vbcrlf & "another line"
Jscript example
world.SendToNotepad("Nick's window", 
                    "Hello, world\r\nanother line")
PerlScript example
$world->SendToNotepad("Nick's window", 
                  "Hello, world\r\nanother line");
Python example
world.SendToNotepad("Nick's window", 
                    "Hello, world\r\nanother line")
Lua example
SendToNotepad ("Nick's window", 
               "Hello, world\r\nanother line")
Lua notes
You can supply multiple arguments after the notepad name, which are concatenated together.
Returns 0: Window not created.
1: Window created OK

See also ...

Function Description
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
ReplaceNotepad Replaces text in a notepad window
SaveNotepad Saves a notepad window to disk

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


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.


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]