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

MUSHclient scripting

Description of MUSHclient world function: world.WriteLog

Name WriteLog
Type Method
Summary Writes to the log file
Prototype long WriteLog(BSTR Message);

View list of data type meanings


This writes a message to the log file.

A "newline" is appended to the line if there is not already one there.

You can also use "LogSend" to send a message to the MUD, and log it, in a single function.

The data in the log file may not appear immediately if you view it in another application. To force the data to disk use the FlushLog function.

VBscript example
world.writelog "--- Message for the log file ---"
Jscript example
world.WriteLog("--- Message for the log file ---");
PerlScript example
$world->WriteLog("--- Message for the log file ---");
Python example
world.WriteLog("--- Message for the log file ---")
Lua example
WriteLog("--- Message for the log file ---")
Lua notes
You can supply multiple arguments, which are concatenated together.
Returns eOK: written OK
eLogFileBadWrite: unable to write to the log file
eLogFileNotOpen: log file was not open

View list of return code meanings

See also ...

Function Description
CloseLog Closes the log file
FlushLog Flushes the log file to disk
IsLogOpen Tests to see if a log file is open
LogSend Sends a message to the MUD and logs it
OpenLog Opens a log 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]