Register forum user name Search FAQ

SetSelection

Script function

world.SetSelection

Read about scripting

Type

Method

Summary

Sets a selection range in the output window

Prototype

void SetSelection(long StartLine, long EndLine, long StartColumn, long EndColumn);

View list of data type meanings

Description

This sets a selection in the output window, as if you had clicked and dragged with the mouse. To clear an existing selection set the selection to be 1,1,1,1.

The selection column starts at 1. That is, column 1 is the left-most column.

The selection column range is half-open. That is, to select column 1 only you need to select 1,2 as the columns. This makes it possible to have no columns by using 1,1 as the column range.

Similarly, to select a single line, such as line 5, you can select like this:

SetSelection (5, 6, 1, 1)

That selects line 5 from column 1, up to line 6 column 1. As the end column is not included, that is therefore all of line 5.

If you have multiple output windows this function only affects the first one.


Available in MUSHclient version 5.07 onwards.



Lua example

-- Set selection starting from line 5, column 40, to line 10, column 50

SetSelection (5, 10, 40, 51)

-- (Note: Up to column 50 is selected because the column selection does not include the end column)


Return value

Nothing.


See Also ...

Topics

Scripting
Utilities

Functions

(AddFont) Adds a custom font for use by MUSHclient
(Base64Decode) Takes a base-64 encoded string and decodes it.
(Base64Encode) Encodes a string using base-64 encoding.
(BlendPixel) Blends a single pixel with another, using a specified blending mode
(ChangeDir) Changes the MUSHclient working directory
(CreateGUID) Creates a GUID - Global Unique Identifier
(EditDistance) Returns the Levenshtein Edit Distance between two words
(ErrorDesc) Converts a MUSHclient script error code into an human-readable description
(ExportXML) Exports a world item in XML format
(FilterPixel) Performs a filtering operation on one pixel
(FixupEscapeSequences) Converts "escape sequences" like \t to their equivalent codes.
(FixupHTML) Fixes up text for writing as HTML
(FlashIcon) Flashes the MUSHclient icon on the Windows taskbar
(GenerateName) Generates a random character name
(GetClipboard) Gets the clipboard contents
(GetScriptTime) Returns the amount of time spent in script routines
(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
(GetSelectionStartLine) Returns the starting line of the selection in the output window
(GetSoundStatus) Gets the status of a sound started by PlaySound
(GetUniqueID) Creates a unique ID for general use, or for making Plugin IDs
(GetUniqueNumber) Returns a unique number
(Hash) Produces a hash (checksum) of a specified piece of text
(Help) Shows help for a script function, or a list of functions
(ImportXML) Imports configuration data in XML format
(Menu) Creates a pop-up menu inside the command window
(Metaphone) Returns the metaphone code for the supplied word
(MoveMainWindow) Move and resize the main MUSHclient window
(MoveWorldWindow) Move and resize a world window
(MoveWorldWindowX) Move and resize a specific world window
(MtRand) Returns pseudo-random number using the Mersenne Twister algorithm
(MtSrand) Seed the Mersenne Twister pseudo-random number generator
(PlaySound) Plays a sound using DirectSound
(ReadNamesFile) Loads in a file for generating character names
(Replace) Replaces one substring with another
(SetBackgroundColour) Sets a background colour for the output window
(SetBackgroundImage) Sets a background image for the output window
(SetClipboard) Sets the clipboard contents
(SetForegroundImage) Sets a foreground image for the output window
(SetMainTitle) Sets the main output window title
(SetStatus) Sets the status line text
(SetTitle) Sets the world window title
(SetToolBarPosition) Sets the position of the game toolbars on the screen.
(SetUnseenLines) Sets the number of "unseen lines" for this world
(ShiftTabCompleteItem) Adds an item to the list shown for Shift+Tab completion
(Simulate) Simulate input from the MUD, for debugging purposes
(Sound) Plays a sound
(StopSound) Stop playing a sound started by PlaySound
(StripANSI) Strips ANSI colour sequences from a string
(Trace) Trace mode property
(TraceOut) Outputs the supplied message to the world Trace
(TranslateDebug) Sends a debugging message to the localizing translator script
(TranslateGerman) Translate German umluat sequences
(Transparency) Sets the transparency of the main MUSHclient window under Windows XP
(Trim) Trims leading and trailing spaces from a string

(Help topic: function=SetSelection)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.