world.GetRecentLines

MUSHclient script function (Method) — introduced in version 3.48

Assembles a block of text from recent MUD output

Prototype

BSTR GetRecentLines(long Count);

Data type meanings

Description

This returns a block of text consisting of the nominated number of recently-arrived lines from the MUD.

It excludes notes or commands you type.

It includes lines even if they have been omitted from output by a trigger.

A "line" is a string of text from the MUD followed by a newline character. This is different from the lines returned by GetLineInfo which are physical lines which appear in the output window. Thus a line here might be shown as 5 lines on the screen if they wrapped around to fit them in.

The maximum number of lines stored by MUSHclient is the most recent 100. Thus, even if you request more than 100 lines you will only get 100.

The number you nominate is counted from the bottom, so if you ask for 1 line it will be the most recent, 2 lines will be the most recent 2 lines and so on.

VBscript example

world.Note GetRecentLines (10)

Lua example

Note (GetRecentLines (10))

Return value

A string containing the nominated number of lines of recent MUD output, separated by the newline character (hex 0A).