Difference between revisions of "User:Missionz3r0"

From Mudlet
Jump to navigation Jump to search
m
(Add borders lines for params and returns)
Line 15: Line 15:
 
<div class="messagebox mw-collapsible" style="overflow:auto; max-width:100ch;">
 
<div class="messagebox mw-collapsible" style="overflow:auto; max-width:100ch;">
 
   <div role="heading">'''History'''</div>
 
   <div role="heading">'''History'''</div>
   <div class="mw-collapsible-content" style="box-sizing: border-box; display:grid; gap: 0px; grid-template-columns: 8ch auto; padding-left: 1.6em">
+
   <div class="mw-collapsible-content" style="box-sizing: border-box; display:grid; grid-gap:1px; grid-template-columns: 8ch auto; padding-left: 1.6em">
 
     <div role="heading">v4.8.0</div>
 
     <div role="heading">v4.8.0</div>
 
     <div>As of Mudlet 4.8+, a single line is capped to 10,000 characters (this is when ~200 at most will fit on one line on your screen).</div>
 
     <div>As of Mudlet 4.8+, a single line is capped to 10,000 characters (this is when ~200 at most will fit on one line on your screen).</div>
Line 27: Line 27:
  
 
<div role="heading" style="margin-top:1em;">'''Parameters'''</div>
 
<div role="heading" style="margin-top:1em;">'''Parameters'''</div>
<dl style="box-sizing: border-box; display:grid; gap: 0px; grid-template-columns: 30ch 8ch auto; padding-left: 1.6em; max-width:100ch;">
+
<dl style="box-sizing:border-box; display:grid; grid-gap:0px; grid-template-columns:30ch 9ch auto; max-width:100ch;">
     <dt style="font-weight: normal;"><code>console_or_label_name?</code></dt>
+
     <dt style="border-right: 1px solid; margin:0 0 8px 0; font-weight:normal; padding:0 0.8ch 1px 1.6em;"><code>console_or_label_name?</code></dt>
     <dd>''string''</dd>
+
     <dd style="border-right: 1px solid; margin:0 0 8px 0; padding:0 0.8ch 1px 0.8ch;">''string''</dd>
     <dd>The mini-console or label to echo to.  '''Default''': <code>"main"</code></dd>
+
     <dd style="margin:0 0 8px 0; padding:0 0.8ch 1px 0.8ch;">The mini-console or label to echo to.  '''Default''': <code>"main"</code></dd>
  
     <dt style="font-weight: normal;"><code>text?</code></dt>
+
     <dt style="border-right: 1px solid; margin:0; font-weight:normal; padding:0 0.8ch 1px 1.6em;"><code>text?</code></dt>
     <dd>''string''</dd>
+
     <dd style="border-right: 1px solid; margin:0 ; padding:0 0.8ch 1px 0.8ch;">''string''</dd>
     <dd>Text you'd like to see printed. You can use \n in an echo to insert a new line. If you're echoing this to a label, you can also use styling to color, center, increase/decrease size of text and various other formatting options [http://doc.qt.io/qt-5/richtext-html-subset.html as listed here].</dd>
+
     <dd style="margin:0; padding:0 0.8ch 1px 0.8ch;">Text you'd like to see printed. You can use \n in an echo to insert a new line. If you're echoing this to a label, you can also use styling to color, center, increase/decrease size of text and various other formatting options [http://doc.qt.io/qt-5/richtext-html-subset.html as listed here].</dd>
 
</dl>
 
</dl>
  
 
<div role="heading">'''Returns'''</div>
 
<div role="heading">'''Returns'''</div>
<dl style="box-sizing: border-box; display:grid; gap: 0px; grid-template-columns: 30ch 8ch auto; padding-left: 1.6em; max-width:100ch;">
+
<dl style="box-sizing:border-box; display:grid; grid-gap:0px; grid-template-columns:30ch 9ch auto; max-width:100ch;">
     <dt style="font-weight: normal;"><code>ok?</code></dt>
+
     <dt style="border-right: 1px solid; margin:0 0 8px 0; font-weight:normal; padding:0 0.8ch 1px 1.6em;"><code>ok?</code></dt>
     <dd>''boolean''</dd>
+
     <dd style="border-right: 1px solid; margin:0 0 8px 0; padding:0 0.8ch 1px 0.8ch;">''boolean''</dd>
     <dd>If nil, echo has errored</dd>
+
     <dd style="margin:0 0 8px 0; padding:0 0.8ch 1px 0.8ch;">If nil, echo has errored</dd>
  
     <dt style="font-weight: normal;"><code>err?</code></dt>
+
     <dt style="border-right: 1px solid; margin:0; font-weight:normal; padding:0 0.8em 1px 1.6em;"><code>err?</code></dt>
     <dd>''string''</dd>
+
     <dd style="border-right: 1px solid; margin:0 ; padding:0 0.8ch 1px 0.8ch;">''string''</dd>
     <dd>Error Message</dd>
+
     <dd style="margin:0; padding-left:.8ch;">Error Message</dd>
 
</dl>
 
</dl>
  

Revision as of 18:45, 17 February 2026

Current Projects/Issues

  • #1149 Public functions missing documentation in wiki
    • #1640 Wiki templates for easy versions
  • #7851 Bulkify db:add
  • #8864 Handle db:_migrate's assertions and transactions better

Basic Essentials

echo

This function appends text at the end of the current line.

See also: moveCursor(), insertText(), cecho(), decho(), hecho()

History
v4.8.0
As of Mudlet 4.8+, a single line is capped to 10,000 characters (this is when ~200 at most will fit on one line on your screen).
v1.0.0
Added in: v.1.0.0
Usage

ok, err = echo([console_or_label_name,] text)

Parameters
console_or_label_name?
string
The mini-console or label to echo to. Default: "main"
text?
string
Text you'd like to see printed. You can use \n in an echo to insert a new line. If you're echoing this to a label, you can also use styling to color, center, increase/decrease size of text and various other formatting options as listed here.
Returns
ok?
boolean
If nil, echo has errored
err?
string
Error Message
Example: label
-- This example creates a transparent overlay message box to show a big warning message "You are under attack!" in the middle 
-- of the screen. Because the background color has a transparency level of 150 (0-255, with 0 being completely transparent 
-- and 255 opaque) the background text can still be read through.
local width, height = getMainWindowSize()
createLabel("messageBox",(width/2)-300,(height/2)-100,250,150,1)
resizeWindow("messageBox",500,70)
moveWindow("messageBox", (width/2)-300,(height/2)-100 )
setBackgroundColor("messageBox", 255, 204, 0, 200)
echo("messageBox", [[<p style="font-size:35px"><b><center><font color="red">You are under attack!</font></center></b></p>]])
Example: miniconsole
-- first, determine the size of your screen
local windowWidth, windowHeight = getMainWindowSize()

-- create the miniconsole
createMiniConsole("sys", windowWidth-650,0,650,300)
setBackgroundColor("sys",255,69,0,255)
setMiniConsoleFontSize("sys", 8)
-- wrap lines in window "sys" at 40 characters per line - somewhere halfway, as an example
setWindowWrap("sys", 40)

echo("sys","Hello world!\n")
cecho("sys", "<:OrangeRed>This is random spam with the same background\n")
cecho("sys", "<blue:OrangeRed>and this is with a blue foreground. ")
cecho("sys", "<bisque:BlueViolet>Lastly, this is with both a foreground and a background.\n")