DeleteLines
Script function

world.DeleteLines

DOC_scripting Read about scripting

Type

Method

Summary

Clears some recent lines from the output window.

Prototype

void DeleteLines(long Count);

DOC_data_types 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.

VBscript example

world.DeleteLines (10)


Jscript example

world.DeleteLines(10);


PerlScript example

$world->DeleteLines(10);


Python example

world.DeleteLines (10)


Lua example

DeleteLines(10)


Return value

Nothing.



See Also ...

Function

FNC_DeleteOutput DeleteOutput (Clears all output from the output window.)

(Help topic: function=DeleteLines)

DOC_contents Documentation contents page