Manual:Basic Essentials - Revision history

Zooka: /* send */

2024-04-28T11:32:07Z

send

Zooka: /* printError */

2024-04-28T11:30:46Z

printError

Zooka: /* printDebug */

2024-04-28T11:29:50Z

printDebug

Zooka: /* echo */

2024-04-28T11:25:59Z

echo

Kebap: colour -> color

2023-02-05T19:16:01Z

colour -> color

Kebap: /* send */ link to main documentation instead

2021-12-12T19:46:08Z

send: link to main documentation instead

Kebap: + printDebug, printError

2021-11-21T19:35:26Z

+ printDebug, printError

Kebap: /* Basic Essentials */ alphabetical order

2021-11-21T19:28:16Z

Basic Essentials: alphabetical order

Vadi: /* send */

2021-11-08T10:42:51Z

send

Vadi: /* send */ reword the technical note on a super basic alias that requires a large amount of TELNET protocol context to understand

2021-11-08T10:42:38Z

send: reword the technical note on a super basic alias that requires a large amount of TELNET protocol context to understand

@@ Line 163: / Line 163: @@
 {{note}} If you want your command to be checked as if it's an alias, use [[Manual:Miscellaneous Functions#expandAlias|expandAlias()]] instead - send() will ignore them.
 <syntaxhighlight lang="lua">
@@ Line 178: / Line 180: @@
 sendAll("hi", "open door e", "e", "get item", "sit")
 </syntaxhighlight>
 [[Category:Mudlet API]]
 [[Category:Mudlet Manual]]

@@ Line 123: / Line 123: @@
 {{MudletVersion|4.14}}
 {{note}} This WILL be echoed to the main console if the option to echo Lua errors to the main console is turned on. You should not use this for idle debugging information, but actual errors that may put big red error lines in the main window.
 ;Parameters

@@ Line 92: / Line 92: @@
 {{MudletVersion|4.14}}
 {{note}} This will not be echoed to the main console even if the option to echo Lua errors to the main console is turned on. Does not echo to the debug window. As such you can use it for debugging information without fear it will be shown unless someone goes looking for errors.
 ;Parameters

@@ Line 42: / Line 42: @@
 See also: [[Manual:Lua_Functions#moveCursor|moveCursor()]], [[Manual:Lua_Functions#insertText|insertText()]], [[Manual:Lua_Functions#cecho|cecho()]], [[Manual:Lua_Functions#decho|decho()]], [[Manual:Lua_Functions#hecho|hecho()]]
 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).
 ;Example

@@ Line 38: / Line 38: @@
 * ''miniconsoleName:'' (optional) the miniconsole to echo to, or:
 * ''labelName:'' (optional) the label to echo to.
-* ''text:'' 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 colour, center, increase/decrease size of text and various other formatting options [http://doc.qt.io/qt-5/richtext-html-subset.html as listed here].
+* ''text:'' 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].
 See also: [[Manual:Lua_Functions#moveCursor|moveCursor()]], [[Manual:Lua_Functions#insertText|insertText()]], [[Manual:Lua_Functions#cecho|cecho()]], [[Manual:Lua_Functions#decho|decho()]], [[Manual:Lua_Functions#hecho|hecho()]]

@@ Line 147: / Line 147: @@
 :This sends "command" directly to the network layer, skipping the alias matching. The optional second argument of type boolean (print) determines if the outgoing command is to be echoed on the screen.
-See also: [[Manual:Networking_Functions#sendAll|sendAll()]], [[Manual:Lua_Functions#speedwalk|speedwalk()]]
+See also: [[Manual:Lua Functions#sendAll|sendAll()]], [[Manual:Lua_Functions#speedwalk|speedwalk()]]
 {{note}} If you want your command to be checked as if it's an alias, use [[Manual:Miscellaneous Functions#expandAlias|expandAlias()]] instead - send() will ignore them.

@@ Line 76: / Line 76: @@
 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>]])
 </syntaxhighlight>

@@ Line 4: / Line 4: @@
 These functions are generic functions used in normal scripting. These deal with mainly everyday things, like sending stuff and echoing to the screen.
-==send==
+:See also: [[Manual:Introduction#Runtime_errors_aka_Errors_View|Errors View]]
-See also: [[Manual:Networking_Functions#sendAll|sendAll()]], [[Manual:Lua_Functions#speedwalk|speedwalk()]]
+{{note}} Do not use this to display information to end-users. It will be hard to find. It is mainly useful for developing/debugging. Does not echo to the debug window
 <syntaxhighlight lang="lua">
-send("Hello Jane") --echos the command on the screen
+debugc(" Trigger successful!")
-send("Hello Jane", true) --echos the command on the screen
+-- Text will be shown in errors view, not to main window.
-send("Hello Jane", false) --does not echo the command on the screen
+</syntaxhighlight>
--- use a variable in the send:
+==display==
-send("kick "..target)
+;display(content)
--- to send directions:
+{{note}} Do not use this to display information to end-users. It may be hard to read. It is mainly useful for developing/debugging.
--- to send many things:
+<syntaxhighlight lang="lua">
-sendAll("hi", "open door e", "e", "get item", "sit")
+myTable = {} -- create an empty lua table
 </syntaxhighlight>
 ==echo==
@@ Line 77: / Line 78: @@
 </syntaxhighlight>
-==display==
+==send==
-;display(content)
+;send(command, showOnScreen)
-:This is much like echo, in that is will show text at your screen, not send anything to anywhere. However, it also works with other objects than just text, like a number, table, function, or even many arguments at once. This function is useful to easily take a look at the values of a lua table, for example. If a value is a string of letters, it'll be in quotes, and if it's a number, it won't be quoted.
+:This sends "command" directly to the network layer, skipping the alias matching. The optional second argument of type boolean (print) determines if the outgoing command is to be echoed on the screen.
-{{note}} Do not use this to display information to end-users. It may be hard to read. It is mainly useful for developing/debugging.
+{{note}} If you want your command to be checked as if it's an alias, use [[Manual:Miscellaneous Functions#expandAlias|expandAlias()]] instead - send() will ignore them.
 <syntaxhighlight lang="lua">
-myTable = {} -- create an empty lua table
+send("Hello Jane") --echos the command on the screen
-myTable.foo = "Hello there" -- add a text
+send("Hello Jane", true) --echos the command on the screen
-myTable.bar = 23 -- add a number
+send("Hello Jane", false) --does not echo the command on the screen
-==debugc==
+-- use a variable in the send:
-;debugc(content)
+send("kick "..target)
-:See also: [[Manual:Introduction#Runtime_errors_aka_Errors_View|Errors View]]
+-- to send directions:
-{{note}} Do not use this to display information to end-users. It will be hard to find. It is mainly useful for developing/debugging. Does not echo to the debug window
+-- to send many things:
-<syntaxhighlight lang="lua">
+{{note}} The game server can choose not to show commands sent on screen (for example, if you're typing in a password).
 [[Category:Mudlet API]]
 [[Category:Mudlet Manual]]

@@ Line 28: / Line 28: @@
 </syntaxhighlight>
-{{note}} Since '''Mudlet 3.17.1''' the optional second argument to echo the command on screen will be ineffective whilst the game server has negotiated the telnet ECHO option to provide the echoing of text we ''send'' to it.
+{{note}} The game server can choose not to show commands sent on screen (for example, if you're typing in a password.
 ==echo==