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

MUSHclient scripting

Description of MUSHclient world function: world.GetRecentLines


Name GetRecentLines
Type Method
Summary Assembles a block of text from recent MUD output
Prototype BSTR GetRecentLines(long Count);

View list of 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.


Note: Available in version 3.48 onwards.


VBscript example
world.Note GetRecentLines (10)
Lua example
Note (GetRecentLines (10))
Returns A string containing the nominated number of lines of recent MUD output, separated by the newline character (hex 0A).
Introduced in version 3.48

See also ...

Function Description
GetLineInfo Gets details about a specified line in the output window

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]

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.

[Home]


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]