Module GeyserMiniConsole

-- The Geyser Layout Manager by guy -- --

Functions

Geyser.MiniConsole:reposition () Override reposition to reset autowrap
Geyser.MiniConsole:replace (with) Replaces the currently selected text.
Geyser.MiniConsole:setBufferSize (linesLimit, sizeOfBatchDeletion) Sets the size of this miniconsole's buffer.
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:getFont () Returns the font family in use by this miniconsole.
Geyser.MiniConsole:setWrap (wrapAt) Sets the point at which text is wrapped in this miniconsole unless autoWrap is on
Geyser.MiniConsole:setTextFormat (r1, g1, b1, r2, g2, b2, bold, underline, italics) Sets the text format for this window.
Geyser.MiniConsole:enableCommandLine () Enables the command-line for this window
Geyser.MiniConsole:disableCommandLine () Disables the command-line for this window
Geyser.MiniConsole:setCmdAction (func, ...) Sets an action to be used when text is send in this commandline.
Geyser.MiniConsole:resetCmdAction () Resets the action the command will be send to the game
Geyser.MiniConsole:clearCmd () Clears the cmdLine see: https://wiki.mudlet.org/w/Manual:Lua_Functions#clearCmdLine
Geyser.MiniConsole:printCmd (text) prints text to the commandline and clears text if there was one previously see: https://wiki.mudlet.org/w/Manual:Lua_Functions#printCmdLine(text)
Geyser.MiniConsole:appendCmd (text) appends text to the commandline see: https://wiki.mudlet.org/w/Manual:Lua_Functions#appendCmdLine
Geyser.MiniConsole:getCmdLine () returns the text in the commandline see: https://wiki.mudlet.org/w/Manual:Lua_Functions#getCmdLine
Geyser.MiniConsole:setCmdLineStyleSheet (css) Sets the style sheet of the command-line
Geyser.MiniConsole:setBold (bool) Sets bold status for this miniconsole
Geyser.MiniConsole:setUnderline (bool) Sets underline status for this miniconsole
Geyser.MiniConsole:setItalics (bool) Sets italics status for this miniconsole
Geyser.MiniConsole:setFontSize (size) Sets the font size for this miniconsole.
Geyser.MiniConsole:appendBuffer () Appends copied selection to this miniconsole.
Geyser.MiniConsole:clear () Clears the miniconsole see: https://wiki.mudlet.org/w/Manual:Lua_Functions#clearWindow
Geyser.MiniConsole:fg (color) sets the current foreground color of cursor in this miniconsole.
Geyser.MiniConsole:bg (color) sets the current background color of cursor in this miniconsole.
Geyser.MiniConsole:setBackgroundImage (imgPath, mode) sets the background image of this miniconsole
Geyser.MiniConsole:resetBackgroundImage () resets the background image of this miniconsole
Geyser.MiniConsole:echoLink (...) inserts clickable text into the miniconsole at the end of the current line.
Geyser.MiniConsole:insertLink (...) inserts clickable text into the miniconsole at the current cursor position.
Geyser.MiniConsole:echoPopup (...) inserts clickable text with right-click menu into the miniconsole at the end of the current line.
Geyser.MiniConsole:insertPopup (...) inserts clickable text with right-click menu into the miniconsole at the end of the current cursor position.
Geyser.MiniConsole:cechoLink (...) inserts color name 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:hechoLink (...) inserts hexidecimal color formatted clickable text 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:dinsertLink (...) inserts decimal color formatted clickable text into the miniconsole at the end of the current cursor position.
Geyser.MiniConsole:hinsertLink (...) inserts hexidecimal color formatted clickable text into the miniconsole at the end of the current cursor position.
Geyser.MiniConsole:cechoLink (...) inserts color name 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:hechoLink (...) inserts hexidecimal color 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:dechoPopup (...) inserts decimal color formatted clickable text with right-click menu into the miniconsole at the end of the current line.
Geyser.MiniConsole:hechoPopup (...) inserts hexidecimal color formatted clickable text with right-click menu into the miniconsole at the end of the current line.
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: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:hinsertPopup (...) inserts hexidecimal color formatted clickable text with right-click menu into the miniconsole at the end of the current current cursor position.
Geyser.MiniConsole:setLink (...) turns selected text info clickable text into the miniconsole
Geyser.MiniConsole:getRowCount () Returns the number of simultaneous rows that this miniconsole can show at once
Geyser.MiniConsole:getColumnCount () Returns the number of simultaneous columns (characters) that this miniconsole can show at once on a single row
Geyser.MiniConsole:enableAutoWrap () Turn on auto wrap for the miniconsole
Geyser.MiniConsole:disableAutoWrap () Turn off auto wrap for the miniconsole, after disabling you should immediately call setWrap with your desired wrap
Geyser.MiniConsole:resetAutoWrap () Set the wrap based on how wide the console is
Geyser.MiniConsole:display (...) The same as Mudlet's base display(), but outputs to the miniconsole instead of the main window.
Geyser.MiniConsole:new2 (cons, container) Overridden constructor to use add2

