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

MUSHclient scripting

Description of MUSHclient world function: world.DeleteLines


Name DeleteLines
Type Method
Summary Clears some recent lines from the output window.
Prototype void DeleteLines(long Count);

View list of data type meanings

Description

Clears 'Count' lines from the output window, starting at the end (most recently-displayed).

This allows you to script the omission of recently-received lines (for example, in a multi-line trigger).

All line types are omitted (whether received from the MUD, command input, or Note lines). A line is counted as a physical line on the screen, it does not necessarily end in a newline character.

Warning - do NOT call DeleteLines from a trigger, alias or timer using send-to-script. For design reasons this will not work. In version 3.76 you will cause the client to crash if you do this. In version 3.77 upwards it will silently fail (ie. do nothing).

If you want to call DeleteLines from a trigger you must call a function in your script file (or plugin script), not directly from send-to-script.

You can also not call it from a plugin callback.


Note: Available in version 3.76 onwards.


VBscript example
world.DeleteLines (10)
Jscript example
world.DeleteLines(10);
PerlScript example
$world->DeleteLines(10);
Python example
world.DeleteLines (10)
Lua example
DeleteLines(10)
Returns Nothing.
Introduced in version 3.76

See also ...

Function Description
DeleteOutput Clears all output from 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]