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

MUSHclient scripting

Description of MUSHclient world function: world.WindowWrite

Name WindowWrite
Type Method
Summary Writes the contents of a miniwindow to disk as a graphics file
Prototype long WindowWrite(BSTR WindowName, BSTR FileName);

View list of data type meanings


The entire contents of the named miniwindow are written to disk as file name FileName. The file name must end in .PNG or .BMP. Based on the file name, either a BMP or PNG file is written.

The file name is not case-sensitive.

Note: Available in version 4.36 onwards.

Lua example
WindowWrite (win, "window_saved.png");
Returns eNoSuchWindow - no such miniwindow

eNoNameSpecified - no file name specified

eBadParameter - file name too short or does not end in .BMP or .PNG

eCouldNotOpenFile - cannot open file (eg. pathname does not exist, no write permissions)

eLogFileBadWrite - problem writing (eg. disk full)

eOK - success

View list of return code meanings

Introduced in version 4.36

See also ...

Function Description
WindowLoadImage Loads an image into a miniwindow from a disk file

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]