Tables

Geyser.MiniConsole Represents a miniconsole primitive


Functions

Geyser.MiniConsole:reposition ()
Override reposition to reset autowrap
Geyser.MiniConsole:replace (with)
Replaces the currently selected text.

Parameters:

  • with The text to use as a replacement.
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: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:getFont ()
Returns the font family in use by this miniconsole.
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.
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:enableCommandLine ()
Enables the command-line for this window
Geyser.MiniConsole:disableCommandLine ()
Disables the command-line for this window
Geyser.MiniConsole:setCmdAction (func, ...)
Sets an action to be used when text is send in this commandline. When this function is called by the event system, text the commandline sends will be appended as the final argument (see ???) and also in Geyser.Label the setClickCallback events

Parameters:

  • func The function to use.
  • ... Parameters to pass to the function.
Geyser.MiniConsole:resetCmdAction ()
Resets the action the command will be send to the game
Geyser.MiniConsole:clearCmd ()
Clears the cmdLine see: https://wiki.mudlet.org/w/Manual:Lua_Functions#clearCmdLine
Geyser.MiniConsole:printCmd (text)
prints text to the commandline and clears text if there was one previously see: https://wiki.mudlet.org/w/Manual:Lua_Functions#printCmdLine(text)

Parameters:

  • text
Geyser.MiniConsole:appendCmd (text)
appends text to the commandline see: https://wiki.mudlet.org/w/Manual:Lua_Functions#appendCmdLine

Parameters:

  • text
Geyser.MiniConsole:getCmdLine ()
returns the text in the commandline see: https://wiki.mudlet.org/w/Manual:Lua_Functions#getCmdLine
Geyser.MiniConsole:setCmdLineStyleSheet (css)
Sets the style sheet of the command-line

Parameters:

  • css The style sheet string
Geyser.MiniConsole:setBold (bool)
Sets bold status for this miniconsole

Parameters:

  • bool True for bolded
Geyser.MiniConsole:setUnderline (bool)
Sets underline status for this miniconsole

Parameters:

  • bool True for underlined
Geyser.MiniConsole:setItalics (bool)
Sets italics status for this miniconsole

Parameters:

  • bool True for italicized
Geyser.MiniConsole:setFontSize (size)
Sets the font size for this miniconsole.

Parameters:

  • size The font size.
Geyser.MiniConsole:appendBuffer ()
Appends copied selection to this miniconsole.
Geyser.MiniConsole:clear ()
Clears the miniconsole see: https://wiki.mudlet.org/w/Manual:Lua_Functions#clearWindow
Geyser.MiniConsole:fg (color)
sets the current foreground color of cursor in this miniconsole.

Parameters:

  • color
Geyser.MiniConsole:bg (color)
sets the current background color of cursor in this miniconsole.

Parameters:

  • color
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:resetBackgroundImage ()
resets the background image of this miniconsole
Geyser.MiniConsole:echoLink (...)
inserts clickable text into the miniconsole at the end of the current line. see: https://wiki.mudlet.org/w/Manual:UI_Functions#echoLink

Parameters:

  • ...
Geyser.MiniConsole:insertLink (...)
inserts clickable text into the miniconsole at the current cursor position. see: https://wiki.mudlet.org/w/Manual:UI_Functions#insertLink

Parameters:

  • ...
Geyser.MiniConsole:echoPopup (...)
inserts clickable text with right-click menu into the miniconsole at the end of the current line. see: https://wiki.mudlet.org/w/Manual:UI_Functions#echoPopup

Parameters:

  • ...
Geyser.MiniConsole:insertPopup (...)
inserts clickable text with right-click menu into the miniconsole at the end of the current cursor position. see: https://wiki.mudlet.org/w/Manual:UI_Functions#insertPopup

