world.GetSelectionStartLine

MUSHclient script function (Method) — introduced in version 3.18

Returns the starting line of the selection in the output window

Prototype

long GetSelectionStartLine();

Data type meanings

Description

Returns a number in the range 1 to the number of lines in the output window, which is the first "selected" line.

If no selection, returns zero.

VBscript example

world.note world.GetSelectionStartLine

Jscript example

world.note (world.GetSelectionStartLine ());

PerlScript example

$world->note ($world->GetSelectionStartLine ());

Python example

world.note (world.GetSelectionStartLine )

Lua example

Note (GetSelectionStartLine ())

Return value

The number of the first line in the selection, or zero if no selection.

Related topic

Information

See also

FunctionDescription
GetLineInfoGets details about a specified line in the output window
GetLinesInBufferCountReturns the number of lines in the output window
GetSelectionEndColumnReturns the endling column of the selection in the output window
GetSelectionEndLineReturns the last line of the selection in the output window
GetSelectionStartColumnReturns the starting column of the selection in the output window
SetSelectionSets a selection range in the output window