Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.LogSend


Name LogSend
Type Method
Summary Sends a message to the MUD and logs it
Prototype long LogSend(BSTR Message);
Description

This sends the specified text to the world. It is like typing it into the command window.

The message text is also logged to the current log file, if one is open.

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.


Note: Available in version 3.25 onwards.


VBscript example
world.logsend "go north"
Jscript example
world.LogSend("go north");
PerlScript example
$world->LogSend("go north");
Python example
world.LogSend("go north")
Lua example
LogSend 
[[
go north
eat food
drink water
]]
Lua notes
You can supply multiple arguments, which are concatenated together.
Returns eWorldClosed : The world is closed
eItemInUse : Cannot be called from within OnPluginSent script callback
eOK: Sent OK
Introduced in version 3.25

See also ...

Function Description
FlushLog Flushes the log file to disk
Note Sends a note to the output window
Send Sends a message to the MUD
WriteLog Writes to the 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

[Back]

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