Defines the MiniConsole Component.
MiniConsole | Defines the MiniConsole Component. |
Variables | |
master_list | Holds all MiniConsoles for consistent reference. |
Functions | |
new | |
New MiniConsole | A Mudlet text container allowing that mimicks the main console. |
Variables | |
container | The MiniConsole’s parent frame. |
wrap | Number of characters at which the MiniConsole will wrap. |
size | Font size of the text in MiniConsole. |
Functions and Properties | |
updateAbsolutes | Sets the actual size and position of the MiniConsole using the parent Frame’s Content. |
MiniConsole Properties | |
Draw | Draws the MiniConsole. |
Resize | |
Move | |
Hide | |
Show | |
Echo | Displays text on a MiniConsole. |
HEcho | Displays text on a MiniConsole with Hex color formatting. |
CEcho | Displays text on a MiniConsole with colour tags. |
DEcho | Displays text on a MiniConsole with some crazy-ass formatting. |
EchoLink | Displays a clickable line of text in a MiniConsole. |
EchoPopup | Clickable text that expands out to a menu. |
Paste | Copies text to the MiniConsole from the clipboard (via copy()). |
Append | Copies text to the MiniConsole from a buffer or the clipboard (via copy()). |
Clear | Clears all text from the MiniConsole. |
local function new ( _, name, init_x, init_y, init_width, init_height, word_wrap, font_size )
name | Used for echoing and other Mudlet referencing. |
init_x | X coordinate position. |
init_y | Y coordinate position. |
init_width | Width of the MiniConsole. |
init_height | Height of the MiniConsole. |
word_wrap | Sets the MiniConsole’s word wrap in characters. Default is dynamic or 80 if font_size is dynamic. |
font_size | Sets the MiniConsole’s font size. Default is dynamic or 8 if word_wrap is dynamic. |
A Mudlet text container allowing that mimicks the main console.
Variables | |
container | The MiniConsole’s parent frame. |
wrap | Number of characters at which the MiniConsole will wrap. |
size | Font size of the text in MiniConsole. |
Functions and Properties | |
updateAbsolutes | Sets the actual size and position of the MiniConsole using the parent Frame’s Content. |
MiniConsole Properties | |
Draw | Draws the MiniConsole. |
Resize | |
Move | |
Hide | |
Show | |
Echo | Displays text on a MiniConsole. |
HEcho | Displays text on a MiniConsole with Hex color formatting. |
CEcho | Displays text on a MiniConsole with colour tags. |
DEcho | Displays text on a MiniConsole with some crazy-ass formatting. |
EchoLink | Displays a clickable line of text in a MiniConsole. |
EchoPopup | Clickable text that expands out to a menu. |
Paste | Copies text to the MiniConsole from the clipboard (via copy()). |
Append | Copies text to the MiniConsole from a buffer or the clipboard (via copy()). |
Clear | Clears all text from the MiniConsole. |
Name | Returns the MiniConsole’s name. |
Container | Gets and sets the MiniConsole’s parent Frame. |
X | Gets and sets the MiniConsole’s relative X coordinate. |
AbsoluteX | Returns the MiniConsole’s actual X coordinate. |
Y | Gets and sets the MiniConsole’s relative Y coordinate. |
AbsoluteY | Returns the MiniConsole’s actual Y coordinate. |
Width | Gets and sets the MiniConsole’s relative width. |
AbsoluteWidth | Returns the MiniConsole’s actual width. |
Height | Gets and sets the MiniConsole’s relative height. |
AbsoluteHeight | Returns the MiniConsole’s actual height. |
WordWrap | Gets and sets the MiniConsole’s word wrap. If size is dynamic, size is set to 8. |
AbsoluteWrap | Returns the actual word wrap of the MiniConsole. |
FontSize | Gets and sets the MiniConsole’s font size. If wrap is dynamic, wrap is set to 80. |
AbsoluteSize | Returns the actual size of the MiniConsole’s text. |
function new_console:EchoLink ( text, command, hint, keep_format, insert )
Displays a clickable line of text in a MiniConsole.
text | The text to be displayed. |
command | Script to be executed when clicked. |
hint | Tooltip text. |
keep_format | If true, uses Frame text formatting. |
insert | If true, uses InsertText() instead of Echo() |
function new_console:EchoPopup ( text, commands, hints, keep_format, insert )
Clickable text that expands out to a menu.
text | The text to be displayed. |
commands | A table of scripts to be executed. |
hints | A table of tooltips. |
keep_format | If true, uses MiniConsole text formatting. |
insert | If true, uses InsertText() insead of Echo(). |
Holds all MiniConsoles for consistent reference.
local master_list
local function new ( _, name, init_x, init_y, init_width, init_height, word_wrap, font_size )
The MiniConsole’s parent frame.
local container
Number of characters at which the MiniConsole will wrap.
local wrap
Font size of the text in MiniConsole.
local size
Sets the actual size and position of the MiniConsole using the parent Frame’s Content.
local function updateAbsolutes ()
Draws the MiniConsole.
function new_console:Draw ()
function new_console:Resize ( new_width, new_height )
function new_console:Move ( new_x, new_y )
function new_console:Hide ()
function new_console:Show ()
Displays text on a MiniConsole.
function new_console:Echo ( text )
Displays text on a MiniConsole with Hex color formatting.
function new_console:HEcho ( text )
Displays text on a MiniConsole with colour tags.
function new_console:CEcho ( text )
Displays text on a MiniConsole with some crazy-ass formatting.
function new_console:DEcho ( text, fore, back, insert )
Displays a clickable line of text in a MiniConsole.
function new_console:EchoLink ( text, command, hint, keep_format, insert )
Clickable text that expands out to a menu.
function new_console:EchoPopup ( text, commands, hints, keep_format, insert )
Copies text to the MiniConsole from the clipboard (via copy()).
function new_console:Paste ()
Copies text to the MiniConsole from a buffer or the clipboard (via copy()).
function new_console:Append ()
Clears all text from the MiniConsole.
function new_console:Clear ()