Parameters:

  • ...
Geyser.MiniConsole:cechoLink (...)
inserts color name formatted clickable text into the miniconsole at the end of the current line. see: https://wiki.mudlet.org/w/Manual:UI_Functions#cechoLink

Parameters:

  • ...
Geyser.MiniConsole:dechoLink (...)
inserts decimal color formatted clickable text into the miniconsole at the end of the current line. see: https://wiki.mudlet.org/w/Manual:UI_Functions#dechoLink

Parameters:

  • ...
Geyser.MiniConsole:hechoLink (...)
inserts hexidecimal color formatted clickable text into the miniconsole at the end of the current line. see: https://wiki.mudlet.org/w/Manual:UI_Functions#hechoLink

Parameters:

  • ...
Geyser.MiniConsole:cinsertLink (...)
inserts color name formatted clickable text into the miniconsole at the end of the current cursor position. see: https://wiki.mudlet.org/w/Manual:UI_Functions#cinsertLink

Parameters:

  • ...
Geyser.MiniConsole:dinsertLink (...)
inserts decimal color formatted clickable text into the miniconsole at the end of the current cursor position. see: https://wiki.mudlet.org/w/Manual:UI_Functions#dinsertLink

Parameters:

  • ...
Geyser.MiniConsole:hinsertLink (...)
inserts hexidecimal color formatted clickable text into the miniconsole at the end of the current cursor position. see: https://wiki.mudlet.org/w/Manual:UI_Functions#hinsertLink

Parameters:

  • ...
Geyser.MiniConsole:cechoLink (...)
inserts color name formatted clickable text into the miniconsole at the end of the current line. see: https://wiki.mudlet.org/w/Manual:UI_Functions#cechoLink

Parameters:

  • ...
Geyser.MiniConsole:dechoLink (...)
inserts decimal color formatted clickable text into the miniconsole at the end of the current line. see: https://wiki.mudlet.org/w/Manual:UI_Functions#dechoLink

Parameters:

  • ...
Geyser.MiniConsole:hechoLink (...)
inserts hexidecimal color formatted clickable text into the miniconsole at the end of the current line. see: https://wiki.mudlet.org/w/Manual:UI_Functions#hechoLink

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://wiki.mudlet.org/w/Manual:UI_Functions#cechoPopup

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://wiki.mudlet.org/w/Manual:UI_Functions#dechoPopup

Parameters:

  • ...
Geyser.MiniConsole:hechoPopup (...)
inserts hexidecimal color formatted clickable text with right-click menu into the miniconsole at the end of the current line. see: https://wiki.mudlet.org/w/Manual:UI_Functions#hechoPopup

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://wiki.mudlet.org/w/Manual:UI_Functions#cinsertPopup

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://wiki.mudlet.org/w/Manual:UI_Functions#dinsertPopup

Parameters:

  • ...
Geyser.MiniConsole:hinsertPopup (...)
inserts hexidecimal color formatted clickable text with right-click menu into the miniconsole at the end of the current current cursor position. see: https://wiki.mudlet.org/w/Manual:UI_Functions#hinsertPopup

Parameters:

  • ...
Geyser.MiniConsole:setLink (...)
turns selected text info clickable text into the miniconsole

Parameters:

  • ...
Geyser.MiniConsole:getRowCount ()
Returns the number of simultaneous rows that this miniconsole can show at once
Geyser.MiniConsole:getColumnCount ()
Returns the number of simultaneous columns (characters) that this miniconsole can show at once on a single row
Geyser.MiniConsole:enableAutoWrap ()
Turn on auto wrap for the miniconsole
Geyser.MiniConsole:disableAutoWrap ()
Turn off auto wrap for the miniconsole, after disabling you should immediately call setWrap with your desired wrap
Geyser.MiniConsole:resetAutoWrap ()
Set the wrap based on how wide the console is
Geyser.MiniConsole:display (...)
The same as Mudlet's base display(), but outputs to the miniconsole instead of the main window.

Parameters:

  • ...
Geyser.MiniConsole:new2 (cons, container)
Overridden constructor to use add2

Parameters:

  • cons
  • container

Tables

Geyser.MiniConsole
Represents a miniconsole primitive

Fields:

  • wrapAt Where line wrapping occurs. Default is 300 characters.
generated by LDoc 1.4.6 Last updated 2021-01-15 01:07:24