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

MUSHclient scripting

Description of MUSHclient world function: world.GetSelectionStartLine


Name GetSelectionStartLine
Type Method
Summary Returns the starting line of the selection in the output window
Prototype long GetSelectionStartLine();

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


Note: Available in version 3.18 onwards.


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 ())
Returns The number of the first line in the selection, or zero if no selection.
Introduced in version 3.18

See also ...

Function Description
GetLineInfo Gets details about a specified line in the output window
GetLinesInBufferCount Returns the number of lines in the output window
GetSelectionEndColumn Returns the endling column of the selection in the output window
GetSelectionEndLine Returns the last line of the selection in the output window
GetSelectionStartColumn Returns the starting column of the selection 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]