Module Geyser.MiniConsole
Represents a miniconsole primitive.
See also: Mudlet Manual
Info:
- Author: guy
Functions
| Geyser.MiniConsole:appendBuffer () | Appends copied selection to this miniconsole. |
| Geyser.MiniConsole:appendCmd (text) | appends text to the commandline see: https://cnwiki.mudlet.org/w/Manual:Lua_Functions#appendCmdLine |
| Geyser.MiniConsole:bg (color) | sets the current background color of cursor in this miniconsole. |
| Geyser.MiniConsole:cechoLink (...) | inserts color name formatted clickable text into the miniconsole at the end of the current line. |
| Geyser.MiniConsole:cechoLink (...) | inserts color name formatted clickable text into the miniconsole at the end of the current line. |
| Geyser.MiniConsole:cechoPopup (...) | inserts color name formatted clickable text with right-click menu into the miniconsole at the end of the current line. |
| Geyser.MiniConsole:cinsertLink (...) | inserts color name formatted clickable text into the miniconsole at the end of the current cursor position. |
| Geyser.MiniConsole:cinsertPopup (...) | inserts color name formatted clickable text with right-click menu into the miniconsole at the end of the current cursor position. |
| Geyser.MiniConsole:clear () | Clears the miniconsole see: https://cnwiki.mudlet.org/w/Manual:Lua_Functions#clearWindow |
| Geyser.MiniConsole:clearCmd () | Clears the cmdLine see: https://cnwiki.mudlet.org/w/Manual:Lua_Functions#clearCmdLine |
| Geyser.MiniConsole:creplaceLine (with) | Replaces the entire line the cursor is on, with color like cecho |
| Geyser.MiniConsole:dechoLink (...) | inserts decimal color formatted clickable text into the miniconsole at the end of the current line. |
| Geyser.MiniConsole:dechoLink (...) | inserts decimal color formatted clickable text into the miniconsole at the end of the current line. |
| Geyser.MiniConsole:dechoPopup (...) | inserts decimal color formatted clickable text with right-click menu into the miniconsole at the end of the current line. |
| Geyser.MiniConsole:dinsertLink (...) | inserts decimal color formatted clickable text into the miniconsole at the end of the current cursor position. |
| Geyser.MiniConsole:dinsertPopup (...) | inserts decimal color formatted clickable text with right-click menu into the miniconsole at the end of the current current cursor position. |
| Geyser.MiniConsole:disableAutoWrap () | Turn off auto wrap for the miniconsole, after disabling you should immediately call setWrap with your desired wrap |
| Geyser.MiniConsole:disableCommandLine () | Disables the command-line for this window |
| Geyser.MiniConsole:disableHorizontalScrollBar () | Disables the horizontal scroll bar for this window |
| Geyser.MiniConsole:disableScrollBar () | Disables the scroll bar for this window |
| Geyser.MiniConsole:disableScrolling () | Disables scrolling for the miniconsole |
| Geyser.MiniConsole:display (...) | The same as Mudlet's base display(), but outputs to the miniconsole instead of the main window. |
| Geyser.MiniConsole:dreplaceLine (with) | Replaces the entire line the cursor is on, with color like decho |
| Geyser.MiniConsole:echoLink (...) | inserts clickable text into the miniconsole at the end of the current line. |
| Geyser.MiniConsole:echoPopup (...) | inserts clickable text with right-click menu into the miniconsole at the end of the current line. |
| Geyser.MiniConsole:enableAutoWrap () | Turn on auto wrap for the miniconsole |
| Geyser.MiniConsole:enableCommandLine () | Enables the command-line for this window |
| Geyser.MiniConsole:enableHorizontalScrollBar () | Enables the horizontal scroll bar for this window |
| Geyser.MiniConsole:enableScrollBar () | Enables the scroll bar for this window |
| Geyser.MiniConsole:enableScrolling () | Enables scrolling for the miniconsole |
| Geyser.MiniConsole:fg (color) | sets the current foreground color of cursor in this miniconsole. |
| Geyser.MiniConsole:getCmdLine () | returns the text in the commandline see: https://cnwiki.mudlet.org/w/Manual:Lua_Functions#getCmdLine |
| Geyser.MiniConsole:getColumnCount () | Returns the number of simultaneous columns (characters) that this miniconsole can show at once on a single row |
| Geyser.MiniConsole:getColumnNumber () | Returns the absolute column number the virtual cursor is on see https://cnwiki.mudlet.org/w/Manual:UI_Functions#getColumnNumber |
| Geyser.MiniConsole:getCurrentLine () | returns the content of the current line under the virtual cursor see https://cnwiki.mudlet.org/w/Manual:UI_Functions#getCurrentLine |
| Geyser.MiniConsole:getFont () | Returns the font family in use by this miniconsole. |
| Geyser.MiniConsole:getFontSize () | gets the font size for the miniconsole see https://cnwiki.mudlet.org/w/Manual:UI_Functions#getFontSize |
| Geyser.MiniConsole:getLastLineNumber () | Returns the latest line's number in the miniconsole see https://cnwiki.mudlet.org/w/Manual:UI_Functions#getLastLineNumber |
| Geyser.MiniConsole:getLineCount () | Returns the number of lines in the miniconsole see https://cnwiki.mudlet.org/w/Manual:UI_Functions#getLineCount |
| Geyser.MiniConsole:getLineNumber () | Returns the absolute line number the cursor is on in the miniconsole. |
| Geyser.MiniConsole:getLines (fromLine, toLine) | returns a section of the content of the miniconsole text buffer. |
| Geyser.MiniConsole:getRowCount () | Returns the number of simultaneous rows that this miniconsole can show at once |
| Geyser.MiniConsole:getScroll () | Returns the line the miniconsole is currently scrolled to. |
| Geyser.MiniConsole:getSelection () | Returns the text currently selected by the virtual cursor using :selectString, :selectSection, etc (not selected by the mouse) see https://cnwiki.mudlet.org/w/Manual:UI_Functions#getSelection |
| Geyser.MiniConsole:getTextFormat () | Gets the current text format of the currently selected text. |
| Geyser.MiniConsole:getWindowWrap () | Gets the number of columns the window is configured to wrap at |
| Geyser.MiniConsole:hechoLink (...) | inserts hexadecimal color formatted clickable text into the miniconsole at the end of the current line. |
| Geyser.MiniConsole:hechoLink (...) | inserts hexadecimal color formatted clickable text into the miniconsole at the end of the current line. |
| Geyser.MiniConsole:hechoPopup (...) | inserts hexadecimal color formatted clickable text with right-click menu into the miniconsole at the end of the current line. |
| Geyser.MiniConsole:hinsertLink (...) | inserts hexadecimal color formatted clickable text into the miniconsole at the end of the current cursor position. |
| Geyser.MiniConsole:hinsertPopup (...) | inserts hexadecimal color formatted clickable text with right-click menu into the miniconsole at the end of the current current cursor position. |
| Geyser.MiniConsole:hreplaceLine (with) | Replaces the entire line the cursor is on, with color like hecho |
| Geyser.MiniConsole:insertLink (...) | inserts clickable text into the miniconsole at the current cursor position. |
| Geyser.MiniConsole:insertPopup (...) | inserts clickable text with right-click menu into the miniconsole at the end of the current cursor position. |
| Geyser.MiniConsole:moveCursor (x, y) | Moves the virtual cursor within the miniconsole see https://cnwiki.mudlet.org/w/Manual:UI_Functions#moveCursor |
| Geyser.MiniConsole:moveCursorDown (lines, keepColumn) | Moves the virtual cursor down 1 or more lines see https://cnwiki.mudlet.org/w/Manual:UI_Functions#moveCursorDown |
| Geyser.MiniConsole:moveCursorEnd () | Moves the virtual cursor to the end of the miniconsole see https://cnwiki.mudlet.org/w/Manual:UI_Functions#moveCursorEnd |
| Geyser.MiniConsole:moveCursorUp (lines, keepColumn) | Moves the virtual cursor up 1 or more lines see https://cnwiki.mudlet.org/w/Manual:UI_Functions#moveCursorUp |
| Geyser.MiniConsole:new2 (cons, container) | Overridden constructor to use add2 |
| Geyser.MiniConsole:printCmd (text) | prints text to the commandline and clears text if there was one previously see: https://cnwiki.mudlet.org/w/Manual:Lua_Functions#printCmdLine(text) |
| Geyser.MiniConsole:replace (with) | Replaces the currently selected text. |
| Geyser.MiniConsole:replaceLine (with) | Replaces the entire line the cursor is on |
| Geyser.MiniConsole:reposition () | Override reposition to reset autowrap |
| Geyser.MiniConsole:resetAutoWrap () | Set the wrap based on how wide the console is |
| Geyser.MiniConsole:resetBackgroundImage () | resets the background image of this miniconsole |
| Geyser.MiniConsole:resetCmdAction () | Resets the action the command will be send to the game |
| Geyser.MiniConsole:scrollDown (lines) | Scrolls down in the window by lines number of lines |
| Geyser.MiniConsole:scrollTo (lineNum) | Scrolls to a specified line. |
| Geyser.MiniConsole:scrollUp (lines) | Scrolls up in the window by lines number of lines |
| Geyser.MiniConsole:scrollingActive () | Check if scrolling is enabled in the miniconsole |
| Geyser.MiniConsole:selectCmdLinetext () | select the text within the miniconsole's command line see https://cnwiki.mudlet.org/w/Manual:UI_Functions#selectCmdLineText |
| Geyser.MiniConsole:selectCurrentLine () | Select the current line the cursor is on in the miniconsole see https://cnwiki.mudlet.org/w/Manual:UI_Functions#selectCurrentLine |
| Geyser.MiniConsole:selectSection (fromPosition, length) | Selects the specified parts of the line starting from the left and extending to the right for however how long. |
| Geyser.MiniConsole:selectString (text, number_of_match) | Selects a substring from the line where the user cursor is currently positioned - allowing you to edit selected text (apply colour, make it be a link, copy to other windows or other things). |
| Geyser.MiniConsole:setBackgroundImage (imgPath, mode) | sets the background image of this miniconsole |
| Geyser.MiniConsole:setBold (bool) | Sets bold status for this miniconsole |
| Geyser.MiniConsole:setBufferSize (linesLimit, sizeOfBatchDeletion) | Sets the size of this miniconsole's buffer. |
| Geyser.MiniConsole:setCmdAction (func, ...) | Sets an action to be used when text is sent in this commandline. |
| Geyser.MiniConsole:setCmdLineStyleSheet (css) | Sets the style sheet of the command-line |
| Geyser.MiniConsole:setFont (font) | Sets the new font to use - use a monospaced font, non-monospaced fonts aren't supported by Mudlet and won't give the best results. |
| Geyser.MiniConsole:setFontSize (size) | Sets the font size for this miniconsole. |
| Geyser.MiniConsole:setItalics (bool) | Sets italics status for this miniconsole |
| Geyser.MiniConsole:setLink (...) | turns selected text info clickable text into the miniconsole |
| Geyser.MiniConsole:setTextFormat (r1, g1, b1, r2, g2, b2, bold, underline, italics) | Sets the text format for this window. |
| Geyser.MiniConsole:setUnderline (bool) | Sets underline status for this miniconsole |
| Geyser.MiniConsole:setWrap (wrapAt) | Sets the point at which text is wrapped in this miniconsole unless autoWrap is on |
Fields
| Geyser.MiniConsole | Represents a miniconsole primitive. |
Functions
- Geyser.MiniConsole:appendBuffer ()
- Appends copied selection to this miniconsole.
- Geyser.MiniConsole:appendCmd (text)
-
appends text to the commandline
see: https://cnwiki.mudlet.org/w/Manual:Lua_Functions#appendCmdLine
Parameters:
- text
- Geyser.MiniConsole:bg (color)
-
sets the current background color of cursor in this miniconsole.
Parameters:
- color
- Geyser.MiniConsole:cechoLink (...)
-
inserts color name formatted clickable text into the miniconsole at the end of the current line.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#cechoLink
Parameters:
- ...
- Geyser.MiniConsole:cechoLink (...)
-
inserts color name formatted clickable text into the miniconsole at the end of the current line.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#cechoLink
Parameters:
- ...
- Geyser.MiniConsole:cechoPopup (...)
-
inserts color name formatted clickable text with right-click menu into the miniconsole at the end of the current line.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#cechoPopup
Parameters:
- ...
- Geyser.MiniConsole:cinsertLink (...)
-
inserts color name formatted clickable text into the miniconsole at the end of the current cursor position.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#cinsertLink
Parameters:
- ...
- Geyser.MiniConsole:cinsertPopup (...)
-
inserts color name formatted clickable text with right-click menu into the miniconsole at the end of the current cursor position.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#cinsertPopup
Parameters:
- ...
- Geyser.MiniConsole:clear ()
- Clears the miniconsole see: https://cnwiki.mudlet.org/w/Manual:Lua_Functions#clearWindow
- Geyser.MiniConsole:clearCmd ()
- Clears the cmdLine see: https://cnwiki.mudlet.org/w/Manual:Lua_Functions#clearCmdLine
- Geyser.MiniConsole:creplaceLine (with)
-
Replaces the entire line the cursor is on, with color like cecho
Parameters:
- with The text to use as a replacement
- Geyser.MiniConsole:dechoLink (...)
-
inserts decimal color formatted clickable text into the miniconsole at the end of the current line.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#dechoLink
Parameters:
- ...
- Geyser.MiniConsole:dechoLink (...)
-
inserts decimal color formatted clickable text into the miniconsole at the end of the current line.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#dechoLink
Parameters:
- ...
- Geyser.MiniConsole:dechoPopup (...)
-
inserts decimal color formatted clickable text with right-click menu into the miniconsole at the end of the current line.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#dechoPopup
Parameters:
- ...
- Geyser.MiniConsole:dinsertLink (...)
-
inserts decimal color formatted clickable text into the miniconsole at the end of the current cursor position.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#dinsertLink
Parameters:
- ...
- Geyser.MiniConsole:dinsertPopup (...)
-
inserts decimal color formatted clickable text with right-click menu into the miniconsole at the end of the current current cursor position.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#dinsertPopup
Parameters:
- ...
- Geyser.MiniConsole:disableAutoWrap ()
- Turn off auto wrap for the miniconsole, after disabling you should immediately call setWrap with your desired wrap
- Geyser.MiniConsole:disableCommandLine ()
- Disables the command-line for this window
- Geyser.MiniConsole:disableHorizontalScrollBar ()
- Disables the horizontal scroll bar for this window
- Geyser.MiniConsole:disableScrollBar ()
- Disables the scroll bar for this window
- Geyser.MiniConsole:disableScrolling ()
- Disables scrolling for the miniconsole
- Geyser.MiniConsole:display (...)
-
The same as Mudlet's base display(), but outputs to the miniconsole instead of the main window.
Parameters:
- ...
- Geyser.MiniConsole:dreplaceLine (with)
-
Replaces the entire line the cursor is on, with color like decho
Parameters:
- with The text to use as a replacement
- Geyser.MiniConsole:echoLink (...)
-
inserts clickable text into the miniconsole at the end of the current line.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#echoLink
Parameters:
- ...
- Geyser.MiniConsole:echoPopup (...)
-
inserts clickable text with right-click menu into the miniconsole at the end of the current line.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#echoPopup
Parameters:
- ...
- Geyser.MiniConsole:enableAutoWrap ()
- Turn on auto wrap for the miniconsole
- Geyser.MiniConsole:enableCommandLine ()
- Enables the command-line for this window
- Geyser.MiniConsole:enableHorizontalScrollBar ()
- Enables the horizontal scroll bar for this window
- Geyser.MiniConsole:enableScrollBar ()
- Enables the scroll bar for this window
- Geyser.MiniConsole:enableScrolling ()
- Enables scrolling for the miniconsole
- Geyser.MiniConsole:fg (color)
-
sets the current foreground color of cursor in this miniconsole.
Parameters:
- color
- Geyser.MiniConsole:getCmdLine ()
- returns the text in the commandline see: https://cnwiki.mudlet.org/w/Manual:Lua_Functions#getCmdLine
- Geyser.MiniConsole:getColumnCount ()
- Returns the number of simultaneous columns (characters) that this miniconsole can show at once on a single row
- Geyser.MiniConsole:getColumnNumber ()
- Returns the absolute column number the virtual cursor is on see https://cnwiki.mudlet.org/w/Manual:UI_Functions#getColumnNumber
- Geyser.MiniConsole:getCurrentLine ()
- returns the content of the current line under the virtual cursor see https://cnwiki.mudlet.org/w/Manual:UI_Functions#getCurrentLine
- Geyser.MiniConsole:getFont ()
- Returns the font family in use by this miniconsole.
- Geyser.MiniConsole:getFontSize ()
- gets the font size for the miniconsole see https://cnwiki.mudlet.org/w/Manual:UI_Functions#getFontSize
- Geyser.MiniConsole:getLastLineNumber ()
- Returns the latest line's number in the miniconsole see https://cnwiki.mudlet.org/w/Manual:UI_Functions#getLastLineNumber
- Geyser.MiniConsole:getLineCount ()
- Returns the number of lines in the miniconsole see https://cnwiki.mudlet.org/w/Manual:UI_Functions#getLineCount
- Geyser.MiniConsole:getLineNumber ()
- Returns the absolute line number the cursor is on in the miniconsole. see https://cnwiki.mudlet.org/w/Manual:UI_Functions#getLineNumber
- Geyser.MiniConsole:getLines (fromLine, toLine)
-
returns a section of the content of the miniconsole text buffer. Returns a Lua table with the content of the lines on a per line basis. The form value is result = {relative_linenumber = line}.
see https://cnwiki.mudlet.org/w/Manual:UI_Functions#getLines
Parameters:
- fromLine the absolute line number to start getting lines at
- toLine the absolute line number to stop getting lines at
- Geyser.MiniConsole:getRowCount ()
- Returns the number of simultaneous rows that this miniconsole can show at once
- Geyser.MiniConsole:getScroll ()
- Returns the line the miniconsole is currently scrolled to.
- Geyser.MiniConsole:getSelection ()
- Returns the text currently selected by the virtual cursor using :selectString, :selectSection, etc (not selected by the mouse) see https://cnwiki.mudlet.org/w/Manual:UI_Functions#getSelection
- Geyser.MiniConsole:getTextFormat ()
- Gets the current text format of the currently selected text. see https://cnwiki.mudlet.org/w/Manual:UI_Functions#getTextFormat
- Geyser.MiniConsole:getWindowWrap ()
- Gets the number of columns the window is configured to wrap at
- Geyser.MiniConsole:hechoLink (...)
-
inserts hexadecimal color formatted clickable text into the miniconsole at the end of the current line.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#hechoLink
Parameters:
- ...
- Geyser.MiniConsole:hechoLink (...)
-
inserts hexadecimal color formatted clickable text into the miniconsole at the end of the current line.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#hechoLink
Parameters:
- ...
- Geyser.MiniConsole:hechoPopup (...)
-
inserts hexadecimal color formatted clickable text with right-click menu into the miniconsole at the end of the current line.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#hechoPopup
Parameters:
- ...
- Geyser.MiniConsole:hinsertLink (...)
-
inserts hexadecimal color formatted clickable text into the miniconsole at the end of the current cursor position.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#hinsertLink
Parameters:
- ...
- Geyser.MiniConsole:hinsertPopup (...)
-
inserts hexadecimal color formatted clickable text with right-click menu into the miniconsole at the end of the current current cursor position.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#hinsertPopup
Parameters:
- ...
- Geyser.MiniConsole:hreplaceLine (with)
-
Replaces the entire line the cursor is on, with color like hecho
Parameters:
- with The text to use as a replacement
- Geyser.MiniConsole:insertLink (...)
-
inserts clickable text into the miniconsole at the current cursor position.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#insertLink
Parameters:
- ...
- Geyser.MiniConsole:insertPopup (...)
-
inserts clickable text with right-click menu into the miniconsole at the end of the current cursor position.
see: https://cnwiki.mudlet.org/w/Manual:UI_Functions#insertPopup
Parameters:
- ...
- Geyser.MiniConsole:moveCursor (x, y)
-
Moves the virtual cursor within the miniconsole
see https://cnwiki.mudlet.org/w/Manual:UI_Functions#moveCursor
Parameters:
- x the horizontal position for the cursor
- y the vertical position (line) for the cursor
- Geyser.MiniConsole:moveCursorDown (lines, keepColumn)
-
Moves the virtual cursor down 1 or more lines
see https://cnwiki.mudlet.org/w/Manual:UI_Functions#moveCursorDown
Parameters:
- lines the number of lines down to move the cursor. Defaults to 1 if not provided
- keepColumn if true, will maintain the x/horizontal/columnar position of the cursor as well. Otherwise moves the cursor to the front of the line
- Geyser.MiniConsole:moveCursorEnd ()
- Moves the virtual cursor to the end of the miniconsole see https://cnwiki.mudlet.org/w/Manual:UI_Functions#moveCursorEnd
- Geyser.MiniConsole:moveCursorUp (lines, keepColumn)
-
Moves the virtual cursor up 1 or more lines
see https://cnwiki.mudlet.org/w/Manual:UI_Functions#moveCursorUp
Parameters:
- lines the number of lines up to move the cursor. Defaults to 1 if not provided
- keepColumn if true, will maintain the x/horizontal/columnar position of the cursor as well. Otherwise moves the cursor to the front of the line
- Geyser.MiniConsole:new2 (cons, container)
-
Overridden constructor to use add2
Parameters:
- cons
- container
- Geyser.MiniConsole:printCmd (text)
-
prints text to the commandline and clears text if there was one previously
see: https://cnwiki.mudlet.org/w/Manual:Lua_Functions#printCmdLine(text)
Parameters:
- text
- Geyser.MiniConsole:replace (with)
-
Replaces the currently selected text.
Parameters:
- with The text to use as a replacement.
- Geyser.MiniConsole:replaceLine (with)
-
Replaces the entire line the cursor is on
Parameters:
- with The text to use as a replacement
- Geyser.MiniConsole:reposition ()
- Override reposition to reset autowrap
- Geyser.MiniConsole:resetAutoWrap ()
- Set the wrap based on how wide the console is
- Geyser.MiniConsole:resetBackgroundImage ()
- resets the background image of this miniconsole
- Geyser.MiniConsole:resetCmdAction ()
- Resets the action the command will be send to the game
- Geyser.MiniConsole:scrollDown (lines)
-
Scrolls down in the window by lines number of lines
Parameters:
- lines number the number of lines to scroll down by
- Geyser.MiniConsole:scrollTo (lineNum)
-
Scrolls to a specified line. If ommitted will scroll to the end (ends scrolling)
Parameters:
- lineNum number the line number to scroll to. Will scroll to the end of the window if ommitted.
- Geyser.MiniConsole:scrollUp (lines)
-
Scrolls up in the window by lines number of lines
Parameters:
- lines number the number of lines to scroll up by
- Geyser.MiniConsole:scrollingActive ()
- Check if scrolling is enabled in the miniconsole
- Geyser.MiniConsole:selectCmdLinetext ()
- select the text within the miniconsole's command line see https://cnwiki.mudlet.org/w/Manual:UI_Functions#selectCmdLineText
- Geyser.MiniConsole:selectCurrentLine ()
- Select the current line the cursor is on in the miniconsole see https://cnwiki.mudlet.org/w/Manual:UI_Functions#selectCurrentLine
- Geyser.MiniConsole:selectSection (fromPosition, length)
-
Selects the specified parts of the line starting from the left and extending to the right for however how long. The line starts from 0.
see https://cnwiki.mudlet.org/w/Manual:UI_Functions#selectSection
Parameters:
- fromPosition the column to start selecting from
- length the number of columns to select
- Geyser.MiniConsole:selectString (text, number_of_match)
-
Selects a substring from the line where the user cursor is currently positioned - allowing you to edit selected text (apply colour, make it be a link, copy to other windows or other things).
see https://cnwiki.mudlet.org/w/Manual:UI_Functions#selectString
Parameters:
- text
- number_of_match
- Geyser.MiniConsole:setBackgroundImage (imgPath, mode)
-
sets the background image of this miniconsole
Parameters:
- imgPath image path or stylesheet option (if mode is set to "style") as string
- mode background image mode (1 "border", 2 "center", 3 "tile", 4 "style")
- Geyser.MiniConsole:setBold (bool)
-
Sets bold status for this miniconsole
Parameters:
- bool True for bolded
- Geyser.MiniConsole:setBufferSize (linesLimit, sizeOfBatchDeletion)
-
Sets the size of this miniconsole's buffer.
Parameters:
- linesLimit The number of lines to store - same limitations as Mudlet function of the same name.
- sizeOfBatchDeletion See Mudlet documentation. (I don't know offhand =)
- Geyser.MiniConsole:setCmdAction (func, ...)
-
Sets an action to be used when text is sent in this commandline. When this
function is called by the event system, text the commandline sends will be
appended as the final argument.
Parameters:
- func The function to use.
- ... Parameters to pass to the function.
- Geyser.MiniConsole:setCmdLineStyleSheet (css)
-
Sets the style sheet of the command-line
Parameters:
- css The style sheet string
- Geyser.MiniConsole:setFont (font)
-
Sets the new font to use - use a monospaced font, non-monospaced fonts aren't supported by Mudlet
and won't give the best results.
Parameters:
- font Font family name to use (see https://doc.qt.io/qt-5/qfont.html#setFamily for details)
- Geyser.MiniConsole:setFontSize (size)
-
Sets the font size for this miniconsole.
Parameters:
- size The font size.
- Geyser.MiniConsole:setItalics (bool)
-
Sets italics status for this miniconsole
Parameters:
- bool True for italicized
- Geyser.MiniConsole:setLink (...)
-
turns selected text info clickable text into the miniconsole
Parameters:
- ...
- Geyser.MiniConsole:setTextFormat (r1, g1, b1, r2, g2, b2, bold, underline, italics)
-
Sets the text format for this window. Note that the *echo()
functions will override these settings.
Parameters:
- r1 The red foreground component.
- g1 The green foreground component.
- b1 The blue foreground component.
- r2 The red background component.
- g2 The green background component.
- b2 The blue background component.
- bold The bolded status. 1 is bold, 0 is normal.
- underline The underlined status. 1 is underlined, 0 is normal.
- italics The italicized status. 1 is italicized, 0 is normal.
- Geyser.MiniConsole:setUnderline (bool)
-
Sets underline status for this miniconsole
Parameters:
- bool True for underlined
- Geyser.MiniConsole:setWrap (wrapAt)
-
Sets the point at which text is wrapped in this miniconsole unless autoWrap is on
Parameters:
- wrapAt The number of characters to start wrapping.