LogSend
Script function

world.LogSend

DOC_scripting Read about scripting

Type

Method

Summary

Sends a message to the MUD and logs it

Prototype

long LogSend(BSTR Message);

DOC_data_types View list of data type meanings

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.

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.


Return value

eWorldClosed : The world is closed
eItemInUse : Cannot be called from within OnPluginSent script callback
eOK: Sent OK


DOC_errors View list of return code meanings

See Also ...

Topic

DOC_logging Logging

Functions

FNC_CloseLog CloseLog (Closes the log file)
FNC_FlushLog FlushLog (Flushes the log file to disk)
FNC_IsLogOpen IsLogOpen (Tests to see if a log file is open)
FNC_LogInput LogInput (The property of whether commands are logged to the log file)
FNC_LogNotes LogNotes (The property of whether notes are logged to the log file)
FNC_LogOutput LogOutput (The property of whether MUD output is logged to the log file)
FNC_Note Note (Sends a note to the output window)
FNC_OpenLog OpenLog (Opens a log file.)
FNC_Send Send (Sends a message to the MUD)
FNC_WriteLog WriteLog (Writes to the log file)

(Help topic: function=LogSend)

DOC_contents Documentation contents page