Difference between revisions of "User:Molideus"

From Mudlet
Jump to navigation Jump to search
Line 1: Line 1:
 
{{TOC right}}
 
{{TOC right}}
−
{{#description2:Mudlet API documentation for functions to manipulate Mudlet's scripting objects - triggers, aliases, and so forth.}}
+
{{#description2:Mudlet API documentation for functions for managing networking.}}
−
= Mudlet Object Functions =
+
= Networking Functions =
−
Collection of functions to manipulate Mudlet's scripting objects - triggers, aliases, and so forth.
+
A collection of functions for managing networking.
  
−
==addCmdLineSuggestion==
+
==connectToServer==
−
;addCmdLineSuggestion([name], suggestion)
+
;connectToServer(host, port, [save])
−
: Add suggestion for tab completion for specified command line.
+
: Connects to a given game.
  
−
: For example, start typing ''he'' and hit ''TAB'' until ''help'' appears in command line.
+
;Parameters:
−
: Non-word characters are skipped (this is the reason why they can't be added at start of suggestion), therefore it's also possible to type: ''/he'' and hit ''TAB''.
+
* ''host:''
−
 
+
: Server domain or IP address.
−
: See also: [[Manual:Lua_Functions#clearCmdLineSuggestions|clearCmdLineSuggestions()]], [[Manual:Lua_Functions#removeCmdLineSuggestion|removeCmdLineSuggestion()]]
+
* ''port:''
−
 
+
: Servers port.
−
{{MudletVersion|4.11}}
+
* ''save:''
−
 
+
: (optional, boolean) if provided, saves the new connection parameters in the profile so they'll be used next time you open it.
−
;Parameters
 
−
* ''name'': optional command line name, if skipped main command line will be used
 
−
* ''suggestion'' - suggestion as a single word to add to tab completion (only the following are allowed: ''0-9A-Za-z_'')
 
−
 
 
−
Example:
 
−
<syntaxhighlight lang="lua">
 
−
addCmdLineSuggestion("help")
 
−
 
 
−
local suggestions = {"Pneumonoultramicroscopicsilicovolcanoconiosis", "supercalifragilisticexpialidocious", "serendipitous"}
 
−
for _, suggestion in ipairs(suggestions) do
 
−
  addCmdLineSuggestion(suggestion)
 
−
end
 
−
</syntaxhighlight>
 
  
−
==adjustStopWatch==
+
{{note}} ''save'' is available in Mudlet 3.2+.
−
;adjustStopWatch(watchID/watchName, amount)
 
−
: Adjusts the elapsed time on the stopwatch forward or backwards by the amount of time. It will work even on stopwatches that are not running, and thus can be used to preset a newly created stopwatch with a negative amount so that it runs down from a negative time towards zero at the preset time.
 
−
 
 
−
;Parameters
 
−
* watchID (number) / watchName (string): The stopwatch ID you get with [[Manual:Lua_Functions#createStopWatch|createStopWatch()]] or the name given to that function or later set with [[Manual:Lua_Functions#setStopWatchName|setStopWatchName()]].
 
−
* amount (decimal number): An amount in seconds to adjust the stopwatch by, positive amounts increase the recorded elapsed time.
 
−
 
 
−
;Returns
 
−
* true on success if the stopwatch was found and thus adjusted, or nil and an error message if not.
 
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- demo of a persistent stopWatch used to real time a mission
+
connectToServer("midnightsun2.org", 3000)
−
-- called with a positive number of seconds it will start a "missionStopWatch"
 
−
-- unless there already is one in which case it will instead report on
 
−
-- the deadline. use 'stopStopWatch("missionStopWatch")' when the mission
 
−
-- is done and 'deleteStopWatch("missionStopWatch")' when the existing mission
 
−
-- is to be disposed of. Until then repeated use of 'mission(interval)' will
 
−
-- just give updates...
 
−
function mission(time)
 
−
  local missionTimeTable = missionTimeTable or {}
 
−
 
 
−
  if createStopWatch("missionStopWatch") then
 
−
    adjustStopWatch("missionStopWatch", -tonumber(time))
 
−
    setStopWatchPersistence("missionStopWatch", true)
 
−
    missionTimeTable = getStopWatchBrokenDownTime("missionStopWatch")
 
  
−
    echo(string.format("Get cracking, you have %02i:%02i:%02i hg:m:s left.\n", missionTimeTable.hours, missionTimeTable.minutes, missionTimeTable.seconds))
+
-- save to disk so these parameters are used next time when opening the profile
−
    startStopWatch("missionStopWatch")
+
connectToServer("midnightsun2.org", 3000, true)
−
  else
 
−
    -- it already exists, so instead report what is/was the time on it
 
−
    --[=[ We know that the stop watch exists - we just need to find the ID
 
−
      so we can get the running detail which is only available from the getStopWatches()
 
−
      table and that is indexed by ID]=]
 
−
    for k,v in pairs(getStopWatches()) do
 
−
      if v.name == "missionStopWatch" then
 
−
        missionTimeTable = v
 
−
      end
 
−
    end
 
−
    if missionTimeTable.isRunning then
 
−
      if missionTimeTable.elapsedTime.negative then
 
−
        echo(string.format("Better hurry up, the clock is ticking on an existing mission and you only have %02i:%02i:%02i h:m:s left.\n", missionTimeTable.elapsedTime.hours, missionTimeTable.elapsedTime.minutes, missionTimeTable.elapsedTime.seconds))
 
−
      else
 
−
        echo(string.format("Bad news, you are past the deadline on an existing mission by %02i:%02i:%02i h:m:s !\n", missionTimeTable.elapsedTime.hours, missionTimeTable.elapsedTime.minutes, missionTimeTable.elapsedTime.seconds))
 
−
      end
 
−
    else
 
−
      if missionTimeTable.elapsedTime.negative then
 
−
        echo(string.format("Well done! You have already completed a mission %02i:%02i:%02i h:m:s before the deadline ...\n", missionTimeTable.elapsedTime.hours, missionTimeTable.elapsedTime.minutes, missionTimeTable.elapsedTime.seconds))
 
−
      else
 
−
        echo(string.format("Uh oh! You failed to meet the deadline on an existing mission by %02i:%02i:%02i h:m:s !\n", missionTimeTable.elapsedTime.hours, missionTimeTable.elapsedTime.minutes, missionTimeTable.elapsedTime.seconds))
 
−
      end
 
−
    end
 
−
  end
 
−
end
 
−
 
 
−
 
 
−
-- in use:
 
−
lua mission(60*60)
 
−
Get cracking, you have 01:00:00 h:m:s left.
 
−
 
 
−
lua mission(60*60)
 
−
Better hurry up, the clock is ticking on an existing mission and you only have 00:59:52 h:m:s left.
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
{{MudletVersion|4.4}}
+
==disconnect==
−
 
+
;disconnect()
−
==ancestors==
+
: Disconnects you from the game right away. Note that this will ''not'' properly log you out of the game - use an ingame command for that. Such commands vary, but typically QUIT will work.
−
 
 
−
;ancestors(IDnumber, type)
 
−
:You can use this function to find out about all the ancestors of something.
 
−
 
 
−
:Returns a list as a table with the details of each successively distance ancestor (if any) of the given item; the details are in the form of a sub-table, within each containing specifically:
 
−
:* its IDnumber as a number
 
−
:* its name as a string
 
−
:* whether it is active as a boolean
 
−
:* its "node" (type) as a string, one of "item", "group" (folder) or "package" (module)
 
−
:Returns ''nil'' and an error message if either parameter is not valid
 
−
 
 
−
;Parameters
 
−
* ''IDnumber:''
 
−
: The ID number of a single item, (which will be that returned by a ''temp*'' or ''perm*'' function to create such an item to identify the item).
 
−
* ''type:''
 
−
: The type can be 'alias', 'button', 'trigger', 'timer', 'keybind', or 'script'.
 
−
 
 
−
: See also: [[#isAncestorsActive|isAncestorsActive(...)]], [[#isActive|isActive(...)]]
 
  
 +
: See also: [[Manual:Networking_Functions#reconnect|reconnect()]]
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- To do
+
disconnect()
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==appendScript==
+
==downloadFile==
−
;appendScript(scriptName, luaCode, [occurrence])
+
;downloadFile(saveto, url)
−
: Appends Lua code to the script "scriptName". If no occurrence given it sets the code of the first found script.
+
: Downloads the resource at the given url into the saveto location on disk. This does not pause the script until the file is downloaded - instead, it lets it continue right away and downloads in the background. When a download is finished, the [[Manual:Event_Engine#sysDownloadDone|sysDownloadDone]] event is raised (with the saveto location as the argument), or when a download fails, the [[Manual:Event_Engine#sysDownloadError|sysDownloadError]] event is raised with the reason for failure. You may call downloadFile multiple times and have multiple downloads going on at once - but they aren’t guaranteed to be downloaded in the same order that you started them in.
  
−
: See also: [[Manual:Lua_Functions#permScript|permScript()]], [[Manual:Lua_Functions#enableScript|enableScript()]], [[Manual:Lua_Functions#disableScript|disableScript()]], [[Manual:Lua_Functions#getScript|getScript()]], [[Manual:Lua_Functions#setScript|setScript()]]
+
:See also: [[#getHTTP|getHTTP()]], [[#postHTTP|postHTTP()]], [[#putHTTP|putHTTP()]], [[#deleteHTTP|deleteHTTP()]]
  
−
;Returns
+
[[File:Downloadfile privacy logging.png|frame|For privacy transparency, URLs accessed are logged in the Central Debug Console]]
−
* a unique id number for that script.
 
  
−
;Parameters
+
{{note}} Since Mudlet 3.0, https downloads are supported and the actual url that was used for the download is returned - useful in case of redirects.
−
* ''scriptName'': name of the script
 
−
* ''luaCode'': scripts luaCode to append
 
−
* ''occurence'': (optional) the occurrence of the script in case you have many with the same name
 
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- an example of appending the script lua code to the first occurrence of "testscript"
+
-- just download a file and save it in our profile folder
−
appendScript("testscript", [[echo("This is a test\n")]], 1)
+
local saveto = getMudletHomeDir().."/dark-theme-mudlet.zip"
 +
local url = "http://www.mudlet.org/wp-content/files/dark-theme-mudlet.zip"
 +
downloadFile(saveto, url)
 +
cecho("<white>Downloading <green>"..url.."<white> to <green>"..saveto.."\n")
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
{{MudletVersion|4.8}}
 
  
−
==appendCmdLine==
 
−
;appendCmdLine([name], text)
 
−
: Appends text to the main input line.
 
−
: See also: [[Manual:Lua_Functions#printCmdLine|printCmdLine()]], [[#clearCmdLine|clearCmdLine()]]
 
  
−
;Parameters
 
−
* ''name'': (optional) name of the command line. If not given, the text will be appended to the main commandline.
 
−
* ''text'': text to append
 
  
−
 
+
A more advanced example that downloads a webpage, reads it, and prints a result from it:
−
;Example
 
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- adds the text "55 backpacks" to whatever is currently in the input line
+
-- create a function to parse the downloaded webpage and display a result
−
appendCmdLine("55 backpacks")
+
function downloaded_file(_, filename)
 +
  -- is the file that downloaded ours?
 +
  if not filename:find("achaea-who-count.html", 1, true) then return end
  
−
-- makes a link, that when clicked, will add "55 backpacks" to the input line
+
  -- read the contents of the webpage in
−
echoLink("press me", "appendCmdLine'55 backpack'", "Press me!")
+
  local f, s, webpage = io.open(filename)
−
</syntaxhighlight>
+
  if f then webpage = f:read("*a"); io.close(f) end
 +
  -- delete the file on disk, don't clutter
 +
  os.remove(filename)
  
−
==clearCmdLine==
+
  -- parse our downloaded file for the player count
−
;clearCmdLine([name])
+
  local pc = webpage:match([[Total: (%d+) players online]])
−
: Clears the input line of any text that's been entered.
+
  display("Achaea has "..tostring(pc).." players on right now.")
−
: See also: [[Manual:Lua_Functions#printCmdLine|printCmdLine()]]
+
end
  
−
;Parameters
+
-- register our function to run on the event that something was downloaded
−
* ''name'': (optional) name of the command line. If not given, the main commandline's text will be cleared.
+
registerAnonymousEventHandler("sysDownloadDone", "downloaded_file")
  
−
;Example
+
-- download a list of fake users for a demo
−
<syntaxhighlight lang="lua">
+
downloadFile(getMudletHomeDir().."/achaea-who-count.html", "https://www.achaea.com/game/who")
−
-- don't be evil with this!
 
−
clearCmdLine()
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==clearCmdLineSuggestions==
+
Result should look like this:
−
;clearCmdLineSuggestions([name])
 
  
−
: Clears all suggestions for command line.
+
[[File:DownloadFile_demo.png|alt=|1000x1000px]].
  
−
: See also: [[Manual:Lua_Functions#addCmdLineSuggestion|addCmdLineSuggestion()]], [[Manual:Lua_Functions#removeCmdLineSuggestion|removeCmdLineSuggestion()]]
+
==getConnectionInfo==
 +
;getConnectionInfo()
 +
:Returns the server address and port that you're currently connected to, and (in Mudlet 4.12+) <code>true</code> or <code>false</code> indicating if you're currently connected to a game.
 +
:See also: [[Manual:Networking_Functions#connectToServer|connectToServer()]]
  
−
;Parameter
+
{{MudletVersion|4.2}}
−
* ''name'': (optional) name of the command line. If not given the main commandline's suggestions will be cleared.
 
−
 
 
−
<syntaxhighlight lang="lua">
 
−
clearCmdLineSuggestions()
 
−
</syntaxhighlight>
 
−
 
 
−
==createStopWatch==
 
−
;createStopWatch([name], [start immediately])
 
−
;createStopWatch([start immediately])
 
−
Before Mudlet 4.4.0:
 
−
;createStopWatch()
 
−
 
 
−
: This function creates a stopwatch, a high resolution time measurement tool. Stopwatches can be started, stopped, reset, asked how much time has passed since the stop watch has been started and, following an update for Mudlet 4.4.0: be adjusted, given a name and be made persistent between sessions (so can time real-life things). Prior to 4.4.0 the function took no parameters '''and the stopwatch would start automatically when it was created'''.
 
−
 
 
−
;Parameters:
 
−
* ''start immediately'' (bool) used to override the behaviour prior to Mudlet 4.4.0 so that if it is the ''only'' argument then a ''false'' value will cause the stopwatch to be created but be in a ''stopped'' state, however if a name parameter is provided then this behaviour is assumed and then a ''true'' value is required should it be desired for the stopwatch to be started on creation. This difference between the cases with and without a name argument is to allow for older scripts to continue to work with 4.4.0 or later versions of Mudlet without change, yet to allow for more functionality - such as presetting a time when the stopwatch is created but not to start it counting down until some time afterwards - to be performed as well with a named stopwatch.
 
−
 
 
−
* ''name'' (string) a ''unique'' text to use to identify the stopwatch.
 
−
 
 
−
;Returns:
 
−
* the ID (number) of a stopwatch; or, from '''4.4.0''': a nil + error message if the name has already been used.
 
−
 
 
−
: See also: [[Manual:Lua_Functions#startStopWatch|startStopWatch()]], [[Manual:Lua_Functions#stopStopWatch|stopStopWatch()]], [[Manual:Lua_Functions#resetStopWatch|resetStopWatch()]], [[Manual:Lua_Functions#getStopWatchTime|getStopWatchTime()]] or, from 4.4.0: [[Manual:Lua_Functions#adjustStopWatch|adjustStopWatch()]], [[Manual:Lua_Functions#deleteStopWatch|deleteStopWatch()]], [[Manual:Lua_Functions#getStopWatches|getStopWatches()]], [[Manual:Lua_Functions#getStopWatchBrokenDownTime|getStopWatchBrokenDownTime()]], [[Manual:Lua_Functions#setStopWatchName|setStopWatchName()]], [[Manual:Lua_Functions#setStopWatchPersistence|setStopWatchPersistence()]]
 
  
 
;Example
 
;Example
−
: (Prior to Mudlet 4.4.0) in a global script you can create all stop watches that you need in your system and store the respective stopWatch-IDs in global variables:
 
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
fightStopWatch = fightStopWatch or createStopWatch() -- create, or re-use a stopwatch, and store the watchID in a global variable to access it from anywhere
+
local host, port, connected = getConnectionInfo()
−
 
+
cecho(string.format("<light_grey>Playing on <forest_green>%s:%s<light_grey>, currently connected? <forest_green>%s\n", host, port, tostring(connected)))
−
-- then you can start the stop watch in some trigger/alias/script with:
 
−
startStopWatch(fightStopWatch)
 
−
 
 
−
-- to stop the watch and measure its time in e.g. a trigger script you can write:
 
−
fightTime = stopStopWatch(fightStopWatch)
 
−
echo("The fight lasted for " .. fightTime .. " seconds.")
 
−
resetStopWatch(fightStopWatch)
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
: (From Mudlet 4.4.0) in a global script you can create all stop watches that you need in your system with unique names:
 
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
createStopWatch("fightStopWatch") -- creates the stopwatch or returns nil+msg if it already exists
+
-- echo the new connection parameters whenever we connect to a different host with connectToServer()
 +
function echoInfo()
 +
    local host, port = getConnectionInfo()
 +
    cecho(string.format("<light_grey>Now connected to <forest_green>%s:%s\n", host, port))
 +
  end
  
−
-- then you can start the stop watch (if it is not already started) in some trigger/alias/script with:
+
registerAnonymousEventHandler("sysConnectionEvent", "echoInfo")
−
startStopWatch("fightStopWatch")
 
−
 
 
−
-- to stop the watch and measure its time in e.g. a trigger script you can write:
 
−
fightTime = stopStopWatch("fightStopWatch")
 
−
echo("The fight lasted for " .. fightTime .. " seconds.")
 
−
resetStopWatch("fightStopWatch")
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
:You can also measure the elapsed time without having to stop the stop watch (equivalent to getting a ''lap-time'') with [[#getStopWatchTime|getStopWatchTime()]].
+
==getIrcChannels==
 +
;getIrcChannels()
 +
:Returns a list of channels the IRC client is joined to as a lua table. If the client is not yet started the value returned is loaded from disk and represents channels the client will auto-join when started.
 +
:See also: [[Manual:Networking_Functions#setIrcChannels|setIrcChannels()]]
  
−
{{note}} it's best to re-use stopwatch IDs if you can for Mudlet prior to 4.4.0 as they cannot be deleted, so creating more and more would use more memory. From 4.4.0 the revised internal design has been changed such that there are no internal timers created for each stopwatch - instead either a timestamp or a fixed elapsed time record is used depending on whether the stopwatches is running or stopped so that there are no "moving parts" in the later design and less resources are used - and they can be removed if no longer required.
+
{{MudletVersion|3.3}}
−
 
 
−
==deleteAllNamedTimers==
 
−
; deleteAllNamedTimers(userName)
 
−
 
 
−
:Deletes all named timers and prevents them from firing any more. Information is deleted and cannot be retrieved.
 
−
 
 
−
;See also: [[Manual:Lua_Functions#registerNamedTimer|registerNamedTimer()]], [[Manual:Lua_Functions#stopNamedTimer|stopNamedTimer()]]
 
−
 
 
−
{{MudletVersion|4.14}}
 
−
 
 
−
;Parameters
 
−
* ''userName:''
 
−
: The user name the event handler was registered under.
 
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
deleteAllNamedTimers("Demonnic") -- emergency stop or debugging situation, most likely.
+
display(getIrcChannels())
 +
-- Prints: {"#mudlet", "#lua"}
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==deleteNamedTimer==
+
==getIrcConnectedHost==
−
; success = deleteNamedTimer(userName, handlerName)
+
;getIrcConnectedHost()
−
 
+
:Returns true+host where host is a string containing the host name of the IRC server, as given to the client by the server while starting the IRC connection. If the client has not yet started or finished connecting this will return false and an empty string.
−
:Deletes a named timer with name handlerName and prevents it from firing any more. Information is deleted and cannot be retrieved.
 
−
 
 
−
;See also: [[Manual:Lua_Functions#registerNamedTimer|registerNamedTimer()]], [[Manual:Lua_Functions#stopNamedTimer|stopNamedTimer()]]
 
  
−
{{MudletVersion|4.14}}
+
:This function can be particularly useful for testing if the IRC client has connected to a server prior to sending data, and it will not auto-start the IRC client.<br /> 
 +
:The ''hostname'' value this function returns can be used to test if [[Manual:Event_Engine#sysIrcMessage|sysIrcMessage]] events are sent from the server or a user on the network.
  
−
;Parameters
 
−
* ''userName:''
 
−
: The user name the event handler was registered under.
 
−
* ''handlerName:''
 
−
: The name of the handler to stop. Same as used when you called [[Manual:Lua_Functions#registerNamedTimer|registerNamedTimer()]]
 
−
 
−
;Returns
 
−
* true if successful, false if it didn't exist
 
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
local deleted = deleteNamedTimer("Demonnic", "DemonVitals")
+
local status, hostname = getIrcConnectedHost()
−
if deleted then
+
 
−
   cecho("DemonVitals deleted forever!!")
+
if status == true then
−
else
+
   -- do something with connected IRC, send IRC commands, store 'hostname' elsewhere.
−
   cecho("DemonVitals doesn't exist and so could not be deleted.")
+
  -- if sysIrcMessage sender = hostname from above, message is likely a status, command response, or an error from the Server.
 +
else  
 +
   -- print a status, change connection settings, or just continue waiting to send IRC data.
 
end
 
end
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==deleteStopWatch==
+
{{MudletVersion|3.3}}
−
;deleteStopWatch(watchID/watchName)
 
  
−
: This function removes an existing stopwatch, whether it only exists for this session or is set to be otherwise saved between sessions by using [[Manual:Lua_Functions#setStopWatchPersistence|setStopWatchPersistence()]] with a ''true'' argument. 
+
==getIrcNick==
 +
;getIrcNick()
 +
:Returns a string containing the IRC client nickname. If the client is not yet started, your default nickname is loaded from IRC client configuration.
 +
:See also: [[Manual:Networking_Functions#setIrcNick|setIrcNick()]]
  
−
;Parameters
+
{{MudletVersion|3.3}}
−
* ''watchID'' (number) / ''watchName'' (string): The stopwatch ID you get with [[Manual:Lua_Functions#createStopWatch|createStopWatch()]] or the name given to that function or later set with [[Manual:Lua_Functions#setStopWatchName|setStopWatchName()]].
 
−
 
 
−
;Returns:
 
−
* ''true'' if the stopwatch was found and thus deleted, or ''nil'' and an error message if not - obviously using it twice with the same argument will fail the second time unless another one with the same name or ID was recreated before the second use. Note that an empty string as a name ''will'' find the lowest ID numbered ''unnamed'' stopwatch and that will then find the next lowest ID number of unnamed ones until there are none left, if used repetitively!
 
  
 +
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
lua MyStopWatch = createStopWatch("stopwatch_mine")
+
local nick = getIrcNick()
−
true
+
echo(nick)
−
 
+
-- Prints: "Sheldor"
−
lua display(MyStopWatch)
 
−
4
 
−
 
 
−
lua deleteStopWatch(MyStopWatch)
 
−
true
 
−
 
 
−
lua deleteStopWatch(MyStopWatch)
 
−
nil
 
−
 
 
−
"stopwatch with id 4 not found"
 
−
 
 
−
lua deleteStopWatch("stopwatch_mine")
 
−
nil
 
−
 
 
−
"stopwatch with name "stopwatch_mine" not found"
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
: See also: [[Manual:Lua_Functions#createStopWatch|createStopWatch()]],
+
==getIrcServer==
 +
;getIrcServer()
 +
:Returns the IRC client server name and port as a string and a number respectively. If the client is not yet started your default server is loaded from IRC client configuration.
 +
:See also: [[Manual:Networking_Functions#setIrcServer|setIrcServer()]]
  
−
{{MudletVersion|4.4}}
+
{{MudletVersion|3.3}}
  
−
{{note}} Stopwatches that are not set to be persistent will be deleted automatically at the end of a session (or if [[Manual:Miscellaneous_Functions#resetProfile|resetProfile()]] is called).
+
;Example
−
 
 
−
==removeCmdLineSuggestion==
 
−
;removeCmdLineSuggestion([name], suggestion)
 
−
: Remove a suggestion for tab completion for specified command line.
 
−
 
 
−
: See also: [[Manual:Lua_Functions#addCmdLineSuggestion|addCmdLineSuggestion()]], [[Manual:Lua_Functions#clearCmdLineSuggestions|clearCmdLineSuggestions()]]
 
−
 
 
−
{{MudletVersion|4.11}}
 
−
 
 
−
;Parameters
 
−
* ''name'': optional command line name, if skipped main command line will be used
 
−
* ''suggestion'' - text to add to tab completion, non words characters at start and end of word should not be used (all characters except: `0-9A-Za-z_`)
 
−
 
 
−
Example:
 
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
removeCmdLineSuggestion("help")
+
local server, port = getIrcServer()
 +
echo("server: "..server..", port: "..port.."\n")
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==disableAlias==
+
==getNetworkLatency==
−
;disableAlias(name)
+
; getNetworkLatency()
−
:Disables/deactivates the alias by its name. If several aliases have this name, they'll all be disabled. If you disable an alias group, all the aliases inside the group will be disabled as well.
+
: Returns the last measured response time between the sent command and the server reply in seconds - e.g. 0.058 (=58 milliseconds lag) or 0.309 (=309 milliseconds). This is the ''N:'' number you see bottom-right of Mudlet.
  
−
: See also: [[#enableAlias|enableAlias()]], [[#disableTrigger|disableTrigger()]], [[#disableTimer|disableTimer()]], [[#disableKey|disableKey()]], [[#disableScript|disableScript()]].
+
Also known as server lag.
  
−
;Parameters
+
;Example
−
* ''name:''
+
''Need example''
−
: The name of the alias. Passed as a string.
 
  
−
;Examples
+
==openUrl==
−
<syntaxhighlight lang="lua">
+
;openUrl (url)
−
--Disables the alias called 'my alias'
+
:Opens the default OS browser for the given URL.
−
disableAlias("my alias")
 
−
</syntaxhighlight>
 
−
 
 
−
==disableKey==
 
−
;disableKey(name)
 
−
:Disables key a key (macro) or a key group. When you disable a key group, all keys within the group will be implicitly disabled as well.
 
−
 
 
−
: See also: [[#enableKey|enableKey()]]
 
−
 
 
−
;Parameters
 
−
* ''name:''
 
−
: The name of the key or group to identify what you'd like to disable.
 
−
 
 
−
;Examples
 
  
 +
;Example:
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- you could set multiple keys on the F1 key and swap their use as you wish by disabling and enabling them
+
openUrl("http://google.com")
−
disableKey("attack macro")
+
openUrl("www.mudlet.org")
−
disableKey("jump macro")
 
−
enableKey("greet macro")
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==disableScript==
+
==reconnect==
−
;disableScript(name)
+
;reconnect()
−
:Disables a script that was previously enabled. Note that disabling a script only stops it from running in the future - it won't "undo" anything the script has made, such as labels on the screen.
+
: Force-reconnects (so if you're connected, it'll disconnect) you to the game.
−
 
 
−
: See also: [[#permScript|permScript()]], [[#appendScript|appendScript()]], [[#enableScript|enableScript()]], [[#getScript|getScript()]], [[#setScript|setScript()]]
 
−
 
 
−
;Parameters
 
−
* ''name'': name of the script.
 
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
--Disables the script called 'my script'
+
-- you could trigger this on a log out message to reconnect, if you'd like
−
disableScript("my script")
+
reconnect()
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
{{MudletVersion|4.8}}
+
==restartIrc==
 +
;restartIrc()
 +
:Restarts the IRC client connection, reloading configurations from disk before reconnecting the IRC client.
  
−
==disableTimer==
+
{{MudletVersion|3.3}}
−
;disableTimer(name)
 
−
:Disables a timer from running it’s script when it fires - so the timer cycles will still be happening, just no action on them. If you’d like to permanently delete it, use [[Manual:Lua_Functions#killTrigger|killTrigger]] instead.
 
  
−
: See also: [[#enableTimer|enableTimer()]], [[#disableTrigger|disableTrigger()]], [[#disableAlias|disableAlias()]], [[#disableKey|disableKey()]], [[#disableScript|disableScript()]].
+
==sendAll==
 +
; sendAll(list of things to send, [echo back or not])
 +
: sends multiple things to the game. If you'd like the commands not to be shown, include ''false'' at the end.
  
−
;Parameters
+
:See also: [[Manual:Basic_Essentials#send|send()]]
−
* ''name:''
 
−
: Expects the timer ID that was returned by [[Manual:Lua_Functions#tempTimer|tempTimer]] on creation of the timer or the name of the timer in case of a GUI timer.
 
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
--Disables the timer called 'my timer'
+
-- instead of using many send() calls, you can use one sendAll
−
disableTimer("my timer")
+
sendAll("outr paint", "outr canvas", "paint canvas")
 +
-- can also have the commands not be echoed
 +
sendAll("hi", "bye", false)
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==disableTrigger==
+
==sendATCP==
−
;disableTrigger(name)
+
;sendATCP(message, what)
−
:Disables a permanent (one in the trigger editor) or a temporary trigger. When you disable a group, all triggers inside the group are disabled as well
+
: ''Need description''
  
−
: See also: [[#enableTrigger|enableTrigger()]], [[#disableAlias|disableAlias()]], [[#disableTimer|disableTimer()]], [[#disableKey|disableKey()]], [[#disableScript|disableScript()]].
+
: See also: [[Manual:Supported_Protocols#ATCP|ATCP Protocol]], [[Manual:ATCP_Extensions|ATCP Extensions]], [http://www.ironrealms.com/rapture/manual/files/FeatATCP-txt.html Achaea Telnet Client Protocol specification], [https://forums.mudlet.org/viewtopic.php?p=19502#p19502 Description by forum user KaVir (2013)], [https://forums.mudlet.org/viewtopic.php?p=2015#p2015 Description by forum user Iocun (2009)]
  
−
;Parameters
+
;Parameters:
−
* ''name:''
+
* ''message:''
−
: Expects the trigger ID that was returned by [[Manual:Lua_Functions#tempTrigger|tempTrigger]] or other temp*Trigger variants, or the name of the trigger in case of a GUI trigger.
+
: The message that you want to send.
 +
* ''what:''
 +
: ''Need description''
  
 
;Example
 
;Example
−
<syntaxhighlight lang="lua">
+
''Need example''
−
-- Disables the trigger called 'my trigger'
 
−
disableTrigger("my trigger")
 
−
</syntaxhighlight>
 
  
−
==enableAlias==
+
==sendGMCP==
−
;enableAlias(name)
+
;sendGMCP(command)
−
:Enables/activates the alias by it’s name. If several aliases have this name, they’ll all be enabled.
+
: Sends a GMCP message to the server.  The [http://www.ironrealms.com/gmcp-doc IRE document on GMCP] has information about what can be sent, and what tables it will use, etcetera.
 +
: Note that this function is rarely used in practice. For most GMCP modules, the messages are automatically sent by the server when a relevant event happens in the game. For example, LOOKing in your room prompts the server to send the room description and contents, as well as the GMCP message gmcp.Room. A call to sendGMCP would not be required in this case.
  
−
: See also: [[#disableAlias|disableAlias()]]
+
: When playing an IRE game, a call to <code>send(" ")</code> afterwards is necessary due to a bug in the game with compression (MCCP) is enabled.
  
−
;Parameters
+
: See also: [[Manual:Scripting#GMCP|GMCP Scripting for Discord status]]
−
* ''name:''
 
−
: Expects the alias ID that was returned by [[Manual:Lua_Functions#tempAlias|tempAlias]] on creation of the alias or the name of the alias in case of a GUI alias.
 
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
--Enables the alias called 'my alias'
+
--This would send "Core.KeepAlive" to the server, which resets the timeout
−
enableAlias("my alias")
+
sendGMCP("Core.KeepAlive")
−
</syntaxhighlight>
 
  
−
==enableKey==
+
--This would send a request for the server to send an update to the gmcp.Char.Skills.Groups table.
−
;enableKey(name)
+
sendGMCP("Char.Skills.Get {}")
−
:Enables a key (macro) or a group of keys (and thus all keys within it that aren't explicitly deactivated).
 
  
−
;Parameters
+
--This would send a request for the server to send a list of the skills in the
−
* ''name:''
+
--vision group to the gmcp.Char.Skills.List table.
−
: The name of the group that identifies the key.
 
  
−
<syntaxhighlight lang="lua">
+
sendGMCP("Char.Skills.Get " .. yajl.to_string{group = "vision"})
−
-- you could use this to disable one key set for the numpad and activate another
 
−
disableKey("fighting keys")
 
−
enableKey("walking keys")
 
−
</syntaxhighlight>
 
−
{{note}} From Version '''3.10'' returns ''true'' if one or more keys or groups of keys were found that matched the name given or ''false'' if not; prior to then it returns ''true'' if there were '''any''' keys - whether they matched the name or not!
 
  
−
==enableScript==
+
--And finally, this would send a request for the server to send the info for
−
;enableScript(name)
+
--hide in the woodlore group to the gmcp.Char.Skills.Info table
−
:Enables / activates a script that was previously disabled.  
 
  
−
: See also: [[#permScript|permScript()]], [[#appendScript|appendScript()]], [[#disableScript|disableScript()]], [[#getScript|getScript()]], [[#setScript|setScript()]]
+
sendGMCP("Char.Skills.Get " .. yajl.to_string{group="MWP", name="block"})
−
 
 
−
;Parameters
 
−
* ''name'': name of the script.
 
−
<syntaxhighlight lang="lua">
 
−
-- enable the script called 'my script' that you created in Mudlet's script section
 
−
enableScript("my script")
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
{{MudletVersion|4.8}}
+
==sendMSDP==
 +
;sendMSDP(variable[, value][, value...])
 +
: Sends a MSDP message to the server.
  
−
==enableTimer==
+
;Parameters:
−
;enableTimer(name)
+
* ''variable:''
−
:Enables or activates a timer that was previously disabled.
+
: The variable, in MSDP terms, that you want to request from the server.
−
 
+
* ''value:''
−
;Parameters
+
: The variables value that you want to request. You can request more than one value at a time.
−
* ''name:''
 
−
: Expects the timer ID that was returned by [[Manual:Lua_Functions#tempTimer|tempTimer]] on creation of the timer or the name of the timer in case of a GUI timer.
 
−
<syntaxhighlight lang="lua">
 
−
-- enable the timer called 'my timer' that you created in Mudlets timers section
 
−
enableTimer("my timer")
 
−
</syntaxhighlight>
 
−
 
 
−
<syntaxhighlight lang="lua">
 
−
-- or disable & enable a tempTimer you've made
 
−
timerID = tempTimer(10, [[echo("hi!")]])
 
−
 
 
−
-- it won't go off now
 
−
disableTimer(timerID)
 
−
-- it will continue going off again
 
−
enableTimer(timerID)
 
−
</syntaxhighlight>
 
−
 
 
−
==enableTrigger==
 
−
;enableTrigger(name)
 
−
:Enables or activates a trigger that was previously disabled.  
 
−
 
 
−
;Parameters
 
−
* ''name:''
 
−
: Expects the trigger ID that was returned by [[Manual:Lua_Functions#tempTrigger|tempTrigger]] or by any other temp*Trigger variants, or the name of the trigger in case of a GUI trigger.
 
−
<syntaxhighlight lang="lua">
 
−
-- enable the trigger called 'my trigger' that you created in Mudlets triggers section
 
−
enableTrigger("my trigger")
 
−
</syntaxhighlight>
 
  
−
<syntaxhighlight lang="lua">
+
: See Also: [[Manual:Supported_Protocols#MSDP|MSDP support in Mudlet]], [http://tintin.sourceforge.net/msdp/ Mud Server Data Protocol specification]
−
-- or disable & enable a tempTrigger you've made
 
−
triggerID = tempTrigger("some text that will match in a line", [[echo("hi!")]])
 
−
 
 
−
-- it won't go off now when a line with matching text comes by
 
−
disableTrigger(triggerID)
 
−
 
 
−
-- and now it will continue going off again
 
−
enableTrigger(triggerID)
 
−
</syntaxhighlight>
 
−
 
 
−
==exists==
 
−
;exists(name/IDnumber, type)
 
−
:Returns the number of things with the given name or number of the given type - and 0 if none are present. Beware that all numbers are true in Lua, including zero.
 
−
 
 
−
;Parameters
 
−
* ''name:''
 
−
: The name (as a string) or, from '''Mudlet 4.17.0''', the ID number of a single item, (which will be that returned by a ''temp*'' or ''perm*'' function to create such an item to identify the item).
 
−
* ''type:''
 
−
: The type can be 'alias', 'button' (Mudlet 4.10+), 'trigger', 'timer', 'keybind' (Mudlet 3.2+), or 'script' (Mudlet 3.17+).
 
−
 
 
−
:See also: [[#isActive|isActive(...)]]
 
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
echo("I have " .. exists("my trigger", "trigger") .. " triggers called 'my trigger'!")
+
-- ask for a list of commands, lists, and reportable variables that the server supports
−
</syntaxhighlight>
+
sendMSDP("LIST", "COMMANDS", "LISTS", "REPORTABLE_VARIABLES")
−
 
 
−
: You can also use this alias to avoid creating duplicate things, for example:
 
−
<syntaxhighlight lang="lua">
 
−
-- this code doesn't check if an alias already exists and will keep creating new aliases
 
−
permAlias("Attack", "General", "^aa$", [[send ("kick rat")]])
 
  
−
-- while this code will make sure that such an alias doesn't exist first
+
-- ask the server to start keeping you up to date on your health
−
-- we do == 0 instead of 'not exists' because 0 is considered true in Lua
+
sendMSDP("REPORT", "HEALTH")
−
if exists("Attack", "alias") == 0 then
 
−
    permAlias("Attack", "General", "^aa$", [[send ("kick rat")]])
 
−
end
 
−
</syntaxhighlight>
 
  
−
: Especially helpful when working with [[Manual:Lua_Functions#permTimer|permTimer]]:
+
-- or on your health and location
−
<syntaxhighlight lang="lua">
+
sendMSDP("REPORT", "HEALTH", "ROOM_VNUM", "ROOM_NAME")
−
if not exists("My animation timer", "timer") then
 
−
  vdragtimer = permTimer("My animation timer", "", .016, onVDragTimer) -- 60fps timer!
 
−
end
 
−
 
−
enableTimer("My animation timer")
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
{{Note}} A positive ID number will return either a ''1'' or ''0'' value and not a lua boolean ''true'' or ''false'' as might otherwise be expected, this is for constancy with the way the function behaves for a name.
+
==sendIrc==
 +
;sendIrc(target, message)
 +
: Sends a message to an IRC channel or person. Returns ''true''+''status'' if message could be sent or was successfully processed by the client, or ''nil''+''error'' if the client is not ready for sending, and ''false''+''status'' if the client filtered the message or failed to send it for some reason. If the IRC client hasn't started yet, this function will initiate the IRC client and begin a connection.
  
−
==findItems==
+
To receive an IRC message, check out the [[Manual:Event_Engine#sysIrcMessage|sysIrcMessage event]].
  
−
;findItems("name", "type"[, exact[, case sensitive]])
+
{{note}} Since Mudlet 3.3, auto-opens the IRC window and returns the success status.
−
: You can use this function to determine the ID number or numbers of items of a particular type with a given name.
 
  
−
:Returns a list as a table with ids of each Mudlet item that matched or ''nil'' and an error message should an incorrect type string be given.
+
;Parameters:
−
 
+
* ''target:''
−
;Parameters
+
: nick or channel name and if omitted will default to the first available channel in the list of joined channels.
−
* ''name:''
+
* ''message:''
−
:The name (as a string) of the item, (which will be that returned by a ''temp*'' or ''perm*'' function to create such an item to identify the item).
+
: The message to send, may contain IRC client commands which start with <code>/</code> and can use all commands which are available through the client window.
−
* ''type:''
 
−
:The type (as a string) can be 'alias', 'button', 'trigger', 'timer', 'keybind' , or 'script'.
 
−
* ''exact:''
 
−
:(Optional) a boolean which if omitted or ''true'' specifies to match the given name against the whole of the names for items or only as a sub-string of them. As a side effect, if this is provided and is ''false'' and an empty string (i.e. ''""'') is given as the first argument then the function will return the ID numbers of ''all'' items (both temporary and permanent) of the given type in existence at the time.
 
−
* ''case sensitive:''
 
−
:(Optional) a boolean which if omitted or ''true'' specifies to match in a case-sensitive manner the given name against the names for items.
 
  
 
;Example
 
;Example
−
Given a profile with just the default packages installed (automatically) - including the '''echo''' one:
 
−
==getButtonState==
 
−
;getButtonState([ButtonNameOrID])
 
−
:This function can be used within checkbox button scripts (2-state buttons) to determine the current state of the checkbox.
 
−
 
−
: See also: [[#setButtonState|setButtonState()]].
 
−
{{note}} Function can be used in any Mudlet script outside of a button's own script with parameter ButtonNameOrID available from Mudlet version 4.13.0+
 
−
 
−
;Parameters
 
−
* ''ButtonNameOrID:''
 
−
: a numerical ID or string name to identify the checkbox button.
 
−
 
−
;Returns
 
−
* ''2'' if the button has "checked" state, or ''1'' if the button is not checked. (or a ''nil'' and an error message if ButtonNameOrID did not identify a check-able button)
 
−
 
−
;Example
 
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- check from within the script of a check-able button:
+
-- this would send "hello from Mudlet!" to the channel #mudlet on freenode.net
−
local checked = getButtonState()
+
sendIrc("#mudlet", "hello from Mudlet!")
−
if checked == 1 then
+
-- this would send "identify password" in a private message to Nickserv on freenode.net
−
    hideExits()
+
sendIrc("Nickserv", "identify password")
−
else
 
−
    showExits()
 
−
end
 
−
</syntaxhighlight>
 
  
−
<syntaxhighlight lang="lua">
+
-- use an in-built IRC command
−
-- check from anywhere in another Lua script of the same profile (available from Mudlet 4.13.0)
+
sendIrc("#mudlet", "/topic")
−
local checked, errMsg = getButtonState("Sleep")
 
−
if checked then
 
−
    shouldBeMounted = shouldBeMounted or false
 
−
    sendAll("wake", "stand")
 
−
    if shouldBeMounted then
 
−
        send("mount horse")
 
−
    end
 
−
else
 
−
    -- Global used to record if we were on a horse before our nap:
 
−
    shouldBeMounted = mounted or false
 
−
    if shouldBeMounted then
 
−
        send("dismount")
 
−
    end
 
−
    sendAll("sit", "sleep")
 
−
end
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==getCmdLine==
+
{{note}} The following IRC commands are available since Mudlet 3.3:
−
;getCmdLine([name])
+
* /ACTION <target> <message...>
−
: Returns the current content of the given command line.
+
* /ADMIN (<server>)
−
: See also: [[Manual:Lua_Functions#printCmdLine|printCmdLine()]]
+
* /AWAY (<reason...>)
 +
* /CLEAR (<buffer>) -- Clears the text log for the given buffer name. Uses the current active buffer if none are given.
 +
* /CLOSE (<buffer>) -- Closes the buffer and removes it from the Buffer list. Uses the current active buffer if none are given.
 +
* /HELP (<command>) -- Displays some help information about a given command or lists all available commands.
 +
* /INFO (<server>)
 +
* /INVITE <user> (<#channel>)
 +
* /JOIN <#channel> (<key>)
 +
* /KICK (<#channel>) <user> (<reason...>)
 +
* /KNOCK <#channel> (<message...>)
 +
* /LIST (<channels>) (<server>)
 +
* /ME [target] <message...>
 +
* /MODE (<channel/user>) (<mode>) (<arg>)
 +
* /MOTD (<server>)
 +
* /MSG <target> <message...> -- Sends a message to target, can be used to send Private messages.
 +
* /NAMES (<#channel>)
 +
* /NICK <nick>
 +
* /NOTICE <#channel/user> <message...>
 +
* /PART (<#channel>) (<message...>)
 +
* /PING (<user>)
 +
* /RECONNECT -- Issues a Quit command to the IRC Server and closes the IRC connection then reconnects to the IRC server. The same as calling ircRestart() in Lua.
 +
* /QUIT (<message...>)
 +
* /QUOTE <command> (<parameters...>)
 +
* /STATS <query> (<server>)
 +
* /TIME (<user>)
 +
* /TOPIC (<#channel>) (<topic...>)
 +
* /TRACE (<target>)
 +
* /USERS (<server>)
 +
* /VERSION (<user>)
 +
* /WHO <mask>
 +
* /WHOIS <user>
 +
* /WHOWAS <user>
  
−
{{MudletVersion|3.1}}
+
{{note}} The following IRC commands are available since Mudlet 3.15:
 +
* /MSGLIMIT <limit> (<buffer>) -- Sets the limit for messages to keep in the IRC client message buffers and saves this setting.  If a specific buffer/channel name is given the limit is not saved and applies to the given buffer until the application is closed or the limit is changed again.  For this reason, global settings should be applied first, before settings for specific channels/PM buffers.
  
−
;Parameters
+
==sendTelnetChannel102==
−
* ''name'': (optional) name of the command line. If not given, it returns the text of the main commandline.
+
; sendTelnetChannel102(msg)
 +
: Sends a message via the 102 subchannel back to the game (that's used in Aardwolf). The msg is in a two byte format; see the link below to the Aardwolf Wiki for how that works.
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- replaces whatever is currently in the input line by "55 backpacks"
+
-- turn prompt flags on:
−
printCmdLine("55 backpacks")
+
sendTelnetChannel102("\52\1")
  
−
--prints the text "55 backpacks" to the main console
+
-- turn prompt flags off:
−
echo(getCmdLine())
+
sendTelnetChannel102("\52\2")
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==getConsoleBufferSize==
+
To see the list of options that Aardwolf supports go to: [http://www.aardwolf.com/blog/2008/07/10/telnet-negotiation-control-mud-client-interaction/ Using Telnet negotiation to control MUD client interaction].
−
;local lineLimit, sizeOfBatchDeletion = getConsoleBufferSize([consoleName])
 
−
:Returns, on success, the maximum number of lines a buffer (main window or a miniconsole) can hold and how many will be removed at a time when that limit is exceeded; returns a ''nil'' and an error message on failure.
 
−
: See also: [[Manual:Mudlet_Object_Functions#setConsoleBufferSize|setConsoleBufferSize()]]
 
  
−
;Parameters
+
==setIrcChannels==
−
* ''consoleName:''
+
;setIrcChannels(channels)
−
: (optional) The name of the window. If omitted, uses the main console.
+
:Saves the given channels to disk as the new IRC client channel auto-join configuration. This value is not applied to the current active IRC client until it is restarted with [[Manual:Networking_Functions#restartIrc|restartIrc()]]
−
;Example
+
:See also: [[Manual:Networking_Functions#getIrcChannels|getIrcChannels()]], [[Manual:Networking_Functions#restartIrc|restartIrc()]]
−
<syntaxhighlight lang="lua">
 
−
-- sets the main window's size and how many lines will be deleted
 
−
-- when it gets to that size to be as small as possible:
 
−
setConsoleBufferSize("main", 1, 1)
 
−
true
 
  
−
-- find out what the numbers are:
+
;Parameters:
−
local lineLimit, sizeOfBatchDeletion = getConsoleBufferSize()
+
* ''channels:''
−
echo("\nWhen the main console gets to " .. lineLimit .. " lines long, the first " .. sizeOfBatchDeletion .. " lines will be removed.\n")
+
: A table containing strings which are valid channel names. Any channels in the list which aren't valid are removed from the list.  
−
When the main console gets to 100 lines long, the first 1 lines will be removed.
 
−
</syntaxhighlight>
 
−
 
 
−
{{MudletVersion|4.17}}
 
  
−
==getNamedTimers==
+
{{MudletVersion|3.3}}
−
; timers = getNamedTimers(userName)
 
−
 
 
−
:Returns a list of all the named timers' names as a table.
 
−
 
 
−
;See also: [[Manual:Lua_Functions#registerNamedTimer|registerNamedTimer()]]
 
−
 
 
−
{{MudletVersion|4.14}}
 
−
 
 
−
;Parameters
 
−
* ''userName:''
 
−
: The user name the event handler was registered under.
 
−
 
 
−
;Returns
 
−
* a table of handler names. { "DemonVitals", "DemonInv" } for example. {} if none are registered
 
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
  local timers = getNamedTimers("Demonnic")
+
setIrcChannels( {"#mudlet", "#lua", "irc"} )
−
  display(timers)
+
-- Only the first two will be accepted, as "irc" is not a valid channel name.
−
  -- {}
 
−
  registerNamedTimer("Test1", "testEvent", "testFunction")
 
−
  registerNamedTimer("Test2", "someOtherEvent", myHandlerFunction)
 
−
  timers = getNamedTimers("Demonnic")
 
−
  display(timers)
 
−
  -- { "Test1", "Test2" }
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
== getProfileStats==
+
==setIrcNick==
−
;getProfileStats()
+
;setIrcNick(nickname)
 +
:Saves the given nickname to disk as the new IRC client configuration. This value is not applied to the current active IRC client until it is restarted with restartIrc()
 +
:See also: [[Manual:Networking_Functions#getIrcNick|getIrcNick()]], [[Manual:Networking_Functions#restartIrc|restartIrc()]]
  
−
:Returns a table with profile statistics for how many triggers, patterns within them, aliases, keys, timers, and scripts the profile has. Similar to the Statistics button in the script editor, accessible to Lua scripting.
+
;Parameters:
 +
* ''nickname:''
 +
: A string with your new desired name in IRC.
  
−
{{MudletVersion|4.15}}
+
{{MudletVersion|3.3}}
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- show all stats
+
setIrcNick( "Sheldor" )
−
display(getProfileStats())
 
−
 
 
−
-- check how many active triggers there are
 
−
activetriggers = getProfileStats().triggers.active
 
−
cecho(f"<PaleGreen>We have <SlateGrey>{activetriggers}<PaleGreen> active triggers!\n")
 
−
 
 
−
-- triggers can have many patterns, so let's check that as well
 
−
patterns = getProfileStats().triggers.patterns.active
 
−
triggers = getProfileStats().triggers.active
 
−
cecho(f"<PaleGreen>We have <SlateGrey>{patterns}<PaleGreen> active patterns within <SlateGrey>{triggers}<PaleGreen> triggers!\n")
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==getStopWatches==
+
==setIrcServer==
−
;table = getStopWatches()
+
;setIrcServer(hostname, port[, secure])
 +
:Saves the given server's address to disk as the new IRC client connection configuration. These values are not applied to the current active IRC client until it is restarted with restartIrc()
 +
:See also: [[Manual:Networking_Functions#getIrcServer|getIrcServer()]], [[Manual:Networking_Functions#restartIrc|restartIrc()]]
  
−
: Returns a table of the details for each stopwatch in existence, the keys are the watch IDs but since there can be gaps in the ID number allocated for the stopwatches it will be necessary to use the ''pairs(...)'' rather than the ''ipairs(...)'' method to iterate through all of them in ''for'' loops!
+
;Parameters:
−
: Each stopwatch's details will list the following items: ''name'' (string), ''isRunning'' (boolean), ''isPersistent'' (boolean), ''elapsedTime'' (table).  The last of these contains the same data as is returned by the results table from the [[Manual:Lua_Functions#getStopWatchBrokenDownTime|getStopWatchBrokenDownTime()]] function - namely ''days'' (positive integer), ''hours'' (integer, 0 to 23), ''minutes'' (integer, 0 to 59), ''second'' (integer, 0 to 59), ''milliSeconds'' (integer, 0 to 999), ''negative'' (boolean) with an additional ''decimalSeconds'' (number of seconds, with a decimal portion for the milli-seconds and possibly a negative sign, representing the whole elapsed time recorded on the stopwatch) - as would also be returned by the [[Manual:Lua_Functions#getStopWatchTime|getStopWatchTime()]] function.
+
* ''hostname:''
−
 
+
: A string containing the hostname of the IRC server.
−
;Example
+
* ''port:''
−
<syntaxhighlight lang="lua">
+
: (optional) A number indicating the port of the IRC server. Defaults to 6667, if not provided.
−
-- on the command line:
+
* ''secure:''
−
lua getStopWatches()
+
: (optional) Boolean, true if server uses Transport Layer Security.  Defaults to false.
−
-- could return something like:
 
−
{
 
−
  {
 
−
    isPersistent = true,
 
−
    elapsedTime = {
 
−
      minutes = 15,
 
−
      seconds = 2,
 
−
      negative = false,
 
−
      milliSeconds = 66,
 
−
      hours = 0,
 
−
      days = 18,
 
−
      decimalSeconds = 1556102.066
 
−
    },
 
−
    name = "Playing time",
 
−
    isRunning = true
 
−
  },
 
−
  {
 
−
    isPersistent = true,
 
−
    elapsedTime = {
 
−
      minutes = 47,
 
−
      seconds = 1,
 
−
      negative = true,
 
−
      milliSeconds = 657,
 
−
      hours = 23,
 
−
      days = 2,
 
−
      decimalSeconds = -258421.657
 
−
    },
 
−
    name = "TMC Vote",
 
−
    isRunning = true
 
−
  },
 
−
  {
 
−
    isPersistent = false,
 
−
    elapsedTime = {
 
−
      minutes = 26,
 
−
      seconds = 36,
 
−
      negative = false,
 
−
      milliSeconds = 899,
 
−
      hours = 3,
 
−
      days = 0,
 
−
      decimalSeconds = 12396.899
 
−
    },
 
−
    name = "",
 
−
    isRunning = false
 
−
  },
 
−
  [5] = {
 
−
    isPersistent = false,
 
−
    elapsedTime = {
 
−
      minutes = 0,
 
−
      seconds = 38,
 
−
      negative = false,
 
−
      milliSeconds = 763,
 
−
      hours = 0,
 
−
      days = 0,
 
−
      decimalSeconds = 38.763
 
−
    },
 
−
    name = "",
 
−
    isRunning = true
 
−
  }
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
{{MudletVersion|4.4}}
 
−
 
 
−
==getStopWatchTime==
 
−
;time = getStopWatchTime(watchID [or watchName from Mudlet 4.4.0])
 
−
: Returns the time as a decimal number of seconds with up to three decimal places to give a milli-seconds (thousandths of a second) resolution.
 
−
: Please note that, prior to 4.4.0 it was not possible to retrieve the elapsed time after the stopwatch had been stopped, retrieving the time was not possible as the returned value then was an indeterminate, meaningless time; from the 4.4.0 release, however, the elapsed value can be retrieved at any time, even if the stopwatch has not been started since creation or modified with the [[Manual:Lua_Functions#adjustStopWatch|adjustStopWatch()]] function introduced in that release.
 
−
 
 
−
: See also: [[Manual:Lua_Functions#createStopWatch|createStopWatch()]], [[Manual:Lua_Functions#startStopWatch|startStopWatch()]], [[Manual:Lua_Functions#stopStopWatch|stopStopWatch()]], [[Manual:Lua_Functions#deleteStopWatch|deleteStopWatch()]], [[Manual:Lua_Functions#getStopWatch es|getStopWatches()]], [[Manual:Lua_Functions#getStopWatchBrokenDownTime|getStopWatchBrokenDownTime()]].
 
  
−
:Returns a number
+
{{MudletVersion|3.3}}
−
 
 
−
;Parameters
 
−
* ''watchID''
 
−
: The ID number of the watch.
 
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- an example of showing the time left on the stopwatch
+
setIrcServer("irc.libera.chat", 6667)
−
teststopwatch = teststopwatch or createStopWatch()
 
−
startStopWatch(teststopwatch)
 
−
echo("Time on stopwatch: "..getStopWatchTime(teststopwatch))
 
−
tempTimer(1, [[echo("Time on stopwatch: "..getStopWatchTime(teststopwatch))]])
 
−
tempTimer(2, [[echo("Time on stopwatch: "..getStopWatchTime(teststopwatch))]])
 
−
stopStopWatch(teststopwatch)
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==getStopWatchBrokenDownTime==
+
==getHTTP==
−
; brokenDownTimeTable = getStopWatchBrokenDownTime(watchID or watchName)
+
;getHTTP(url, headersTable)
−
: Returns the current stopwatch time, whether the stopwatch is running or is stopped, as a table, broken down into:
+
: Sends an [https://en.wikipedia.org/wiki/GET_(HTTP) HTTP GET] request to the given URL. Raises [[Manual:Event_Engine#sysGetHttpDone|sysGetHttpDone]] on success or [[Manual:Event_Engine#sysGetHttpError|sysGetHttpError]] on failure.
−
* "days" (integer)
+
:See also: [[#downloadFile|downloadFile()]].
−
* "hours" (integer, 0 to 23)
 
−
* "minutes" (integer, 0 to 59)
 
−
* "seconds" (integer, 0 to 59)
 
−
* "milliSeconds" (integer, 0 to 999)
 
−
* "negative" (boolean, true if value is less than zero)
 
  
−
: See also: [[Manual:Lua_Functions#startStopWatch|startStopWatch()]], [[Manual:Lua_Functions#stopStopWatch|stopStopWatch()]], [[Manual:Lua_Functions#deleteStopWatch|deleteStopWatch()]], [[Manual:Lua_Functions#getStopWatch es|getStopWatches()]], [[Manual:Lua_Functions#getStopWatchTime|getStopWatchTime()]].
+
[[File:Posthttp privacy logging.png.png|frame|For privacy transparency, URLs accessed are logged in the Central Debug Console]]
  
−
;Parameters
+
;Parameters:
−
* ''watchID'' / ''watchName''
+
* ''url:''
−
: The ID number or the name of the watch.
+
: Location to send the request to.
−
 
+
* ''headersTable:''
−
;Example
+
: (optional) table of headers to send with your request.
−
<syntaxhighlight lang="lua">
 
−
--an example, showing the presetting of a stopwatch.
 
−
 
 
−
--This will fail if the stopwatch with the given name
 
−
-- already exists, but then we can use the existing one:
 
−
local watchId = createStopWatch("TopMudSiteVoteStopWatch")
 
−
if watchId ~= nil then
 
−
  -- so we have just created the stopwatch, we want it
 
−
  -- to be saved for future sessions:
 
−
  setStopWatchPersistence("TopMudSiteVoteStopWatch", true)
 
−
  -- and set it to count down the 12 hours until we can
 
−
  -- revote:
 
−
  adjustStopWatch("TopMudSiteVoteStopWatch", -60*60*12)
 
−
  -- and start it running
 
−
  startStopWatch("TopMudSiteVoteStopWatch")
 
−
 
 
−
  openWebPage("http://www.topmudsites.com/vote-wotmud.html")
 
−
end
 
−
 
 
−
--[[ now I can check when it is time to vote again, even when
 
−
I stop the session and restart later by running the following
 
−
from a perm timer - perhaps on a 15 minute interval. Note that
 
−
when loaded in a new session the Id it gets is unlikely to be
 
−
the same as that when it was created - but that is not a
 
−
problem as the name is preserved and, if the timer is running
 
−
when the profile is saved at the end of the session then the
 
−
elapsed time will continue to increase to reflect the real-life
 
−
passage of time:]]
 
−
 
 
−
local voteTimeTable = getStopWatchBrokenDownTime("TopMudSiteVoteStopWatch")
 
−
 
 
−
if voteTimeTable["negative"] then
 
−
  if voteTimeTable["hours"] == 0 and voteTimeTable["minutes"] < 30 then
 
−
    echo("Voting for WotMUD on Top Mud Site in " .. voteTimeTable["minutes"] .. " minutes...")
 
−
  end
 
−
else
 
−
  echo("Oooh, it is " .. voteTimeTable["days"] .. " days, " .. voteTimeTable["hours"] .. " hours and " .. voteTimeTable["minutes"] .. " minutes past the time to Vote on Top Mud Site - doing it now!")
 
−
  openWebPage("http://www.topmudsites.com/vote-wotmud.html")
 
−
  resetStopWatch("TopMudSiteVoteStopWatch")
 
−
  adjustStopWatch("TopMudSiteVoteStopWatch", -60*60*12)
 
−
end
 
−
</syntaxhighlight>
 
−
 
 
−
{{MudletVersion|4.7}}
 
−
 
 
−
==getScript==
 
−
; getScript(scriptName, [occurrence])
 
−
: Returns the script with the given name. If you have more than one script with the same name, specify the occurrence to pick a different one. Returns -1 if the script doesn't exist.
 
−
 
 
−
: See also: [[Manual:Lua_Functions#permScript|permScript()]], [[Manual:Lua_Functions#enableScript|enableScript()]], [[Manual:Lua_Functions#disableScript|disableScript()]], [[Manual:Lua_Functions#setScript|setScript()]], [[Manual:Lua_Functions#appendScript|appendScript()]]
 
  
−
;Parameters
+
{{MudletVersion|4.10}}
−
* ''scriptName'': name of the script.
 
−
* ''occurrence'': (optional) occurence of the script in case you have many with the same name.
 
−
 
 
−
;Example
 
−
<syntaxhighlight lang="lua">
 
−
-- show the "New script" on screen
 
−
print(getScript("New script"))
 
−
 
 
−
-- an example of returning the script Lua code from the second occurrence of "testscript"
 
−
test_script_code = getScript("testscript", 2)
 
−
</syntaxhighlight>
 
−
 
 
−
{{MudletVersion|4.8}}
 
−
 
 
−
==invokeFileDialog==
 
−
;invokeFileDialog(fileOrFolder, dialogTitle)
 
−
:Opens a file chooser dialog, allowing the user to select a file or a folder visually. The function returns the selected path or "" if there was none chosen.
 
−
 
 
−
;Parameters
 
−
* ''fileOrFolder:'' ''true'' for file selection, ''false'' for folder selection.
 
−
* ''dialogTitle'': what to say in the window title.
 
  
 
;Examples
 
;Examples
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
function whereisit()
+
function onHttpGetDone(_, url, body)
−
  local path = invokeFileDialog(false, "Where should we save the file? Select a folder and click Open")
+
   cecho(string.format("<white>url: <dark_green>%s<white>, body: <dark_green>%s", url, body))
−
 
 
−
   if path == "" then return nil else return path end
 
−
end
 
−
</syntaxhighlight>
 
−
 
 
−
==isActive==
 
−
 
 
−
;isActive(name/IDnumber, type[, checkAncestors])
 
−
:You can use this function to check if something, or somethings, are active.
 
−
 
 
−
:Returns the number of active things - and 0 if none are active. Beware that all numbers are true in Lua, including zero.
 
−
 
 
−
;Parameters
 
−
* ''name:''
 
−
:The name (as a string) or, from '''Mudlet 4.17.0''', the ID number of a single item, (which will be that returned by a ''temp*'' or ''perm*'' function to create such an item to identify the item).
 
−
* ''type:''
 
−
:The type can be 'alias', 'button' (from '''Mudlet 4.10'''), 'trigger', 'timer', 'keybind' (from '''Mudlet 3.2'''), or 'script' (from '''Mudlet 3.17''').
 
−
* ''checkAncestors:''
 
−
:(Optional) If provided AND ''true'' (considered ''false'' if absent to reproduce behavior of previous versions of Mudlet) then this function will only count an item as active if it '''and''' all its parents (ancestors) are active (from '''Mudlet tbd''').
 
−
 
 
−
:See also: [[#exists|exists(...)]], [[#isAncestorsActive|isAncestorsActive(...)]], [[#ancestors|ancestors(...)]]
 
−
 
 
−
;Example
 
−
<syntaxhighlight lang="lua">
 
−
echo("I have " .. isActive("my trigger", "trigger") .. " currently active trigger(s) called 'my trigger'!")
 
−
 
 
−
-- Can also be used to check if a specific item is enabled or not.
 
−
if isActive("spellname", "trigger") > 0 then
 
−
  -- the spellname trigger is active
 
−
else
 
−
  -- it is not active
 
 
end
 
end
−
</syntaxhighlight>
 
−
 
−
{{note}} A positive ID number that does not exist will still return a ''0'' value, this is for constancy with the way the function behaves for a name that does not refer to any item either. If necessary the existence of an item should be confirmed with [[#exists|exists(...)]] first.
 
−
 
−
==isAncestorsActive==
 
−
 
−
;isAncestorsActive(IDnumber, "type")
 
−
:You can use this function to check if '''all''' the ancestors of something are active independent of whether it itself is, (for that use the two argument form of [[#isActive|isActive(...)]]).
 
−
 
−
:Returns ''true'' if all (if any) of the ancestors of the item with the specified ID number and type are active, if there are no such parents then it will also returns ''true''; otherwise returns ''false''. In the event that an invalid type string or item number is provided returns ''nil'' and an error message.
 
−
 
−
;Parameters
 
−
* ''IDnumber:''
 
−
:The ID number of a single item, (which will be that returned by a ''temp*'' or ''perm*'' function to create such an item to identify the item).
 
−
* ''type:''
 
−
:The type can be 'alias', 'button', 'trigger', 'timer', 'keybind' or 'script' to define which item type is to be checked.
 
−
 
−
:See also: [[#exists|exists(...)]]
 
−
 
−
;Example
 
−
<syntaxhighlight lang="lua">
 
−
-- To do
 
−
</syntaxhighlight>
 
−
 
−
==isPrompt==
 
−
;isPrompt()
 
−
:Returns true or false depending on if the line at the cursor position is a prompt. This infallible feature is available for games that supply GA events (to check if yours is one, look to bottom-right of the main window - if it doesn’t say <No GA>, then it supplies them).
 
−
 
−
:Example use could be as a Lua function, making closing gates on a prompt real easy.
 
−
 
−
;Example
 
−
<syntaxhighlight lang="lua">
 
−
-- make a trigger pattern with 'Lua function', and this will trigger on every prompt!
 
−
-- note that this is deprecated as we now have the prompt trigger type which does the same thing
 
−
-- the function can still be useful for detecting if you're running code on a prompt for other reasons
 
−
-- but you should be using a prompt trigger for this rather than a Lua function trigger.
 
−
return isPrompt()
 
−
</syntaxhighlight>
 
−
 
−
==killAlias==
 
−
;killAlias(aliasID)
 
−
:Deletes a temporary alias with the given ID.
 
−
 
−
;Parameters
 
−
* ''aliasID:''
 
−
: The id returned by [[Manual:Lua_Functions#tempAlias|tempAlias]] to identify the alias.
 
−
 
−
<syntaxhighlight lang="lua">
 
−
-- deletes the alias with ID 5
 
−
killAlias(5)
 
−
</syntaxhighlight>
 
−
 
−
==killKey==
 
−
;killKey(name)
 
−
:Deletes a keybinding with the given name. If several keybindings have this name, they'll all be deleted.
 
−
 
−
;Parameters
 
−
* ''name:''
 
−
: The name or the id returned by [[Manual:Lua_Functions#tempKey|tempKey]] to identify the key.
 
−
 
−
{{MudletVersion|3.2}}
 
  
−
<syntaxhighlight lang="lua">
+
registerAnonymousEventHandler("sysGetHttpDone", onHttpGetDone)
−
-- make a temp key
 
−
local keyid = tempKey(mudlet.key.F8, [[echo("hi!")]])
 
  
−
-- delete the said temp key
+
getHTTP("https://httpbin.org/info")
−
killKey(keyid)
+
getHTTP("https://httpbin.org/are_you_awesome", {["X-am-I-awesome"] = "yep I am"})
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==killTimer==
 
−
;killTimer(id)
 
−
:Deletes a [[Manual:Lua_Functions#tempTimer|tempTimer]].
 
−
 
−
{{note}} Non-temporary timers that you have set up in the GUI or by using [[#permTimer|permTimer]] cannot be deleted with this function. Use [[Manual:Lua_Functions#disableTimer|disableTimer()]] and [[Manual:Lua_Functions#enableTimer|enableTimer()]] to turn them on or off.
 
−
 
−
;Parameters
 
−
* ''id:'' the ID returned by [[Manual:Lua_Functions#tempTimer|tempTimer]].
 
−
 
−
: Returns true on success and false if the timer id doesn’t exist anymore (timer has already fired) or the timer is not a temp timer.
 
−
 
−
;Example
 
−
<syntaxhighlight lang="lua">
 
−
-- create the timer and remember the timer ID
 
−
timerID = tempTimer(10, [[echo("hello!")]])
 
−
 
−
-- delete the timer
 
−
killTimer(timerID)
 
−
-- reset the reference to it
 
−
timerID = nil
 
−
</syntaxhighlight>
 
−
 
−
==killTrigger==
 
−
;killTrigger(id)
 
−
:Deletes a [[Manual:Lua_Functions#tempTimer|tempTrigger]], or a trigger made with one of the ''temp<type>Trigger()'' functions.
 
−
 
−
{{note}} When used in out of trigger contexts, the triggers are disabled and deleted upon the next line received from the game - so if you are testing trigger deletion within an alias, the 'statistics' window will be reporting trigger counts that are disabled and pending removal, and thus are no cause for concern.
 
−
 
−
;Parameters
 
−
* ''id:''
 
−
: The ID returned by a ''temp<type>Trigger'' to identify the item. ID is a string and not a number.
 
−
 
−
:Returns true on success and false if the trigger id doesn’t exist anymore (trigger has already fired) or the trigger is not a temp trigger.
 
−
 
−
{{note}} As of Mudlet version 4.16.0, triggers created with [[#tempComplexRegexTrigger|tempComplexRegexTrigger]] can only be killed using the name string specified during creation.
 
−
 
−
==permAlias==
 
−
;permAlias(name, parent, regex, lua code)
 
−
 
−
:Creates a persistent alias that stays after Mudlet is restarted and shows up in the Script Editor.
 
−
 
−
;Parameters
 
−
* ''name:''
 
−
: The name you’d like the alias to have.
 
−
* ''parent:''
 
−
: The name of the group, or another alias you want the trigger to go in - however if such a group/alias doesn’t exist, it won’t do anything. Use "" to make it not go into any groups.
 
−
* ''regex:''
 
−
: The pattern that you’d like the alias to use.
 
−
* ''lua code:''
 
−
: The script the alias will do when it matches.
 
−
;Example
 
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- creates an alias called "new alias" in a group called "my group"
+
-- Status requests typically use GET requests
−
permAlias("new alias", "my group", "^test$", [[echo ("say it works! This alias will show up in the script editor too.")]])
+
local url = "http://postman-echo.com/status"
−
</syntaxhighlight>
+
local header = {["Content-Type"] = "application/json"}
−
 
 
−
{{note}} Mudlet by design allows duplicate names - so calling permAlias with the same name will keep creating new aliases. You can check if an alias already exists with the [[Manual:Lua_Functions#exists|exists]] function.
 
−
 
 
−
==permGroup==
 
−
;permGroup(name, itemtype, [parent])
 
  
−
:Creates a new group of a given type. This group will persist through Mudlet restarts.
+
-- first we create something to handle the success, and tell us what we got
−
;Parameters
+
registerAnonymousEventHandler('sysGetHttpDone', function(event, rurl, response)
−
* ''name'':
+
  if rurl == url then display(r) else return true end -- this will show us the response body, or if it's not the right url, then do not delete the handler
−
: The name of the new group item you want to create.
+
end, true) -- this sets it to delete itself after it fires
−
* ''itemtype'' :
+
-- then we create something to handle the error message, and tell us what went wrong
−
: The type of the item, can be one of the following:
+
registerAnonymousEventHandler('sysGetHttpError', function(event, response, rurl)
−
:: trigger
+
  if rurl == url then display(r) else return true end -- this will show us the response body, or if it's not the right url, then do not delete the handler
−
:: alias
+
end, true) -- this sets it to delete itself after it fires
−
:: timer
 
−
:: script (available in Mudlet 4.7+)
 
−
:: key (available in Mudlet 4.11+)
 
−
* ''parent'' (available in Mudlet 3.1+):
 
−
: (optional) Name of existing item which the new item will be created as a child of. If none is given, item will be at the root level (not nested in any other groups)
 
  
−
;Example
+
-- Lastly, we make the request:
−
<syntaxhighlight lang="lua">
+
getHTTP(url, header)
−
--create a new trigger group
 
−
permGroup("Combat triggers", "trigger")
 
  
−
--create a new alias group only if one doesn't exist already
+
-- Pop this into an alias and try it yourself!
−
if exists("Defensive aliases", "alias") == 0 then
 
−
  permGroup("Defensive aliases", "alias")
 
−
end
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==permPromptTrigger==
+
==postHTTP==
−
;permPromptTrigger(name, parent, lua code)
+
;postHTTP(dataToSend, url, headersTable, file)
−
:Creates a persistent trigger for the in-game prompt that stays after Mudlet is restarted and shows up in the Script Editor.
+
: Sends an [https://en.wikipedia.org/wiki/POST_(HTTP) HTTP POST] request to the given URL, either as text or with a specific file you'd like to upload. Raises [[Manual:Event_Engine#sysPostHttpDone|sysPostHttpDone]] on success or [[Manual:Event_Engine#sysPostHttpError|sysPostHttpError]] on failure.
 +
:See also: [[#downloadFile|downloadFile()]], [[#getHTTP|getHTTP()]], [[#putHTTP|putHTTP()]], [[#deleteHTTP|deleteHTTP()]].
  
−
{{note}} If the trigger is not working, check that the '''N:''' bottom-right has a number. This feature requires telnet Go-Ahead (GA) or End-of-Record (EOR) to be enabled in your game. Available in Mudlet 3.6+
+
[[File:Posthttp privacy logging.png.png|frame|For privacy transparency, URLs accessed are logged in the Central Debug Console]]
  
 
;Parameters:
 
;Parameters:
−
* ''name'' is the name you’d like the trigger to have.
+
* ''dataToSend:''
−
* ''parent'' is the name of the group, or another trigger you want the trigger to go in - however if such a group/trigger doesn’t exist, it won’t do anything. Use "" to make it not go into any groups.
+
: Text to send in the request (unless you provide a file to upload).
−
* ''lua code'' is the script the trigger will do when it matches.
+
* ''url:''
−
 
+
: Location to send the request to.
−
;Example:  
+
* ''headersTable:''
−
<syntaxhighlight lang="lua">
+
: (optional) table of headers to send with your request.
−
permPromptTrigger("echo on prompt", "", [[echo("hey! this thing is working!\n")]])
+
* ''file:''
−
</syntaxhighlight>
+
: (optional) file to upload as part of the POST request. If provided, this will replace 'dataToSend'.
−
 
+
: If you use a scripting language (ex. PHP) to handle this post, remember that the file is sent as raw data. Expecially no field name is provided, dispite it works in common html post.
−
 
 
−
==permRegexTrigger==
 
−
;permRegexTrigger(name, parent, pattern table, lua code)
 
−
:Creates a persistent trigger with one or more ''regex'' patterns that stays after Mudlet is restarted and shows up in the Script Editor.
 
−
 
 
−
;Parameters
 
−
* ''name'' is the name you’d like the trigger to have.
 
−
* ''parent'' is the name of the group, or another trigger you want the trigger to go in - however if such a group/trigger doesn’t exist, it won’t do anything. Use "" to make it not go into any groups.
 
−
* ''pattern table'' is a table of patterns that you’d like the trigger to use - it can be one or many.
 
−
* ''lua code'' is the script the trigger will do when it matches.
 
−
;Example
 
−
<syntaxhighlight lang="lua">
 
−
-- Create a regex trigger that will match on the prompt to record your status
 
−
permRegexTrigger("Prompt", "", {"^(\d+)h, (\d+)m"}, [[health = tonumber(matches[2]); mana = tonumber(matches[3])]])
 
−
</syntaxhighlight>
 
−
{{note}} Mudlet by design allows duplicate names - so calling permRegexTrigger with the same name will keep creating new triggers. You can check if a trigger already exists with the [[Manual:Lua_Functions#exists|exists()]] function.
 
−
 
 
−
==permBeginOfLineStringTrigger==
 
−
;permBeginOfLineStringTrigger(name, parent, pattern table, lua code)
 
−
:Creates a persistent trigger that stays after Mudlet is restarted and shows up in the Script Editor. The trigger will go off whenever one of the ''regex'' patterns it's provided with matches. The function returns the trigger ID for subsequent [[Manual:Lua_Functions#enableTrigger|enableTrigger()]], [[Manual:Lua_Functions#disableTrigger|disableTrigger()]] and [[Manual:Lua_Functions#killTrigger|killTrigger()]] calls.
 
  
−
;Parameters
+
{{MudletVersion|4.1}}
−
* ''name'' is the name you’d like the trigger to have.
 
−
* ''parent'' is the name of the group, or another trigger you want the trigger to go in - however if such a group/trigger doesn’t exist, it won’t do anything. Use "" to make it not go into any groups.
 
−
* ''pattern table'' is a table of patterns that you’d like the trigger to use - it can be one or many.
 
−
* ''lua code'' is the script the trigger will do when it matches.
 
  
 
;Examples
 
;Examples
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- Create a trigger that will match on anything that starts with "You sit" and do "stand".
+
function onHttpPostDone(_, url, body)
−
-- It will not go into any groups, so it'll be on the top.
+
  cecho(string.format("<white>url: <dark_green>%s<white>, body: <dark_green>%s", url, body))
−
permBeginOfLineStringTrigger("Stand up", "", {"You sit"}, [[send ("stand")]])
+
end
−
 
 
−
-- Another example - lets put our trigger into a "General" folder and give it several patterns.
 
−
permBeginOfLineStringTrigger("Stand up", "General", {"You sit", "You fall", "You are knocked over by"}, [[send ("stand")]])
 
−
</syntaxhighlight>
 
−
{{note}} Mudlet by design allows duplicate names - so calling permBeginOfLineStringTrigger with the same name will keep creating new triggers. You can check if a trigger already exists with the [[Manual:Lua_Functions#exists|exists()]] function.
 
  
−
==permSubstringTrigger==
+
registerAnonymousEventHandler("sysPostHttpDone", onHttpPostDone)
−
;permSubstringTrigger( name, parent, pattern table, lua code )
 
−
:Creates a persistent trigger with one or more ''substring'' patterns that stays after Mudlet is restarted and shows up in the Script Editor.
 
−
;Parameters
 
−
* ''name'' is the name you’d like the trigger to have.
 
−
* ''parent'' is the name of the group, or another trigger you want the trigger to go in - however if such a group/trigger doesn’t exist, it won’t do anything. Use "" to make it not go into any groups.
 
−
* ''pattern table'' is a table of patterns that you’d like the trigger to use - it can be one or many.
 
−
* ''lua code'' is the script the trigger will do when it matches.
 
−
;Example
 
−
<syntaxhighlight lang="lua">
 
−
-- Create a trigger to highlight the word "pixie" for us
 
−
permSubstringTrigger("Highlight stuff", "General", {"pixie"},
 
−
[[selectString(line, 1) bg("yellow") resetFormat()]])
 
  
−
-- Or another trigger to highlight several different things
+
postHTTP("why hello there!", "https://httpbin.org/post")
−
permSubstringTrigger("Highlight stuff", "General", {"pixie", "cat", "dog", "rabbit"},
+
postHTTP("this us a request with custom headers", "https://httpbin.org/post", {["X-am-I-awesome"] = "yep I am"})
−
[[selectString(line, 1) fg ("blue") bg("yellow") resetFormat()]])
+
postHTTP(nil, "https://httpbin.org/post", {}, "<fill in file location to upload here, maybe get from invokeDialog>")
 
</syntaxhighlight>
 
</syntaxhighlight>
−
{{note}} Mudlet by design allows duplicate names - so calling permSubstringTrigger with the same name will keep creating new triggers. You can check if a trigger already exists with the [[Manual:Lua_Functions#exists|exists()]] function.
 
  
−
==permScript==
 
−
;permScript(name, parent, lua code)
 
−
: Creates a new script in the Script Editor that stays after Mudlet is restarted.
 
−
 
−
;Parameters
 
−
* ''name'': name of the script.
 
−
* ''parent'': name of the script group you want the script to go in.
 
−
* ''lua code'': is the code with string you are putting in your script.
 
−
 
−
;Returns
 
−
* a unique id number for that script.
 
−
 
−
: See also: [[#enableScript|enableScript()]], [[#exists|exists()]], [[#appendScript|appendScript()]], [[#disableScript|disableScript()]], [[#getScript|getScript()]], [[#setScript|setScript()]]
 
−
 
−
;Example:
 
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- create a script in the "first script group" group
+
-- This will create a JSON message body. Many modern REST APIs expect a JSON body.
−
permScript("my script", "first script group", [[send ("my script that's in my first script group fired!")]])
+
local url = "http://postman-echo.com/post"
−
-- create a script that's not in any group; just at the top
+
local data = {message = "I am the banana", user = "admin"}
−
permScript("my script", "", [[send ("my script that's in my first script group fired!")]])
+
local header = {["Content-Type"] = "application/json"}
  
−
-- enable Script - a script element is disabled at creation
+
-- first we create something to handle the success, and tell us what we got
−
enableScript("my script")
+
registerAnonymousEventHandler('sysPostHttpDone', function(event, rurl, response)
−
</syntaxhighlight>
+
  if rurl == url then display(response) else return true end -- this will show us the response body, or if it's not the right url, then do not delete the handler
 +
end, true) -- this sets it to delete itself after it fires
  
−
{{note}} The script is called once but NOT active after creation, it will need to be enabled by [[#enableScript|enableScript()]].
+
-- then we create something to handle the error message, and tell us what went wrong
 +
registerAnonymousEventHandler('sysPostHttpError', function(event, response, rurl)
 +
  if rurl == url then display(response) else return true end -- this will show us the response body, or if it's not the right url, then do not delete the handler
 +
end, true) -- this sets it to delete itself after it fires
  
−
{{note}} Mudlet by design allows duplicate names - so calling permScript with the same name will keep creating new script elements. You can check if a script already exists with the [[Manual:Lua_Functions#exists|exists()]] function.
+
-- Lastly, we make the request:
 +
postHTTP(yajl.to_string(data), url, header) -- yajl.to_string converts our Lua table into a JSON-like string so the server can understand it
  
−
{{note}} If the ''lua code'' parameter is an empty string, then the function will create a script group instead.
+
-- Pop this into an alias and try it yourself!
−
 
 
−
 
 
−
{{MudletVersion|4.8}}
 
−
 
 
−
==permTimer==
 
−
;permTimer(name, parent, seconds, lua code)
 
−
: Creates a persistent timer that stays after Mudlet is restarted and shows up in the Script Editor.
 
−
 
 
−
;Parameters
 
−
* ''name''
 
−
:name of the timer.
 
−
* ''parent''
 
−
:name of the timer group you want the timer to go in.
 
−
* ''seconds''
 
−
:a floating point number specifying a delay in seconds after which the timer will do the lua code (stored as the timer's "script") you give it as a string.
 
−
* ''lua code'' is the code with string you are doing this to.
 
−
 
 
−
;Returns
 
−
* a unique id number for that timer.
 
−
 
 
−
;Example:
 
−
<syntaxhighlight lang="lua">
 
−
-- create a timer in the "first timer group" group
 
−
permTimer("my timer", "first timer group", 4.5, [[send ("my timer that's in my first timer group fired!")]])
 
−
-- create a timer that's not in any group; just at the top
 
−
permTimer("my timer", "", 4.5, [[send ("my timer that's in my first timer group fired!")]])
 
−
 
 
−
-- enable timer - they start off disabled until you're ready
 
−
enableTimer("my timer")
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
{{note}} The timer is NOT active after creation, it will need to be enabled by a call to [[#enableTimer|enableTimer()]] before it starts.
+
;HTTP Basic Authentication Example:
 +
If your HTTP endpoint requires authentication to post data, HTTP Basic Authentication is a common method for doing so. There are two ways to do so.
  
−
{{note}} Mudlet by design allows duplicate names - so calling permTimer with the same name will keep creating new timers. You can check if a timer already exists with the [[Manual:Lua_Functions#exists|exists()]] function.
+
OPTION 1: URL encoding:
 +
Many HTTP servers allow you to enter a HTTP Basic Authentication username and password at the beginning of the URL itself, in format:
 +
https://username:password@domain.com/path/to/endpoint
  
−
==permKey==
+
OPTION 2: Authorization Header:
−
;permKey(name, parent, [modifier], key code, lua code)
+
Some HTTP servers may require you to put your Basic Authentication into the 'Authorization' HTTP header value.
−
: Creates a persistent key that stays after Mudlet is restarted and shows up in the Script Editor.
 
  
−
;Parameters
+
This requires encoding the username:password into base64.
−
* ''name''
+
For example, if your username is 'user' and your password is '12345', you'd need to run the string "user:12345" through a base64 encoder, which would result in the string:
−
:name of the key.
+
dXNlcjoxMjM0NQ==
−
* ''parent''
 
−
:name of the timer group you want the timer to go in or "" for the top level.
 
−
* ''modifier''
 
−
:(optional) modifier to use - can be one of ''mudlet.keymodifier.Control'', ''mudlet.keymodifier.Alt'', ''mudlet.keymodifier.Shift'', ''mudlet.keymodifier.Meta'', ''mudlet.keymodifier.Keypad'', or ''mudlet.keymodifier.GroupSwitch'' or the default value of ''mudlet.keymodifier.None'' which is used if the argument is omitted. To use multiple modifiers, add them together: ''(mudlet.keymodifier.Shift + mudlet.keymodifier.Control)''
 
−
* ''key code''
 
−
: actual key to use - one of the values available in ''mudlet.key'', e.g. ''mudlet.key.Escape'', ''mudlet.key.Tab'', ''mudlet.key.F1'', ''mudlet.key.A'', and so on. The list is a bit long to list out in full so it is [https://github.com/Mudlet/Mudlet/blob/development/src/mudlet-lua/lua/KeyCodes.lua#L2 available here].
 
−
: set to -1 if you want to create a key folder instead.
 
−
* ''lua code'
 
−
: code you would like the key to run.
 
  
−
;Returns
+
Then, you'd need to set the HTTP header 'Authorization' field value to indicate it is using Basic auth and inserting the base64 string as:
−
* a unique id number for that key.
+
['Authorization'] = "Basic dXNlcjoxMjM0NQ=="
  
−
{{MudletVersion|3.2+, creating key folders in Mudlet 4.10}}
+
As you're encoding your username and password, you probably want to do this encoding locally for security reasons. You also probably want to only use https:// and not http:// when sending usernames and passwords over the internet.
  
−
;Example:
+
In the HTTP Basic Authentication example below, there is an inline base64Encode() function included:
−
<syntaxhighlight lang="lua">
 
−
-- create a key at the top level for F8
 
−
permKey("my key", "", mudlet.key.F8, [[echo("hey this thing actually works!\n")]])
 
−
 
 
−
-- or Ctrl+F8
 
−
permKey("my key", "", mudlet.keymodifier.Control, mudlet.key.F8, [[echo("hey this thing actually works!\n")]])
 
−
 
 
−
-- Ctrl+Shift+W
 
−
permKey("jump keybinding", "", mudlet.keymodifier.Control + mudlet.keymodifier.Shift, mudlet.key.W, [[send("jump")]])
 
−
</syntaxhighlight>
 
−
 
 
−
{{note}} Mudlet by design allows duplicate names - so calling permKey with the same name will keep creating new keys. You can check if a key already exists with the [[Manual:Lua_Functions#exists|exists()]] function.  The key will be created even if the lua code does not compile correctly - but this will be apparent as it will be seen in the Editor.
 
−
 
 
−
==printCmdLine==
 
−
;printCmdLine([name], text)
 
−
 
 
−
: Replaces the current text in the input line, and sets it to the given text.
 
−
: See also: [[Manual:Lua_Functions#clearCmdLine|clearCmdLine()]], [[#appendCmdLine|appendCmdLine()]]
 
−
 
 
−
;Parameters
 
−
* ''name'': (optional) name of the command line. If not given, main commandline's text will be set.
 
−
* ''text'': text to set
 
  
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
printCmdLine("say I'd like to buy ")
+
function base64Encode(data)
−
</syntaxhighlight>
+
  -- Lua 5.1+ base64 v3.0 (c) 2009 by Alex Kloss <[email protected]>
 +
  -- licensed under the terms of the LGPL2
 +
  local b = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/'
 +
    return ((data:gsub('.', function(x)
 +
        local r,b='',x:byte()
 +
        for i=8,1,-1 do r=r..(b%2^i-b%2^(i-1)>0 and '1' or '0') end
 +
        return r;
 +
    end)..'0000'):gsub('%d%d%d?%d?%d?%d?', function(x)
 +
        if (#x < 6) then return '' end
 +
        local c=0
 +
        for i=1,6 do c=c+(x:sub(i,i)=='1' and 2^(6-i) or 0) end
 +
        return b:sub(c+1,c+1)
 +
    end)..({ '', '==', '=' })[#data%3+1])
 +
end
 +
-- Example: base64Encode("user:12345") -> dXNlcjoxMjM0NQ==
  
−
==raiseEvent==
+
function postJSON(url,dataTable,headerTable)
−
;raiseEvent(event_name, arg-1, … arg-n)
+
  -- This will create a JSON message body. Many modern REST APIs expect a JSON body.
 +
  local data = dataTable or {text = "hello world"}
 +
  local header = headerTable or {["Content-Type"] = "application/json"}
 +
  -- first we create something to handle the success, and tell us what we got
 +
  registerAnonymousEventHandler('sysPostHttpDone', function(event, rurl, response)
 +
    if rurl == url then sL("HTTP response success"); echo(response) else return true end -- this will show us the response body, or if it's not the right url, then do not delete the handler
 +
  end, true) -- this sets it to delete itself after it fires
 +
  -- then we create something to handle the error message, and tell us what went wrong
 +
  registerAnonymousEventHandler('sysPostHttpError', function(event, response, rurl)
 +
    if rurl == url then sL("HTTP response error",3); echo(response) else return true end -- this will show us the response body, or if it's not the right url, then do not delete the handler
 +
  end, true) -- this sets it to delete itself after it fires
 +
  -- Lastly, we make the request:
 +
  postHTTP(yajl.to_string(data), url, header) -- yajl.to_string converts our Lua table into a JSON-like string so the server can understand it
 +
end
  
−
: Raises the event event_name. The event system will call the main function (the one that is called exactly like the script name) of all such scripts in this profile that have registered event handlers. If an event is raised, but no event handler scripts have been registered with the event system, the event is ignored and nothing happens. This is convenient as you can raise events in your triggers, timers, scripts etc. without having to care if the actual event handling has been implemented yet - or more specifically how it is implemented. Your triggers raise an event to tell the system that they have detected a certain condition to be true or that a certain event has happened. How - and if - the system is going to respond to this event is up to the system and your trigger scripts don’t have to care about such details. For small systems it will be more convenient to use regular function calls instead of events, however, the more complicated your system will get, the more important events will become because they help reduce complexity very much.
+
data = {
−
 
+
    message = "I am the banana",
−
:The corresponding event handlers that listen to the events raised with raiseEvent() need to use the script name as function name and take the correct number of arguments.
+
    user = "admin"
−
 
+
}
−
:See also: [[#raiseGlobalEvent|raiseGlobalEvent]]
+
header = {
−
 
+
    ["Content-Type"] = "application/json",
−
{{note}} possible arguments can be string, number, boolean, table, function, or nil.
+
    ["Authorization"] = "Basic " .. base64Encode("user:12345")
−
 
+
}
−
;Example:
+
postJSON("http://postman-echo.com/post",data,header)
−
 
 
−
:raiseEvent("fight") a correct event handler function would be: myScript( event_name ). In this example raiseEvent uses minimal arguments, name the event name. There can only be one event handler function per script, but a script can still handle multiple events as the first argument is always the event name - so you can call your own special handlers for individual events. The reason behind this is that you should rather use many individual scripts instead of one huge script that has all your function code etc. Scripts can be organized very well in trees and thus help reduce complexity on large systems.
 
−
 
 
−
Where the number of arguments that your event may receive is not fixed you can use [http://www.lua.org/manual/5.1/manual.html#2.5.9 ''...''] as the last argument in the ''function'' declaration to handle any number of arguments. For example:
 
−
 
 
−
<syntaxhighlight lang="lua">
 
−
-- try this function out with "lua myscripthandler(1,2,3,4)"
 
−
function myscripthandler(a, b, ...)
 
−
  print("Arguments a and b are: ", a,b)
 
−
  -- save the rest of the arguments into a table
 
−
  local otherarguments = {...}
 
−
  print("Rest of the arguments are:")
 
−
  display(otherarguments)
 
−
 
 
−
  -- access specific otherarguments:
 
−
  print("First and second otherarguments are: ", otherarguments[1], otherarguments[2])
 
−
end
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==raiseGlobalEvent==
+
;URL Encoding vs JSON encoding
−
;raiseGlobalEvent(event_name, arg-1, … arg-n)
+
Some HTTP endpoints may not support JSON encoding, and instead may require URL encoding. Here's an example function to convert your lua data table into a URL encoded string::
−
 
 
−
: Like [[Manual:Lua_Functions#raiseEvent|raiseEvent()]] this raises the event "event_name", but this event is sent to all '''other''' opened profiles instead. The profiles receive the event in circular alphabetical order (if profile "C" raised this event and we have profiles "A", "C", and "E", the order is "E" -> "A", but if "E" raised the event the order would be "A" -> "C"); execution control is handed to the receiving profiles so that means that long running events may lock up the profile that raised the event.
 
−
 
 
−
: The sending profile's name is automatically appended as the last argument to the event.
 
−
 
 
−
{{note}} possible arguments can be string, number, boolean, or nil, but not table or function.
 
−
 
 
−
;Example:
 
−
 
 
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- from profile called "My game" this raises an event "my event" with additional arguments 1, 2, 3, "My game" to all profiles except the original one
+
-- Example: URLEncodeTable({message="hello",person="world"}) -> "message=hello&person=world"
−
raiseGlobalEvent("my event", 1, 2, 3)
 
  
−
-- want the current profile to receive it as well? Use raiseEvent
+
function URLEncodeTable(Args)
−
raiseEvent("my event", 1, 2, 3)
+
  -- From: https://help.interfaceware.com/code/details/urlcode-lua
−
</syntaxhighlight>
+
  ----------------------------------------------------------------------------
−
 
+
  -- URL-encode the elements of a table creating a string to be used in a
−
<syntaxhighlight lang="lua>
+
  -- URL for passing data/parameters to another script
−
-- example of calling functions in one profile from another:
+
  -- @param args Table where to extract the pairs (name=value).
−
-- profile B:
+
  -- @return String with the resulting encoding.
−
control = control or {}
+
  ----------------------------------------------------------------------------
−
function control.updateStatus()
+
  --
−
   disableTrigger("test triggers")
+
  local ipairs, next, pairs, tonumber, type = ipairs, next, pairs, tonumber, type
−
  print("disabling triggers worked!")
+
  local string = string
−
end
+
  local table = table
−
 
+
 
−
-- this handles calling the right function in the control table
+
  --helper functions:  
−
function control.marshaller(_, callfunction)
+
  ----------------------------------------------------------------------------
−
  if control[callfunction] then control[callfunction]()
+
  -- Decode an URL-encoded string (see RFC 2396)
−
   else
+
  ----------------------------------------------------------------------------
−
     cecho("<red>Asked to call an unknown function: "..callfunction)
+
  local unescape = function (str)
 +
    str = string.gsub (str, "+", " ")
 +
    str = string.gsub (str, "%%(%x%x)", function(h) return string.char(tonumber(h,16)) end)
 +
    return str
 +
   end
 +
 
 +
  ----------------------------------------------------------------------------
 +
  -- URL-encode a string (see RFC 2396)
 +
  ----------------------------------------------------------------------------
 +
  local escape = function (str)
 +
    str = string.gsub (str, "([^0-9a-zA-Z !'()*._~-])", -- locale independent
 +
        function (c) return string.format ("%%%02X", string.byte(c)) end)
 +
    str = string.gsub (str, " ", "+")
 +
    return str
 +
  end
 +
 
 +
  ----------------------------------------------------------------------------
 +
  -- Insert a (name=value) pair into table [[args]]
 +
  -- @param args Table to receive the result.
 +
  -- @param name Key for the table.
 +
  -- @param value Value for the key.
 +
  -- Multi-valued names will be represented as tables with numerical indexes
 +
  -- (in the order they came).
 +
  ----------------------------------------------------------------------------
 +
  local insertfield = function (args, name, value)
 +
    if not args[name] then
 +
        args[name] = value
 +
    else
 +
        local t = type (args[name])
 +
        if t == "string" then
 +
          args[name] = {args[name],value,}
 +
        elseif t == "table" then
 +
          table.insert (args[name], value)
 +
        else
 +
          error ("CGILua fatal error (invalid args table)!")
 +
        end
 +
    end
 +
  end
 +
   -- end helper functions
 +
   
 +
  if Args == nil or next(Args) == nil then -- no args or empty args?
 +
    return ""
 +
  end
 +
  local strp = ""
 +
  for key, vals in pairs(Args) do
 +
    if type(vals) ~= "table" then
 +
      vals = {vals}
 +
    end
 +
     for i,val in ipairs(vals) do
 +
      strp = strp.."&"..key.."="..escape(val)
 +
    end
 
   end
 
   end
 +
  -- remove first &
 +
  return string.sub(strp,2)
 
end
 
end
−
 
−
registerAnonymousEventHandler("sysSendAllProfiles", "control.marshaller")
 
−
 
−
-- profile A:
 
−
raiseGlobalEvent("sysSendAllProfiles", "updateStatus")
 
−
raiseGlobalEvent("sysSendAllProfiles", "invalidfunction")
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
{{MudletVersion|3.1.0}}
+
==putHTTP==
 +
;putHTTP(dataToSend, url, [headersTable], [file])
 +
: Sends an [https://en.wikipedia.org/wiki/PUT_(HTTP) HTTP PUT] request to the given URL, either as text or with a specific file you'd like to upload. Raises [[Manual:Event_Engine#sysPutHttpDone|sysPutHttpDone]] on success or [[Manual:Event_Engine#sysPutHttpError|sysPutHttpError]] on failure.
 +
:See also: [[#downloadFile|downloadFile()]], [[#getHTTP|getHTTP()]], [[#postHTTP|postHTTP()]], [[#deleteHTTP|deleteHTTP()]].
  
−
Tip: you might want to add the [[Manual:Miscellaneous_Functions#getProfileName|profile name]] to your plain [[Manual:Miscellaneous_Functions#raiseEvent|raiseEvent()]] arguments. This'll help you tell which profile your event came from similar to [[#raiseGlobalEvent|raiseGlobalEvent()]].
+
[[File:PutHTTP privacy logging.png|frame|For privacy transparency, URLs accessed are logged in the Central Debug Console]]
  
−
==registerNamedTimer==
+
;Parameters:
−
; success = registerNamedTimer(userName, timerName, time, functionReference, [repeating])
+
* ''dataToSend:''
 +
: Text to send in the request (unless you provide a file to upload).
 +
* ''url:''
 +
: Location to send the request to.
 +
* ''headersTable:''
 +
: (optional) table of headers to send with your request.
 +
* ''file:''
 +
: (optional) file to upload as part of the PUT request. If provided, this will replace 'dataToSend'.
  
−
:Registers a named timer with name timerName. Named timers are protected from duplication and can be stopped and resumed, unlike normal tempTimers. A separate list is kept for each userName, to enforce name spacing and avoid collisions
+
{{MudletVersion|4.1}}
−
 
 
−
;See also: [[Manual:Lua_Functions#tempTimer|tempTimer()]], [[Manual:Lua_Functions#stopNamedTimer|stopNamedTimer()]], [[Manual:Lua_Functions#resumeNamedTimer|resumeNamedTimer()]], [[Manual:Lua_Functions#deleteNamedTimer|deleteNamedTimer()]], [[Manual:Lua_Functions#registerNamedEventHandler|registerNamedEventHandler()]]
 
−
 
 
−
{{MudletVersion|4.14}}
 
−
 
 
−
;Parameters
 
−
* ''userName:''
 
−
: The user name the event handler was registered under.
 
−
* ''timerName:''
 
−
: The name of the handler. Used to reference the handler in other functions and prevent duplicates. Recommended you use descriptive names, "hp" is likely to collide with something else, "DemonVitals" less so.
 
−
* ''time:''
 
−
: The amount of time in seconds to wait before firing.
 
−
* ''functionReference:''
 
−
: The function reference to run when the event comes in. Can be the name of a function, "handlerFunction", or the lua function itself.
 
−
* ''repeating:''
 
−
: (optional) if true, the timer continue to fire until the stop it using [[Manual:Lua_Functions#stopNamedTimer|stopNamedTimer()]]
 
−
;Returns
 
−
* true if successful, otherwise errors.
 
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- establish a named timer called "Check balance" which runs balanceChecker() after 1 second
+
function onHttpPutDone(_, url, body)
−
-- it is started automatically when registered, and fires only once despite being run twice
+
  cecho(string.format("<white>url: <dark_green>%s<white>, body: <dark_green>%s", url, body))
−
-- you wouldn't do this intentionally, but illustrates the duplicate protection
+
end
−
registerNamedTimer("Demonnic", "Check Balance", 1, balanceChecker)
 
−
registerNamedTimer("Demonnic", "Check Balance", 1, balanceChecker)
 
  
−
-- then the next time you want to make/use the same timer, you can shortcut it with
+
registerAnonymousEventHandler("sysPutHttpDone", onHttpPutDone)
−
resumeNamedTimer("Demonnic", "Check Balance")
+
putHTTP("this us a request with custom headers", "https://httpbin.org/put", {["X-am-I-awesome"] = "yep I am"})
 +
putHTTP("https://httpbin.org/put", "<fill in file location to upload here>")
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==remainingTime==
+
==deleteHTTP==
−
;remainingTime(timer id number or name)
+
;deleteHTTP(url, headersTable)
 +
: Sends an [https://en.wikipedia.org/wiki/DELETE_(HTTP) HTTP DELETE] request to the given URL. Raises [[Manual:Event_Engine#sysDeleteHttpDone|sysDeleteHttpDone]] on success or [[Manual:Event_Engine#sysDeleteHttpError|sysDeleteHttpError]] on failure.
 +
:See also: [[#downloadFile|downloadFile()]], [[#getHTTP|getHTTP()]], [[#postHTTP|postHTTP()]], [[#putHTTP|putHTTP()]].
  
−
: Returns the remaining time in floating point form in seconds (if it is active) for the timer (temporary or permanent) with the id number or the (first) one found with the name.
+
[[File:PutHTTP privacy logging.png|frame|For privacy transparency, URLs accessed are logged in the Central Debug Console]]
−
: If the timer is inactive or has expired or is not found it will return a ''nil'' and an ''error message''. It, theoretically could also return 0 if the timer is overdue, i.e. it has expired but the internal code has not yet been run but that has not been seen in during testing. Permanent ''offset timers'' will only show as active during the period when they are running after their parent has expired and started them.
 
  
−
{{MudletVersion|3.20}}
+
;Parameters:
−
 
+
* ''url:''
−
;Example:
+
: Location to send the request to.
−
 
+
* ''headersTable:''
−
<syntaxhighlight lang="lua">
+
: (optional) table of headers to send with your request.
−
tid = tempTimer(600, [[echo("\nYour ten minutes are up.\n")]])
 
−
echo("\nYou have " .. remainingTime(tid) .. " seconds left, use it wisely... \n")
 
−
 
 
−
-- Will produce something like:
 
−
 
 
−
You have 599.923 seconds left, use it wisely...
 
−
 
 
−
-- Then ten minutes time later:
 
−
 
 
−
Your ten minutes are up.
 
−
 
 
−
</syntaxhighlight>
 
−
 
 
−
==resetProfileIcon==
 
−
;resetProfileIcon()
 
−
: Resets the profile's icon in the connection screen to default.
 
−
 
 
−
See also: [[#setProfileIcon|setProfileIcon()]].
 
−
 
 
−
{{MudletVersion|4.0}}
 
−
 
 
−
;Example:
 
−
 
 
−
<syntaxhighlight lang="lua">
 
−
resetProfileIcon()
 
−
</syntaxhighlight>
 
−
 
 
−
==resetStopWatch==
 
−
;resetStopWatch(watchID)
 
−
:This function resets the time to 0:0:0.0, but does not stop or start the stop watch. You can stop it with [[Manual:Lua_Functions#stopStopWatch | stopStopWatch]] or start it with [[Manual:Lua_Functions#startStopWatch | startStopWatch]] → [[Manual:Lua_Functions#createStopWatch | createStopWatch]]
 
−
 
 
−
==resumeNamedTimer==
 
−
; success = resumeNamedTimer(userName, handlerName)
 
−
 
 
−
:Resumes a named timer with name handlerName and causes it to fire again. One time unless it was registered as repeating.
 
−
 
 
−
;See also: [[Manual:Lua_Functions#registerNamedTimer|registerNamedTimer()]], [[Manual:Lua_Functions#stopNamedTimer|stopNamedTimer()]]
 
−
 
 
−
{{MudletVersion|4.14}}
 
  
−
;Parameter
+
{{MudletVersion|4.1}}
−
* ''userName:''
 
−
: The user name the event handler was registered under.s
 
−
* ''handlerName:''
 
−
: The name of the handler to resume. Same as used when you called [[Manual:Lua_Functions#registerNamedTimer|registerNamedTimer()]]
 
−
 
 
−
;Returns
 
−
* true if successful, false if it didn't exist. If the timer is waiting to fire it will be restarted at 0.
 
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
local resumed = resumeNamedTimer("Demonnic", "DemonVitals")
+
function onHttpDeleteDone(_, url, body)
−
if resumed then
+
   cecho(string.format("<white>url: <dark_green>%s<white>, body: <dark_green>%s", url, body))
−
   cecho("DemonVitals resumed!")
 
−
else
 
−
  cecho("DemonVitals doesn't exist, so cannot resume it.")
 
 
end
 
end
−
</syntaxhighlight>
 
  
−
==setButtonState==
+
registerAnonymousEventHandler("sysDeleteHttpDone", onHttpDeleteDone)
−
;setButtonState(ButtonNameOrID, checked)
 
−
:Sets the state of a check-able ("push-down") type button from any Mudlet item's script - but does not cause the script or one of the commands associated with that button to be run/sent.
 
−
: See also: [[#getButtonState|getButtonState()]].
 
−
{{MudletVersion|4.13}}
 
  
−
;Parameters
+
deleteHTTP("https://httpbin.org/delete")
−
* ''ButtonNameOrID:''
+
deleteHTTP("https://httpbin.org/delete", {["X-am-I-awesome"] = "yep I am"})
−
: The name of the button as a string or a unique ID (positive) integer number {for a name only one matching one will be affected - it will be the same one that the matching [[#getButtonState|getButtonState()]] reports upon}.
 
−
* ''checked:''
 
−
: boolean value that indicated whether the state required is down (''true'') or up (''false'').
 
−
 
 
−
;Returns:
 
−
* A boolean value indicating ''true'' if the visible state was actually changed, i.e. had any effect. This function will return a ''nil'' and a suitable error message if the identifying name or ID was not found or was not a check-able (push-down) button item (i.e. was a non-checkable button or a menu or a toolbar instead).
 
−
 
 
−
;Example
 
−
<syntaxhighlight lang="lua">
 
−
-- inside, for example, an initialization script for a GUI package:
 
−
setButtonState("Sleep", false)
 
−
setButtonState("Sit", false)
 
−
-- these are going to be used as "radio" buttons where setting one
 
−
-- of them will unset all the others, they will each need something
 
−
-- similar in their own scripts to unset all the others in the set
 
−
-- and also something to prevent them from being unset by clicking
 
−
-- on themselves:
 
−
setButtonState("Wimpy", true)
 
−
setButtonState("Defensive", false)
 
−
setButtonState("Normal", false)
 
−
setButtonState("Brave", false)
 
−
if character.type == "Warrior" then
 
−
    -- Only one type has this mode - and it can only be reset by
 
−
    -- something dying (though that could be us!)
 
−
    setButtonState("Beserk!!!", false)
 
−
end
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==setConsoleBufferSize==
+
==customHTTP==
−
;setConsoleBufferSize([consoleName], linesLimit, sizeOfBatchDeletion)
+
;customHTTP(method, url, headersTable)
−
:Sets the maximum number of lines a buffer (main window or a miniconsole) can hold. Default is 10,000.
+
: Sends an custom method request to the given URL. Raises [[Manual:Event_Engine#sysCustomHttpDone|sysCustomHttpDone]] on success or [[Manual:Event_Engine#sysCustomHttpError|sysCustomHttpError]] on failure.
−
:Returns nothing on success (up to '''Mudlet 4.16''') or ''true'' (from '''Mudlet 4.17'''); ''nil'' and an error message on failure.
+
:See also: [[#downloadFile|downloadFile()]], [[#getHTTP|getHTTP()]], [[#postHTTP|postHTTP()]], [[#putHTTP|putHTTP()]], [[#deleteHTTP|deleteHTTP()]].
  
−
;Parameters
+
;Parameters:
−
* ''consoleName:''
+
* ''method:''
−
: (optional) The name of the window. If omitted, uses the main console.
+
: Http method to use (eg. PATCH, HEAD etc.)
−
* ''linesLimit:''
+
* ''dataToSend:''
−
: Sets the amount of lines the buffer should have.  
+
: Text to send in the request (unless you provide a file to upload).
−
{{note}} Mudlet performs extremely efficiently with even huge numbers, but there is of course a limit to your computer's memory. As of Mudlet 4.7+, this amount will be capped to that limit on macOS and Linux (on Windows, it's capped lower as Mudlet on Windows is 32bit).
+
* ''url:''
−
* ''sizeOfBatchDeletion:''
+
: Location to send the request to.
−
: Specifies how many lines should Mudlet delete at once when you go over the limit - it does it in bulk because it's efficient to do so.
+
* ''headersTable:''
 +
: (optional) table of headers to send with your request.
 +
* ''file:''
 +
: (optional) file to upload as part of the PUT request. If provided, this will replace 'dataToSend'.
  
−
;Example
+
{{MudletVersion|4.11}}
−
<syntaxhighlight lang="lua">
 
−
-- sets the main windows size to 1 million lines maximum - which is more than enough!
 
−
setConsoleBufferSize("main", 1000000, 1000)
 
−
</syntaxhighlight>
 
−
 
 
−
==setProfileIcon==
 
−
;setProfileIcon(iconPath)
 
−
:Set a custom icon for this profile in the connection screen.
 
−
 
 
−
:Returns true if successful, or nil+error message if not.
 
−
 
 
−
:See also: [[#resetProfileIcon|resetProfileIcon()]].
 
−
 
 
−
{{MudletVersion|4.0}}
 
−
 
 
−
;Parameters
 
−
* ''iconPath:''
 
−
: Full location of the icon - can be .png or .jpg with ideal dimensions of 120x30.
 
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- set a custom icon that is located in an installed package called "mypackage"
+
function onCustomHttpDone(_, url, body, method)
−
setProfileIcon(getMudletHomeDir().."/mypackage/icon.png")
+
  cecho(string.format("<white>url: <dark_green>%s<white>, body: <dark_green>%s<white>, method: <dark_green>%s", url, body, method))
−
</syntaxhighlight>
+
end
  
−
==setScript==
+
registerAnonymousEventHandler("sysCustomHttpDone", sysCustomHttpDone)
−
;setScript(scriptName, luaCode, [occurrence])
 
−
: Sets the script's Lua code, replacing existing code. If you have many scripts with the same name, use the 'occurrence' parameter to choose between them.
 
−
: If you'd like to add code instead of replacing it, have a look at [[Manual:Lua_Functions#appendScript|appendScript()]].
 
−
: Returns -1 if the script isn't found - to create a script, use [[Manual:Lua_Functions#permScript|permScript()]].
 
  
−
: See also: [[Manual:Lua_Functions#permScript|permScript()]], [[Manual:Lua_Functions#enableScript|enableScript()]], [[Manual:Lua_Functions#disableScript|disableScript()]], [[Manual:Lua_Functions#getScript|getScript()]], [[Manual:Lua_Functions#appendScript|appendScript()]]
+
customHTTP("PATCH", "this us a request with custom headers", "https://httpbin.org/put", {["X-am-I-awesome"] = "yep I am"})
−
 
+
customHTTP("PATCH", "https://httpbin.org/put", "<fill in file location to upload here>")
−
;Returns
 
−
* a unique id number for that script.
 
−
 
 
−
;Parameters
 
−
* ''scriptName'': name of the script to change the code.
 
−
* ''luaCode'': new Lua code to set.
 
−
* ''occurrence'': The position of the script. Optional, defaults to 1 (first).
 
−
 
 
−
;Example
 
−
<syntaxhighlight lang="lua">
 
−
-- make sure a script named "testscript" exists first, then do:
 
−
setScript("testscript", [[echo("This is a test\n")]], 1)
 
 
</syntaxhighlight>
 
</syntaxhighlight>
−
{{MudletVersion|4.8}}
 
−
 
−
==setStopWatchName==
 
−
;setStopWatchName(watchID/currentStopWatchName, newStopWatchName)
 
−
 
−
;Parameters
 
−
* ''watchID'' (number) / ''currentStopWatchName'' (string): The stopwatch ID you get from [[Manual:Lua_Functions#createStopWatch|createStopWatch()]] or the name supplied to that function at that time, or previously applied with this function.
 
−
* ''newStopWatchName'' (string): The name to use for this stopwatch from now on.
 
  
−
;Returns
+
==sendSocket==
−
* ''true'' on success, ''nil'' and an error message if no matching stopwatch is found.
 
  
−
{{note}} Either ''currentStopWatchName'' or ''newStopWatchName'' may be empty strings: if the first of these is so then the ''lowest'' ID numbered stopwatch without a name is chosen; if the second is so then an existing name is removed from the chosen stopwatch.
 
  
−
==setStopWatchPersistence==
+
;sendSocket(data)
−
;setStopWatchPersistence(watchID/watchName, state)
 
  
−
;Parameters
+
:Sends given binary data as-is (or with some predefined special tokens converted to byte values) to the game. You can use this to implement support for a [[Manual:Supported_Protocols#Adding_support_for_a_telnet_protocol|new telnet protocol]], [http://forums.mudlet.org/viewtopic.php?f=5&t=2272 simultronics] [http://forums.mudlet.org/viewtopic.php?f=5&t=2213#p9810 login] etc.
−
* ''watchID'' (number) / ''watchName'' (string): The stopwatch ID you get from [[Manual:Lua_Functions#createStopWatch|createStopWatch()]] or the name supplied to that function or applied later with [[Manual:Lua_Functions#setStopWatchName|setStopWatchName()]]
 
−
* ''state'' (boolean): if ''true'' the stopWatch will be saved.
 
  
−
;Returns
+
; success = sendSocket("data")
−
* ''true'' on success, ''nil'' and an error message if no matching stopwatch is found.
 
  
−
:Sets or resets the flag so that the stopwatch is saved between sessions or after a [[Manual:Miscellaneous_Functions#resetProfile|resetProfile()]] call. If set then, if ''stopped'' the elapsed time recorded will be unchanged when the stopwatch is reloaded in the next session; if ''running'' the elapsed time will continue to increment and it will include the time that the profile was not loaded, therefore it can be used to measure events in real-time, outside of the profile!
+
;See also: [[Manual:Lua_Functions#feedTelnet|feedTelnet()]], [[Manual:Lua_Functions#feedTriggers|feedTriggers()]]
  
−
{{note}} When a persistent stopwatch is reloaded in a later session (or after a use of ''resetProfile()'') the stopwatch may not be allocated the same ID number as before - therefore it is advisable to assign any persistent stopwatches a name, either when it is created or before the session is ended.
+
{{note}} Modified in Mudlet '''tbd''' to accept some tokens like "''<NUL>''" to include byte values that are not possible to insert with the standard Lua string escape "''\###''" form where ### is a three digit number between 000 and 255 inclusive or where the value is more easily provided via a mnemonic. For the table of the tokens that are known about, see the one in [[Manual:Lua_Functions#feedTelnet|feedTelnet()]].
  
−
==setTriggerStayOpen==
+
{{note}} The data (as bytes) once the tokens have been converted to their byte values is sent as is to the Game Server; any encoding to, say, a UTF-8 representation or to duplicate ''0xff'' byte values so they are not considered to be Telnet ''<IAC>'' (Interpret As Command) bytes must be done to the data prior to calling this function.
−
;setTriggerStayOpen(name, number of lines)
 
−
:Sets for how many more lines a trigger script should fire or a chain should stay open after the trigger has matched - so this allows you to extend or shorten the ''fire length'' of a trigger. The main use of this function is to close a chain when a certain condition has been met.
 
  
 
;Parameters
 
;Parameters
−
* ''name:'' The name of the trigger which has a fire length set (and which opens the chain).
+
* ''data:''
−
* ''number of lines'': 0 to close the chain, or a positive number to keep the chain open that much longer.
+
: String containing the bytes to send to the Game Server possibly containing some tokens that are to be converted to bytes as well.
  
−
;Examples
+
;Returns
−
<syntaxhighlight lang="lua">
+
* (Only since Mudlet '''tbd''') Boolean ''true'' if the whole data string (after token replacement) was sent to the Server, ''false'' if that failed for any reason (including if the Server has not been connected or is now disconnected). ''nil'' and an error message for any other defect.
−
-- if you have a trigger that opens a chain (has some fire length) and you'd like it to be closed
 
−
-- on the next prompt, you could make a prompt trigger inside the chain with a script of:
 
−
setTriggerStayOpen("Parent trigger name", 0)
 
−
-- to close it on the prompt!
 
−
</syntaxhighlight>
 
−
 
 
−
==startStopWatch==
 
−
;startStopWatch(watchName or watchID, [resetAndRestart])
 
−
 
 
−
:Stopwatches can be stopped (with [[Manual:Lua_Functions#stopStopWatch|stopStopWatch()]]) and then re-started any number of times. '''To ensure backwards compatibility, if the stopwatch is identified by a ''numeric'' argument then, ''unless a second argument of false is supplied as well'' this function will also reset the stopwatch to zero and restart it - whether it is running or not'''; otherwise only a stopped watch can be started and only a started watch may be stopped. Trying to repeat either will produce a nil and an error message instead; also the recorded time is no longer reset so that they can now be used to record a total of isolated periods of time like a real stopwatch.
 
−
 
 
−
:See also: [[Manual:Lua_Functions#createStopWatch|createStopWatch()]],  [[Manual:Lua_Functions#stopStopWatch|stopStopWatch()]]
 
−
 
 
−
;Parameters
 
−
* ''watchID''/''watchName'': The stopwatch ID you get with [[Manual:Lua_Functions#createStopWatch|createStopWatch()]], or from '''4.4.0''' the name assigned with that function or [[Manual:Lua_Functions#setStopWatchName|setStopWatchName()]].
 
−
* ''resetAndRestart'': Boolean flag needed (as ''false'') to make the function from '''4.4.0''', when supplied with a numeric watch ID, to '''not''' reset the stopwatch and only start a previously stopped stopwatch. This behavior is automatic when a string watch name is used to identify the stopwatch but differs from how the function behaved prior to that version.
 
−
 
 
−
;Returns
 
−
* ''true'' on success, ''nil'' and an error message if no matching stopwatch is found or if it cannot be started (because the later style behavior was indicated and it was already running).
 
−
 
 
−
;Examples
 
−
<syntaxhighlight lang="lua">
 
−
-- this is a common pattern for re-using stopwatches prior to 4.4.0 and starting them:
 
−
watch = watch or createStopWatch()
 
−
startStopWatch(watch)
 
−
</syntaxhighlight>
 
−
 
 
−
:: After 4.4.0 the above code will work the same as it does not provide a second argument to the ''startStopWatch()'' function - if a ''false'' was used there it would be necessary to call ''stopStopWatch(...)'' and then ''resetStopWatch(...)'' before using ''startStopWatch(...)'' to re-use the stopwatch if the ID form is used, '''this is thus not quite the same behavior but it is more consistent with the model of how a real stopwatch would act.'''
 
−
 
 
−
==stopAllNamedTimers==
 
−
; stopAllNamedTimers(userName)
 
−
 
 
−
:Stops all named timers for userName and prevents them from firing any more. Information is retained and timers can be resumed.
 
−
 
 
−
;See also: [[Manual:Lua_Functions#registerNamedTimer|registerNamedTimer()]], [[Manual:Lua_Functions#stopNamedTimer|stopNamedTimer()]], [[Manual:Lua_Functions#resumeNamedTimer|resumeNamedTimer()]]
 
−
 
 
−
{{MudletVersion|4.14}}
 
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
stopAllNamedTimers("Demonnic") -- emergency stop situation, most likely.
+
-- Tell the Server that we are now willing and able to process  to process Ask the Server to a comment explaining what is going on, if there is multiple functionalities (or optional parameters) the examples should start simple and progress in complexity if needed!
−
</syntaxhighlight>
+
-- the examples should be small, but self-contained so new users can copy & paste immediately without going diving in lots other function examples first.
 +
-- comments up top should introduce / explain what it does
  
−
==stopNamedTimer==
+
local something = function(exampleValue)
−
; success = stopNamedTimer(userName, handlerName)
+
if something then
−
 
+
  -- do something with something (assuming there is a meaningful return value)
−
:Stops a named timer with name handlerName and prevents it from firing any more. Information is stored so it can be resumed later if desired.
+
end
−
 
 
−
;See also: [[Manual:Lua_Functions#registerNamedTimer|registerNamedTimer()]], [[Manual:Lua_Functions#resumeNamedTimer|resumeNamedTimer()]]
 
−
 
 
−
{{MudletVersion|4.14}}
 
  
−
;Parameters
+
-- maybe another example for the optional second case
−
* ''userName:''
+
local somethingElse = function(exampleValue, anotherValue)
−
: The user name the event handler was registered under.
 
−
* ''handlerName:''
 
−
: The name of the handler to stop. Same as used when you called [[Manual:Lua_Functions#registerNamedTimer|registerNamedTimer()]]
 
  
−
;Returns
+
-- lastly, include an example with error handling to give an idea of good practice
−
* true if successful, false if it didn't exist or was already stopped
+
local ok, err = function()
−
 
+
if not ok then
−
;Example
+
   debugc(f"Error: unable to do <particular thing> because {err}\n")
−
<syntaxhighlight lang="lua">
+
   return
−
local stopped = stopNamedTimer("Demonnic", "DemonVitals")
 
−
if stopped then
 
−
   cecho("DemonVitals stopped!")
 
−
else
 
−
   cecho("DemonVitals doesn't exist or already stopped; either way it won't fire any more.")
 
 
end
 
end
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==stopStopWatch==
+
; Additional development notes
−
;stopStopWatch(watchID or watchName)
+
-- This function is still being written up.
−
:"Stops" (though see the note below) the stop watch and returns (only the '''first''' time it is called after the stopwatch has been set running with [[Manual:Lua_Functions#startStopWatch|startStopWatch()]]) the elapsed time as a number of seconds, with a decimal portion give a resolution in milliseconds (thousandths of a second). You can also retrieve the current time without stopping the stopwatch with [[Manual:Lua_Functions#getStopWatchTime|getStopWatchTime()]], [[Manual:Lua_Functions#getBrokenDownStopWatchTime|getBrokenDownStopWatchTime()]].
 
  
−
:See also: [[Manual:Lua_Functions#createStopWatch|createStopWatch()]]
+
==feedTelnet==
  
−
;Parameters
 
−
* ''watchID:'' The stopwatch ID you get with [[Manual:Lua_Functions#createStopWatch|createStopWatch()]] or from Mudlet '''4.4.0''' the name given to that function or later set with [[Manual:Lua_Functions#setStopWatchName|setStopWatchName()]].
 
  
−
;Returns
+
; feedTelnet(data)
−
* the elapsed time as a floating-point number of seconds - it may be negative if the time was previously adjusted/preset to a negative amount (with [[Manual:Lua_Functions#adjustStopWatch|adjustStopWatch()]]) and that period has not yet elapsed.
 
  
−
;Examples
+
:Sends given binary data with some predefined special tokens converted to byte values, to the internal telnet engine, as if it had been received from the game. This is primarily to enable testing when new Telnet sub-options/protocols are being developed. The data has to be injected into the system nearer to the point where the Game Server's data starts out than ''feedTriggers()'' and unlike the latter the data is not subject to any encoding so as to match the current profile's setting (which normally happens with ''feedTriggers()''). Furthermore - to prevent this function from putting the telnet engine into a state which could damage the processing of real game data it will refuse to work unless the Profile is completely disconnected from the game server.
−
<syntaxhighlight lang="lua">
 
−
-- this is a common pattern for re-using stopwatches and starting them:
 
−
watch = watch or createStopWatch()
 
−
startStopWatch(watch)
 
  
−
-- do some long-running code here ...
+
;See also: [[Manual:Lua_Functions#feedTriggers|feedTriggers()]], [[Manual:Lua_Functions#sendSocket|sendSocket()]]
  
−
print("The code took: "..stopStopWatch(watch).."s to run.")
+
{{MudletVersion|tbd}}
−
</syntaxhighlight>
 
  
−
==tempAnsiColorTrigger==
+
{{note}} This is not really intended for end-user's but might be useful in some circumstances.
−
;tempAnsiColorTrigger(foregroundColor[, backgroundColor], code[, expireAfter])
 
−
:This is an alternative to [[Manual:Lua_Functions#tempColorTrigger|tempColorTrigger()]] which supports the full set of 256 ANSI color codes directly and makes a color trigger that triggers on the specified foreground and background color. The function returns the trigger ID for subsequent [[Manual:Lua_Functions#enableTrigger|enableTrigger()]], [[Manual:Lua_Functions#disableTrigger|disableTrigger()]] and [[Manual:Lua_Functions#killTrigger|killTrigger()]] calls. The trigger is temporary in the sense that it won't stay when you close Mudlet, and it will go off multiple times until you disable or destroy it. You can also make it be temporary and self-delete after a number of matches with the ''expireAfter'' parameter.
 
  
 
;Parameters
 
;Parameters
−
* ''foregroundColor:'' The foreground color you'd like to trigger on.
+
* ''data''
−
* ''backgroundColor'': The background color you'd like to trigger on.
+
: String containing the bytes to send to the internal telnet engine as if it had come from the Game Server, it can containing some tokens listed below that are to be converted to bytes as well.
−
* ''code to do'': The code to do when the trigger runs - wrap it in [[ ]], or give it a Lua function.
 
−
* ''expireAfter'': Delete trigger after a specified number of matches. You can make a trigger match not count towards expiration by returning true after it fires.
 
  
−
''BackgroundColor'' and/or ''expireAfter'' may be omitted.
+
;Returns
−
 
+
* Boolean ''true'' if the ''data'' string was sent to the internal telnet engine. ''nil'' and an error message otherwise, specifically the case when there is some traces of a connection or a complete connection to the socket that passes the data to and from the game server. Additionally, if the data is an empty string ''""'' a second return value will be provided as an integer number representing a version for the table of tokens - which will be incremented each time a change is made to that table so that which tokens are valid can be determined. Note that unrecognised tokens should be passed through as is and not get replaced.
−
;Color codes (note that the values greater than or equal to zero are the actual number codes that ANSI and the game server uses for the 8/16/256 color modes)
 
−
 
 
−
::Special codes (may be extended in the future):
 
−
:::-2 = default text color (what is used after an ANSI SGR 0 m code that resets the foreground and background colors to those set in the preferences)
 
−
:::-1 = ignore (only '''one''' of the foreground or background codes can have this value - otherwise it would not be a ''color'' trigger!)
 
−
 
 
−
::ANSI 8-color set:
 
−
:::0 = (dark) black
 
−
:::1 = (dark) red
 
−
:::2 = (dark) green
 
−
:::3 = (dark) yellow
 
−
:::4 = (dark) blue
 
−
:::5 = (dark) magenta
 
−
:::6 = (dark) cyan
 
−
:::7 = (dark) white {a.k.a. light gray}
 
−
 
 
−
::Additional colors in 16-color set:
 
−
:::8 = light black {a.k.a. dark gray}
 
−
:::9 = light red
 
−
:::10 = light green
 
−
:::11 = light yellow
 
−
:::12 = light blue
 
−
:::13 = light magenta
 
−
:::14 = light cyan
 
−
:::15 = light white
 
−
 
 
−
::6 x 6 x 6 RGB (216) colors, shown as a 3x2-digit hex code
 
−
:::16 = #000000
 
−
:::17 = #000033
 
−
:::18 = #000066
 
−
:::...
 
−
:::229 = #FFFF99
 
−
:::230 = #FFFFCC
 
−
:::231 = #FFFFFF
 
−
 
 
−
::24 gray-scale, also show as a 3x2-digit hex code
 
−
:::232 = #000000
 
−
:::233 = #0A0A0A
 
−
:::234 = #151515
 
−
:::...
 
−
:::253 = #E9E9E9
 
−
:::254 = #F4F4F4
 
−
:::255 = #FFFFFF
 
−
 
 
−
;Examples
 
−
<syntaxhighlight lang="lua">
 
−
-- This script will re-highlight all text in a light cyan foreground color on any background with a red foreground color
 
−
-- until another foreground color in the current line is being met. temporary color triggers do not offer match_all
 
−
-- or filter options like the GUI color triggers because this is rarely necessary for scripting.
 
−
-- A common usage for temporary color triggers is to schedule actions on the basis of forthcoming text colors in a particular context.
 
−
tempAnsiColorTrigger(14, -1, [[selectString(matches[1],1) fg("red")]])
 
−
-- or:
 
−
tempAnsiColorTrigger(14, -1, function()
 
−
  selectString(matches[1], 1)
 
−
  fg("red")
 
−
end)
 
−
 
 
−
-- match the trigger only 4 times
 
−
tempColorTrigger(14, -1, [[selectString(matches[1],1) fg("red")]], 4)
 
−
</syntaxhighlight>
 
−
 
 
−
{{MudletVersion|3.17}}
 
−
 
 
−
==tempAlias==
 
−
;aliasID = tempAlias(regex, code to do)
 
−
:Creates a temporary alias - temporary in the sense that it won't be saved when Mudlet restarts (unless you re-create it). The alias will go off as many times as it matches, it is not a one-shot alias. The function returns an ID for subsequent [[Manual:Lua_Functions#enableAlias|enableAlias()]], [[Manual:Lua_Functions#disableAlias|disableAlias()]] and [[Manual:Lua_Functions#killAlias|killAlias()]] calls.
 
−
 
 
−
;Parameters
 
−
* ''regex:'' Alias pattern in regex.
 
−
* ''code to do:'' The code to do when the alias fires - wrap it in [[ ]].
 
−
 
 
−
;Examples
 
−
<syntaxhighlight lang="lua">
 
−
myaliasID = tempAlias("^hi$", [[send ("hi") echo ("we said hi!")]])
 
−
 
 
−
-- you can also delete the alias later with:
 
−
killAlias(myaliasID)
 
−
 
 
−
-- tempAlias also accepts functions (and thus closures) - which can be an easier way to embed variables and make the code for an alias look less messy:
 
−
 
 
−
local variable = matches[2]
 
−
tempAlias("^hi$", function () send("hello, " .. variable) end)
 
−
</syntaxhighlight>
 
−
 
 
−
==tempBeginOfLineTrigger==
 
−
;tempBeginOfLineTrigger(part of line, code, expireAfter)
 
−
:Creates a trigger that will go off whenever the part of line it's provided with matches the line right from the start (doesn't matter what the line ends with). The trigger is temporary in the sense that it won't stay when you close Mudlet, and it will go off multiple times until you disable or destroy it. You can also make it be temporary and self-delete after a number of matches with the ''expireAfter'' parameter. The function returns the trigger ID for subsequent [[Manual:Lua_Functions#enableTrigger|enableTrigger()]], [[Manual:Lua_Functions#disableTrigger|disableTrigger()]] and [[Manual:Lua_Functions#killTrigger|killTrigger()]] calls.
 
−
 
 
−
;Parameters
 
−
* ''part of line'': start of the line that you'd like to match. This can also be regex.
 
−
* ''code to do'': code to do when the trigger runs - wrap it in [[ ]], or give it a Lua function (since Mudlet 3.5.0).
 
−
* ''expireAfter'': Delete trigger after a specified number of matches (since Mudlet 3.11). You can make a trigger match not count towards expiration by returning true after it fires.
 
−
 
 
−
;Examples
 
−
<syntaxhighlight lang="lua">
 
−
mytriggerID = tempBeginOfLineTrigger("Hello", [[echo("We matched!")]])
 
  
−
--[[ now this trigger will match on any of these lines:
+
{| class="wikitable sortable"
−
Hello
+
|+ Token value table
−
Hello!
+
|-
−
Hello, Bob!
+
! Token !! Byte !! Version!! Notes
−
 
+
|-
−
but not on:
+
|| <00> || \0x00 || 1 || 0 dec.
−
Oh, Hello
+
|-
−
Oh, Hello!
+
|| <O_BINARY> || \0x00 || 1 || Telnet option: Binary
−
]]
+
|-
−
 
+
|| <NUL> || \0x00 || 1 || ASCII control character: NULL
−
-- or as a function:
+
|-
−
mytriggerID = tempBeginOfLineTrigger("Hello", function() echo("We matched!") end)
+
|| <01> || \x01 || 1 || 1 dec.
−
</syntaxhighlight>
+
|-
−
 
+
|| <O_ECHO> || \x01 || 1 || Telnet option: Echo
−
<syntaxhighlight lang="lua">
+
|-
−
-- you can make the trigger match only a certain amount of times as well, 5 in this example:
+
|| <SOH> || \x01 || 1 || ASCII control character: Start of Heading
−
tempBeginOfLineTrigger("This is the start of the line", function() echo("We matched!") end, 5)
+
|-
−
 
+
|| <02> || \x02 || 1 || 2 dec. Telnet option: Reconnect
−
-- if you want a trigger match not to count towards expiration, return true. In this example it'll match 5 times unless the line is "Start of line and this is the end."
+
|-
−
tempBeginOfLineTrigger("Start of line",
+
|| <STX> || \x02 || 1 || ASCII control character: Start of Text
−
function()
+
|-
−
  if line == "Start of line and this is the end." then
+
|| <03> || \x03 || 1 || 3 dec.
−
    return true
+
|-
−
  else
+
|| <O_SGA> || \x03 || 1 || Telnet option: Suppress Go Ahead
−
    return false
+
|-
−
  end
+
|| <ETX> || \x03 || 1 || ASCII control character: End of Text
−
end, 5)
+
|-
−
</syntaxhighlight>
+
|| <04> || \x04 || 1 || Telnet option: Approx Message Size Negotiation
−
 
+
|-
−
==tempButton==
+
|| <EOT> || \x04 || 1 || ASCII control character: End of Transmission
−
;tempButton(toolbar name, button text, orientation)
+
|-
−
:Creates a temporary button. Temporary means, it will disappear when Mudlet is closed.
+
|| <05> || \x05 || 1 ||
−
 
+
|-
−
;Parameters:
+
|| <O_STATUS> || \x05 || 1 ||
−
* ''toolbar name'': The name of the toolbar to place the button into.
+
|-
−
* ''button text'': The text to display on the button.
+
|| <ENQ> || \x05 || 1 || ASCII control character: Enquiry
−
* ''orientation'': a number 0 or 1 where 0 means horizontal orientation for the button and 1 means vertical orientation for the button. This becomes important when you want to have more than one button in the same toolbar.
+
|-
 +
|| <06> || \x06 || 1 || Telnet option: Timing Mark
 +
|-
 +
|| <ACK> || \x06 || 1 || ASCII control character: Acknowledge
 +
|-
 +
|| <07> || \x07 || 1 || Telnet option: Remote Controlled Trans and Echo
 +
|-
 +
|| <BELL> || \x07 || 1 || ASCII control character: Bell
 +
|-
 +
|| <08> || \x08 || 1 || Telnet option: Output Line Width
 +
|-
 +
|| <BS> || \x08 || 1 ||
 +
|-
 +
|| <09> || \x09 || 1 || Telnet option: Output Page Size
 +
|-
 +
|| <HTAB> || \x09 || 1 || ASCII control character: Horizontal Tab
 +
|-
 +
|| <0A> || \x0a || 1 || Telnet option: Output Carriage-Return Disposition
 +
|-
 +
|| <LF> || \x0a || 1 || ASCII control character: Line-Feed
 +
|-
 +
|| <0B> || \x0b || 1 || Telnet option: Output Horizontal Tab Stops
 +
|-
 +
|| <VTAB> || \x0b || 1 || ASCII control character: Vertical Tab
 +
|-
 +
|| <0C> || \x0c || 1 || Telnet option: Output Horizontal Tab Disposition
 +
|-
 +
|| <FF> || \x0c || 1 || ASCII control character: Form-Feed
 +
|-
 +
|| <0D> || \x0d || 1 || Telnet option: Output Form-feed Disposition
 +
|-
 +
|| <CR> || \x0d || 1 || ASCII control character: Carriage-Return
 +
|-
 +
|| <0E> || \x0e || 1 || Telnet option: Output Vertical Tab Stops
 +
|-
 +
|| <SO> || \x0e || 1 || ASCII control character: Shift-Out
 +
|-
 +
|| <0F> || \x0f || 1 || Telnet option: Output Vertical Tab Disposition
 +
|-
 +
|| <SI> || \x0f || 1 || ASCII control character: Shift-In
 +
|-
 +
|| <10> || \x10 || 1 || Telnet option: Output Linefeed Disposition
 +
|-
 +
|| <DLE> || \x10 || 1 || ASCII control character: Data Link Escape
 +
|-
 +
|| <11> || \x11 || 1 || Telnet option: Extended ASCII
 +
|-
 +
|| <DC1> || \x11 || 1 || ASCII control character: Device Control 1
 +
|-
 +
|| <12> || \x12 || 1 || Telnet option: Logout
 +
|-
 +
|| <DC2" || \x12 || 1 || ASCII control character: Device Control 2
 +
|-
 +
|| <13> || \x13 || 1 || Telnet option: Byte Macro
 +
|-
 +
|| <DC3> || \x13 || 1 || ASCII control character: Device Control 3
 +
|-
 +
|| <14> || \x14 || 1 || Telnet option: Data Entry Terminal
 +
|-
 +
|| <DC4> || \x14 || 1 || ASCII control character: Device Control 4
 +
|-
 +
|| <15> || \x15 || 1 || Telnet option: SUPDUP
 +
|-
 +
|| <NAK> || \x15 || 1 || ASCII control character: Negative Acknowledge
 +
|-
 +
|| <16> || \x16 || 1 || Telnet option: SUPDUP Output
 +
|-
 +
|| <SYN> || \x16 || 1 || ASCII control character: Synchronous Idle
 +
|-
 +
|| <17> || \x17 || 1 || Telnet option: Send location
 +
|-
 +
|| <ETB> || \x17 || 1 || ASCII control character: End of Transmission Block
 +
|-
 +
|| <18> || \x18 || 1 ||
 +
|-
 +
|| <O_TERM> || \x18 || 1 || Telnet option: Terminal Type
 +
|-
 +
|| <CAN> || \x18 || 1 || ASCII control character: Cancel
 +
|-
 +
|| <19> || \x19 || 1 ||
 +
|-
 +
|| <O_EOR> || \x19 || 1 || Telnet option: End-of-Record
 +
|-
 +
|| <nowiki><EM></nowiki> || \x19 || 1 || ASCII control character: End of Medium
 +
|-
 +
|| <1A> || \x1a || 1 || Telnet option:  TACACS User Identification
 +
|-
 +
|| <nowiki><SUB></nowiki> || \x1a || 1 || ASCII control character: Substitute
 +
|-
 +
|| <1B> || \x1b || 1 || Telnet option: Output Marking
 +
|-
 +
|| <ESC> || \x1b || 1 || ASCII control character: Escape
 +
|-
 +
|| <1C> || \x1c || 1 || Telnet option: Terminal Location Number
 +
|-
 +
|| <FS> || \x1c || 1 || ASCII control character: File Separator
 +
|-
 +
|| <1D> || \x1d || 1 || Telnet option: Telnet 3270 Regime
 +
|-
 +
|| <GS> || \x1d || 1 || ASCII control character: Group Separator
 +
|-
 +
|| <1E> || \x1e || 1 || Telnet option: X.3 PAD
 +
|-
 +
|| <RS> || \x1e || 1 || ASCII control character: Record Separator
 +
|-
 +
|| <1F> || \x1f || 1 ||
 +
|-
 +
|| <O_NAWS> || \x1f || 1 || Telnet option: Negotiate About Window Size
 +
|-
 +
|| <US> || \x1f || 1 || ASCII control character: Unit Separator
 +
|-
 +
|| <SP> || \x20 || 1 || 32 dec. ASCII character: Space
 +
|-
 +
|| <O_NENV> || \x27 || 1 || 39 dec. Telnet option: New Environment (also MNES)
 +
|-
 +
|| <O_CHARS> || \x2a || 1 || 42 dec. Telnet option: Character Set
 +
|-
 +
|| <O_KERMIT> || \x2f || 1 || 47 dec. Telnet option: Kermit
 +
|-
 +
|| <O_MSDP> || \x45 || 1 || 69 dec. Telnet option: Mud Server Data Protocol
 +
|-
 +
|| <O_MSSP> || \x46 || 1 || 70 dec. Telnet option: Mud Server Status Protocol
 +
|-
 +
|| <O_MCCP> || \x55 || 1 || 85 dec
 +
|-
 +
|| <O_MCCP2> || \x56 || 1 || 86 dec
 +
|-
 +
|| <O_MSP> || \x5a || 1 || 90 dec. Telnet option: Mud Sound Protocol
 +
|-
 +
|| <O_MXP> || \x5b || 1 || 91 dec. Telnet option: Mud eXtension Protocol
 +
|-
 +
|| <O_ZENITH> || \x5d || 1 || 93 dec. Telnet option: Zenith Mud Protocol
 +
|-
 +
|| <O_AARDWULF> || \x66 || 1 || 102 dec. Telnet option: Aardwuld Data Protocol
 +
|-
 +
|| <nowiki><DEL></nowiki> || \x7f || 1 || 127 dec. ASCII control character: Delete
 +
|-
 +
|| <O_ATCP> || \xc8 || 1 || 200 dec
 +
|-
 +
|| <O_GMCP> || \xc9 || 1 || 201 dec
 +
|-
 +
|| <T_EOR> || \xef || 1 || 239 dec
 +
|-
 +
|| <F0> || \xf0 || 1 ||
 +
|-
 +
|| <T_SE> || \xf0 || 1 ||
 +
|-
 +
|| <F1> || \xf1 || 1 ||
 +
|-
 +
|| <T_NOP> || \xf1 || 1 ||
 +
|-
 +
|| <F2> || \xf2 || 1 ||
 +
|-
 +
|| <T_DM> || \xf2 || 1 ||
 +
|-
 +
|| <F3> || \xf3 || 1 ||
 +
|-
 +
|| <T_BRK> || \xf3 || 1 ||
 +
|-
 +
|| <F4> || \xf4 || 1 ||
 +
|-
 +
|| <T_IP> || \xf4 || 1 ||
 +
|-
 +
|| <F5> || \xf5 || 1 ||
 +
|-
 +
|| <T_ABOP> || \xf5 || 1 ||
 +
|-
 +
|| <F6> || \xf6 || 1 ||
 +
|-
 +
|| <T_AYT> || \xf6 || 1 ||
 +
|-
 +
|| <F7> || \xf7 || 1 ||
 +
|-
 +
|| <T_EC> || \xf7 || 1 ||
 +
|-
 +
|| <F8> || \xf8 || 1 ||
 +
|-
 +
|| <T_EL> || \xf8 || 1 ||
 +
|-
 +
|| <F9> || \xf9 || 1 ||
 +
|-
 +
|| <T_GA> || \xf9 || 1 ||
 +
|-
 +
|| <FA> || \xfa || 1 ||
 +
|-
 +
|| <T_SB> || \xfa || 1 ||
 +
|-
 +
|| <FB> || \xfb || 1 ||
 +
|-
 +
|| <T_WILL> || \xfb || 1 ||
 +
|-
 +
|| <FC> || \xfc || 1 ||
 +
|-
 +
|| <T_WONT> || \xfc || 1 ||
 +
|-
 +
|| <FD> || \xfd || 1 ||
 +
|-
 +
|| <T_DO> || \xfd || 1 ||
 +
|-
 +
|| <FE> || \xfe || 1 ||
 +
|-
 +
|| <T_DONT> || \xfe || 1 ||
 +
|-
 +
|| <FF> || \xff || 1 ||
 +
|-
 +
|| <T_IAC> || \xff'
 +
|}
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- makes a temporary toolbar with two buttons at the top of the main Mudlet window
+
-- a comment explaining what is going on, if there is multiple functionalities (or optional parameters) the examples should start simple and progress in complexity if needed!
−
lua tempButtonToolbar("topToolbar", 0, 0)
+
-- the examples should be small, but self-contained so new users can copy & paste immediately without going diving in lots other function examples first.
−
lua tempButton("topToolbar", "leftButton", 0)
+
-- comments up top should introduce / explain what it does
−
lua tempButton("topToolbar", "rightButton", 0)
 
−
</syntaxhighlight>
 
  
−
{{note}} ''This function is not that useful as there is no function yet to assign a Lua script or command to such a temporary button - though it may have some use to flag a status indication!''
+
local something = feedTelnet(exampleValue)
−
 
+
if something then
−
==tempButtonToolbar==
+
   -- do something with something (assuming there is a meaningful return value)
−
;tempButtonToolbar(name, location, orientation)
+
end
−
:Creates a temporary button toolbar. Temporary means, it will disappear when Mudlet is closed.
 
−
 
 
−
;Parameters:
 
−
* ''name'': The name of the toolbar.
 
−
* ''location'': a number from 0 to 3, where 0 means "at the top of the screen", 1 means "left side", 2 means "right side" and 3 means "in a window of its own" which can be dragged and attached to the main Mudlet window if needed.
 
−
* ''orientation'': a number 0 or 1, where 0 means horizontal orientation for the toolbar and 1 means vertical orientation for the toolbar. This becomes important when you want to have more than one toolbar in the same location of the window.
 
−
 
 
−
;Example
 
−
<syntaxhighlight lang="lua">
 
−
-- makes a temporary toolbar with two buttons at the top of the main Mudlet window
 
−
lua tempButtonToolbar("topToolbar", 0, 0)
 
−
lua tempButton("topToolbar", "leftButton", 0)
 
−
lua tempButton("topToolbar", "rightButton", 0)
 
−
</syntaxhighlight>
 
−
 
 
−
==tempColorTrigger==
 
−
;tempColorTrigger(foregroundColor, backgroundColor, code, expireAfter)
 
−
:Makes a color trigger that triggers on the specified foreground and background color. Both colors need to be supplied in form of these simplified ANSI 16 color mode codes. The function returns the trigger ID for subsequent [[Manual:Lua_Functions#enableTrigger|enableTrigger()]], [[Manual:Lua_Functions#disableTrigger|disableTrigger()]] and [[Manual:Lua_Functions#killTrigger|killTrigger()]] calls. The trigger is temporary in the sense that it won't stay when you close Mudlet, and it will go off multiple times until you disable or destroy it. You can also make it be temporary and self-delete after a number of matches with the ''expireAfter'' parameter.
 
−
See also: [[Manual:Mudlet Object Functions#tempAnsiColorTrigger|tempAnsiColorTrigger]]
 
−
;Parameters
 
−
* ''foregroundColor:'' The foreground color you'd like to trigger on (for ANSI colors, see [[Manual:Mudlet Object Functions#tempAnsiColorTrigger|tempAnsiColorTrigger]]).
 
−
* ''backgroundColor'': The background color you'd like to trigger on (same as above).
 
−
* ''code to do'': The code to do when the trigger runs - wrap it in <code>[[</code> and <code>]]</code>, or give it a Lua function, ie. <code>function() <nowiki><your code here></nowiki> end</code> (since Mudlet 3.5.0).
 
−
* ''expireAfter'': Delete trigger after a specified number of matches (since Mudlet 3.11). You can make a trigger match not count towards expiration by returning true after it fires.
 
−
 
 
−
;Color codes
 
−
<syntaxhighlight lang="lua">
 
−
0 = default text color
 
−
1 = light black
 
−
2 = dark black
 
−
3 = light red
 
−
4 = dark red
 
−
5 = light green
 
−
6 = dark green
 
−
7 = light yellow
 
−
8 = dark yellow
 
−
9 = light blue
 
−
10 = dark blue
 
−
11 = light magenta
 
−
12 = dark magenta
 
−
13 = light cyan
 
−
14 = dark cyan
 
−
15 = light white
 
−
16 = dark white
 
−
</syntaxhighlight>
 
−
 
 
−
;Examples
 
−
<syntaxhighlight lang="lua">
 
−
-- This script will re-highlight all text in blue foreground colors on a black background with a red foreground color
 
−
-- on a blue background color until another color in the current line is being met. temporary color triggers do not
 
−
-- offer match_all or filter options like the GUI color triggers because this is rarely necessary for scripting.
 
−
-- A common usage for temporary color triggers is to schedule actions on the basis of forthcoming text colors in a particular context.
 
−
tempColorTrigger(9, 2, [[selectString(matches[1],1) fg("red") bg("blue")]])
 
−
-- or:
 
−
tempColorTrigger(9, 2, function()
 
−
   selectString(matches[1], 1)
 
−
  fg("red")
 
−
  bg("blue")
 
−
end)
 
−
 
 
−
-- match the trigger only 4 times
 
−
tempColorTrigger(9, 2, [[selectString(matches[1],1) fg("red") bg("blue")]], 4)
 
−
</syntaxhighlight>
 
−
 
 
−
==tempComplexRegexTrigger==
 
−
;tempComplexRegexTrigger(name, regex, code, multiline, fg color, bg color, filter, match all, highlight fg color, highlight bg color, play sound file, fire length, line delta, expireAfter)
 
−
:Allows you to create a temporary trigger in Mudlet, using any of the UI-available options. The trigger is temporary in the sense that it won't stay when you close Mudlet, and it will go off multiple times until you disable or destroy it. You can also make it be temporary and self-delete after a number of matches with the ''expireAfter'' parameter.
 
−
:Returns the trigger ID or nil and an error message (on error).
 
−
 
 
−
;Parameters
 
−
* ''name'' - The name you call this trigger. You can use this with [[Manual:Lua_Functions#killTrigger|killTrigger()]].
 
−
* ''regex'' - The regular expression you want to match.
 
−
* ''code'' - Code to do when the trigger runs. You need to wrap it in [[ ]], or give a Lua function (since Mudlet 3.5.0).
 
−
* ''multiline'' - Set this to 1, if you use multiple regex (see note below), and you need the trigger to fire only if all regex have been matched within the specified line delta. Then all captures will be saved in ''multimatches'' instead of ''matches''. If this option is set to 0, the trigger will fire when any regex has been matched.
 
−
* ''fg color'' - The foreground color you'd like to trigger on - '''Not currently implemented.'''
 
−
* ''bg color'' - The background color you'd like to trigger on - '''Not currently implemented.'''
 
−
* ''filter'' - Do you want only the filtered content (=capture groups) to be passed on to child triggers? Otherwise also the initial line.
 
−
* ''match all'' - Set to 1, if you want the trigger to match all possible occurrences of the regex in the line. When set to 0, the trigger will stop after the first successful match.
 
−
* ''highlight fg color'' - The foreground color you'd like your match to be highlighted in. e.g. <code>"yellow"</code>, <code>"#ff0"</code> or <code>"#ffff00"</code>
 
−
* ''highlight bg color'' - The background color you'd like your match to be highlighted in. e.g. <code>"red"</code>, <code>"#f00"</code> or <code>"#ff0000"</code>
 
−
* ''play sound file'' - Set to the name of the sound file you want to play upon firing the trigger. e.g. <code>"C:/windows/media/chord.wav"</code>
 
−
* ''fire length'' - Number of lines within which all condition must be true to fire the trigger.
 
−
* ''line delta'' - Keep firing the script for x more lines, after the trigger or chain has matched.
 
−
* ''expireAfter'' - Delete trigger after a specified number of matches (since Mudlet 3.11). You can make a trigger match not count towards expiration by returning true after it fires.
 
−
 
 
−
{{Note}} Set the options starting at ''multiline'' to 0, if you don't want to use those options. Otherwise enter 1 to activate or the value you want to use.
 
−
 
 
−
{{Note}} If you want to use the color option, you need to provide both fg and bg together. - '''Not currently implemented.'''
 
−
 
 
−
;Examples
 
−
 
 
−
<syntaxhighlight lang="lua">
 
−
-- This trigger will be activated on any new line received.
 
−
triggerNumber = tempComplexRegexTrigger("anyText", "^(.*)$", [[echo("Text received!")]], 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, nil)
 
−
 
 
−
-- This trigger will match two different regex patterns:
 
−
tempComplexRegexTrigger("multiTrigger", "first regex pattern", [[]], 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, nil)
 
−
tempComplexRegexTrigger("multiTrigger", "second regex pattern", [[echo("Trigger matched!")]], 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, nil)
 
−
</syntaxhighlight>
 
−
 
 
−
{{Note}} For making a multiline trigger like in the second example, you need to use the same trigger name and options, providing the new pattern to add. Note that only the last script given will be set, any others ignored.
 
−
 
 
−
==tempExactMatchTrigger==
 
−
;tempExactMatchTrigger(exact line, code, expireAfter)
 
−
:Creates a trigger that will go off whenever the line from the game matches the provided line exactly (ends the same, starts the same, and looks the same). You don't need to use any of the regex symbols here (^ and $). The function returns the trigger ID for subsequent [[Manual:Lua_Functions#enableTrigger|enableTrigger()]], [[Manual:Lua_Functions#disableTrigger|disableTrigger()]] and [[Manual:Lua_Functions#killTrigger|killTrigger()]] calls. The trigger is temporary in the sense that it won't stay when you close Mudlet, and it will go off multiple times until you disable or destroy it. You can also make it be temporary and self-delete after a number of matches with the ''expireAfter'' parameter.
 
−
 
 
−
;Parameters
 
−
* ''exact line'': exact line you'd like to match.
 
−
* ''code'': code to do when the trigger runs - wrap it in [[ ]], or give it a Lua function (since Mudlet 3.5.0).
 
−
* ''expireAfter'': Delete trigger after a specified number of matches (since Mudlet 3.11). You can make a trigger match not count towards expiration by returning true after it fires.
 
−
 
 
−
;Examples
 
−
<syntaxhighlight lang="lua">
 
−
mytriggerID = tempExactMatchTrigger("You have recovered balance on all limbs.", [[echo("We matched!")]])
 
−
 
 
−
-- as a function:
 
−
mytriggerID = tempExactMatchTrigger("You have recovered balance on all limbs.", function() echo("We matched!") end)
 
−
 
 
−
-- expire after 4 matches:
 
−
tempExactMatchTrigger("You have recovered balance on all limbs.", function() echo("Got balance back!\n") end, 4)
 
−
 
 
−
-- you can also avoid expiration by returning true:
 
−
tempExactMatchTrigger("You have recovered balance on all limbs.", function() echo("Got balance back!\n") return true end, 4)
 
−
</syntaxhighlight>
 
−
 
 
−
==tempKey==
 
−
;tempKey([modifier], key code, lua code)
 
−
:Creates a keybinding. This keybinding isn't temporary in the sense that it'll go off only once (it'll go off as often as you use it), but rather it won't be saved when Mudlet is closed.
 
−
 
 
−
: See also: [[#permKey|permKey()]], [[#killKey|killKey()]]
 
−
 
 
−
* ''modifier''
 
−
:(optional) modifier to use - can be one of ''mudlet.keymodifier.Control'', ''mudlet.keymodifier.Alt'', ''mudlet.keymodifier.Shift'', ''mudlet.keymodifier.Meta'', ''mudlet.keymodifier.Keypad'', or ''mudlet.keymodifier.GroupSwitch'' or the default value of ''mudlet.keymodifier.None'' which is used if the argument is omitted. To use multiple modifiers, add them together: ''(mudlet.keymodifier.Shift + mudlet.keymodifier.Control)''
 
−
* ''key code''
 
−
: actual key to use - one of the values available in ''mudlet.key'', e.g. ''mudlet.key.Escape'', ''mudlet.key.Tab'', ''mudlet.key.F1'', ''mudlet.key.A'', and so on. The list is a bit long to list out in full so it is [https://github.com/Mudlet/Mudlet/blob/development/src/mudlet-lua/lua/KeyCodes.lua#L2 available here].
 
−
* ''lua code'
 
−
: code you'd like the key to run - wrap it in [[ ]].
 
−
 
 
−
;Returns
 
−
* a unique id number for that key.
 
−
 
 
−
;Examples
 
−
<syntaxhighlight lang="lua">
 
−
keyID = tempKey(mudlet.key.F8, [[echo("hi")]])
 
−
 
 
−
anotherKeyID = tempKey(mudlet.keymodifier.Control, mudlet.key.F8, [[echo("hello")]])
 
−
 
 
−
-- bind Ctrl+Shift+W:
 
−
tempKey(mudlet.keymodifier.Control + mudlet.keymodifier.Shift, mudlet.key.W, [[send("jump")]])
 
−
 
 
−
-- delete it if you don't like it anymore
 
−
killKey(keyID)
 
−
 
 
−
-- tempKey also accepts functions (and thus closures) - which can be an easier way to embed variables and make the code for tempKeys look less messy:
 
−
 
 
−
tempKey(mudlet.key.F8, function() echo("Hi\n") end)
 
−
</syntaxhighlight>
 
−
 
 
−
==tempLineTrigger==
 
−
;tempLineTrigger(from, howMany, code)
 
−
:Temporary trigger that will fire on ''n'' consecutive lines following the current line. This is useful to parse output that is known to arrive in a certain line margin or to delete unwanted output from the game - the trigger does not require any patterns to match on. The function returns the trigger ID for subsequent [[Manual:Lua_Functions#enableTrigger|enableTrigger()]], [[Manual:Lua_Functions#disableTrigger|disableTrigger()]] and [[Manual:Lua_Functions#killTrigger|killTrigger()]] calls. The trigger is temporary in the sense that it won't stay when you close Mudlet, and it will go off multiple times until you disable or destroy it. You can also make it be temporary and self-delete after a number of matches with the ''expireAfter'' parameter.
 
−
 
 
−
;Parameters:
 
−
* ''from'': from which line after this one should the trigger activate - 1 will activate right on the next line.
 
−
* ''howMany'': how many lines to run for after the trigger has activated.
 
−
* ''code'': code to do when the trigger runs - wrap it in [[ ]], or give it a Lua function (since Mudlet 3.5.0).
 
−
 
 
−
;Example:
 
−
<syntaxhighlight lang="lua">
 
−
-- Will fire 3 times with the next line from the game
 
−
tempLineTrigger(1, 3, function() print(" trigger matched!") end)
 
−
 
 
−
-- Will fire 5 lines after the current line and fire twice on 2 consecutive lines
 
−
tempLineTrigger(5, 2, function() print(" trigger matched!") end, 7)
 
−
</syntaxhighlight>
 
−
 
 
−
==tempPromptTrigger==
 
−
;tempPromptTrigger(code, expireAfter)
 
−
:Temporary trigger that will match on the games prompt. The function returns the trigger ID for subsequent [[Manual:Lua_Functions#enableTrigger|enableTrigger()]], [[Manual:Lua_Functions#disableTrigger|disableTrigger()]] and [[Manual:Lua_Functions#killTrigger|killTrigger()]] calls. The trigger is temporary in the sense that it won't stay when you close Mudlet, and it will go off multiple times until you disable or destroy it. You can also make it be temporary and self-delete after a number of matches with the ''expireAfter'' parameter.
 
−
 
 
−
{{note}} If the trigger is not working, check that the '''N:''' bottom-right has a number. This feature requires telnet Go-Ahead to be enabled in the game.
 
−
 
 
−
{{MudletVersion|3.6}}
 
−
 
 
−
;Parameters:
 
−
* ''code'':
 
−
: code to do when the trigger runs - wrap it in [[ ]], or give it a Lua function.
 
−
* ''expireAfter'': (available in Mudlet 3.11+)
 
−
: Delete trigger after a specified number of matches. You can make a trigger match not count towards expiration by returning true after it fires.
 
−
 
 
−
;Example:
 
−
<syntaxhighlight lang="lua">
 
−
tempPromptTrigger(function()
 
−
  echo("hello! this is a prompt!")
 
−
end)
 
−
 
 
−
-- match only 2 times:
 
−
tempPromptTrigger(function()
 
−
  echo("hello! this is a prompt!")
 
−
end, 2)
 
−
 
 
−
-- match only 2 times, unless the prompt is "55 health."
 
−
tempPromptTrigger(function()
 
−
  if line == "55 health." then return true end
 
−
end, 2)
 
−
</syntaxhighlight>
 
−
 
 
−
==tempRegexTrigger==
 
−
;tempRegexTrigger(regex, code, expireAfter)
 
−
:Creates a temporary regex trigger that executes the code whenever it matches. The function returns the trigger ID for subsequent [[Manual:Lua_Functions#enableTrigger|enableTrigger()]], [[Manual:Lua_Functions#disableTrigger|disableTrigger()]] and [[Manual:Lua_Functions#killTrigger|killTrigger()]] calls. The trigger is temporary in the sense that it won't stay when you close Mudlet, and it will go off multiple times until you disable or destroy it. You can also make it be temporary and self-delete after a number of matches with the ''expireAfter'' parameter.
 
−
 
 
−
;Parameters:
 
−
* ''regex:'' regular expression that lines will be matched on.
 
−
* ''code'': code to do when the trigger runs - wrap it in [[ ]], or give it a Lua function (since Mudlet 3.5.0).
 
−
* ''expireAfter'': Delete trigger after a specified number of matches (since Mudlet 3.11). You can make a trigger match not count towards expiration by returning true after it fires.
 
−
 
 
−
;Examples:
 
−
<syntaxhighlight lang="lua">
 
−
-- create a non-duplicate trigger that matches on any line and calls a function
 
−
html5log = html5log or {}
 
−
if html5log.trig then killTrigger(html5log.trig) end
 
−
html5log.trig = tempRegexTrigger("^", [[html5log.recordline()]])
 
−
-- or a simpler variant:
 
−
html5log.trig = tempRegexTrigger("^", html5log.recordline)
 
−
 
 
−
-- only match 3 times:
 
−
tempRegexTrigger("^You prick (.+) twice in rapid succession with", function() echo("Hit "..matches[2].."!\n") end, 3)
 
−
 
 
−
-- since Mudlet 4.11+ you can use named capturing groups
 
−
tempRegexTrigger("^You see (?<material>\\w+) axe inside chest\\.", function() echo("\nAxe is " .. matches.material) end)
 
−
</syntaxhighlight>
 
−
 
 
−
==tempTimer==
 
−
;tempTimer(time, code to do[, repeating])
 
−
:Creates a temporary one-shot timer and returns the timer ID, which you can use with [[Manual:Lua_Functions#enableTimer|enableTimer()]], [[Manual:Lua_Functions#disableTimer|disableTimer()]] and [[Manual:Lua_Functions#killTimer|killTimer()]] functions. You can use 2.3 seconds or 0.45 etc. After it has fired, the timer will be deactivated and destroyed, so it will only go off once. Here is a [[Manual:Introduction#Timers|more detailed introduction to tempTimer]].
 
−
 
 
−
;Parameters
 
−
* ''time:'' The time in seconds for which to set the timer for - you can use decimals here for precision. The timer will go off ''x'' given seconds after you make it.
 
−
* ''code to do'': The code to do when the timer is up - wrap it in [[ ]], or provide a Lua function.
 
−
* ''repeating'': (optional) if true, keep firing the timer over and over until you kill it (available in Mudlet 4.0+).
 
−
 
 
−
;Examples
 
−
<syntaxhighlight lang="lua">
 
−
-- wait half a second and then run the command
 
−
tempTimer(0.5, function() send("kill monster") end)
 
−
 
 
−
-- echo between 1 and 5 seconds after creation
 
−
tempTimer(math.random(1, 5), function() echo("hi!") end)
 
−
 
 
−
-- or an another example - two ways to 'embed' variable in a code for later:
 
−
local name = matches[2]
 
−
tempTimer(2, [[send("hello, ]]..name..[[ !")]])
 
−
-- or:
 
−
tempTimer(2, function()
 
−
  send("hello, "..name)
 
−
end)
 
−
 
 
−
-- create a looping timer
 
−
timerid = tempTimer(1, function() display("hello!") end, true)
 
−
 
 
−
-- later when you'd like to stop it:
 
−
killTimer(timerid)
 
−
</syntaxhighlight>
 
−
 
 
−
{{note}} Double brackets, e.g: [[ ]] can be used to quote strings in Lua. The difference to the usual `" " quote syntax is that `[[ ]] also accepts the character ". Consequently, you don’t have to escape the " character in the above script. The other advantage is that it can be used as a multiline quote, so your script can span several lines.
 
−
 
 
−
{{note}} Lua code that you provide as an argument is compiled from a string value when the timer fires. This means that if you want to pass any parameters by value e.g. you want to make a function call that uses the value of your variable myGold as a parameter you have to do things like this:
 
−
 
 
−
<syntaxhighlight lang="lua">
 
−
tempTimer( 3.8, [[echo("at the time of the tempTimer call I had ]] .. myGold .. [[ gold.")]] )
 
−
 
 
−
-- tempTimer also accepts functions (and thus closures) - which can be an easier way to embed variables and make the code for timers look less messy:
 
−
 
 
−
local variable = matches[2]
 
−
tempTimer(3, function () send("hello, " .. variable) end)
 
−
</syntaxhighlight>
 
−
 
 
−
==tempTrigger==
 
−
;tempTrigger(substring, code, expireAfter)
 
−
:Creates a substring trigger that executes the code whenever it matches. The function returns the trigger ID for subsequent [[Manual:Lua_Functions#enableTrigger|enableTrigger()]], [[Manual:Lua_Functions#disableTrigger|disableTrigger()]] and [[Manual:Lua_Functions#killTrigger|killTrigger()]] calls. The trigger is temporary in the sense that it won't stay when you close Mudlet, and it will go off multiple times until you disable or destroy it. You can also make it be temporary and self-delete after a number of matches with the ''expireAfter'' parameter.
 
−
 
 
−
;Parameters:
 
−
* ''substring'': The substring to look for - this means a part of the line. If your provided text matches anywhere within the line from the game, the trigger will go off.
 
−
* ''code'': The code to do when the trigger runs - wrap it in [[ ]], or give it a Lua function (since Mudlet 3.5)
 
−
* ''expireAfter'': Delete trigger after a specified number of matches (since Mudlet 3.11). You can make a trigger match not count towards expiration by returning true after it fires.
 
−
 
 
−
Example:
 
−
<syntaxhighlight lang="lua">
 
−
-- this example will highlight the contents of the "target" variable.
 
−
-- it will also delete the previous trigger it made when you call it again, so you're only ever highlighting one name
 
−
if id then killTrigger(id) end
 
−
id = tempTrigger(target, [[selectString("]] .. target .. [[", 1) fg("gold") resetFormat()]])
 
−
 
 
−
-- you can also write the same line as:
 
−
id = tempTrigger(target, function() selectString(target, 1) fg("gold") resetFormat() end)
 
  
−
-- or like so if you have a highlightTarget() function somewhere
+
-- maybe another example for the optional second case
−
id = tempTrigger(target, highlightTarget)
+
local somethingElse = function(exampleValue, anotherValue)
−
</syntaxhighlight>
 
  
−
<syntaxhighlight lang="lua">
+
-- lastly, include an example with error handling to give an idea of good practice
−
-- a simpler trigger to replace "hi" with "bye" whenever you see it
+
local ok, err = function()
−
tempTrigger("hi", [[selectString("hi", 1) replace("bye")]])
+
if not ok then
−
</syntaxhighlight>
+
  debugc(f"Error: unable to do <particular thing> because {err}\n")
−
 
+
   return
−
<syntaxhighlight lang="lua">
 
−
-- this trigger will go off only 2 times
 
−
tempTrigger("hi", function() selectString("hi", 1) replace("bye") end, 2)
 
−
</syntaxhighlight>
 
−
 
 
−
<syntaxhighlight lang="lua">
 
−
-- table to store our trigger IDs in
 
−
nameIDs = nameIDs or {}
 
−
-- delete any existing triggers we've already got
 
−
for _, id in ipairs(nameIDs) do killTrigger(id) end
 
−
 
 
−
-- create new ones, avoiding lots of ]] [[ to embed the name
 
−
for _, name in ipairs{"Alice", "Ashley", "Aaron"} do
 
−
   nameIDs[#nameIDs+1] = tempTrigger(name, function() print(" Found "..name.."!") end)
 
 
end
 
end
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
;Additional Notes:
+
; Additional development notes
−
tempTriggers begin matching on the same line they're created on.
+
-- This function is still being written up.
−
 
 
−
If your ''code'' deletes and recreates the tempTrigger, or if you ''send'' a matching command again, it's possible to get into an infinite loop.
 
−
 
 
−
Make use of the ''expireAfter'' parameter, [[Manual:Lua_Functions#disableTrigger|disableTrigger()]], or [[Manual:Lua_Functions#killTrigger|killTrigger()]] to prevent a loop from forming.
 
  
 +
[[Category:Mudlet API]]
 
[[Category:Mudlet Manual]]
 
[[Category:Mudlet Manual]]
−
[[Category:Mudlet API]]
 

Revision as of 21:29, 11 January 2024

Networking Functions

A collection of functions for managing networking.

connectToServer

connectToServer(host, port, [save])
Connects to a given game.
Parameters
  • host:
Server domain or IP address.
  • port:
Servers port.
  • save:
(optional, boolean) if provided, saves the new connection parameters in the profile so they'll be used next time you open it.

Note Note: save is available in Mudlet 3.2+.

Example
connectToServer("midnightsun2.org", 3000)

-- save to disk so these parameters are used next time when opening the profile
connectToServer("midnightsun2.org", 3000, true)

disconnect

disconnect()
Disconnects you from the game right away. Note that this will not properly log you out of the game - use an ingame command for that. Such commands vary, but typically QUIT will work.
See also: reconnect()
Example
disconnect()

downloadFile

downloadFile(saveto, url)
Downloads the resource at the given url into the saveto location on disk. This does not pause the script until the file is downloaded - instead, it lets it continue right away and downloads in the background. When a download is finished, the sysDownloadDone event is raised (with the saveto location as the argument), or when a download fails, the sysDownloadError event is raised with the reason for failure. You may call downloadFile multiple times and have multiple downloads going on at once - but they aren’t guaranteed to be downloaded in the same order that you started them in.
See also: getHTTP(), postHTTP(), putHTTP(), deleteHTTP()
For privacy transparency, URLs accessed are logged in the Central Debug Console

Note Note: Since Mudlet 3.0, https downloads are supported and the actual url that was used for the download is returned - useful in case of redirects.

Example
-- just download a file and save it in our profile folder
local saveto = getMudletHomeDir().."/dark-theme-mudlet.zip"
local url = "http://www.mudlet.org/wp-content/files/dark-theme-mudlet.zip"
downloadFile(saveto, url)
cecho("<white>Downloading <green>"..url.."<white> to <green>"..saveto.."\n")



A more advanced example that downloads a webpage, reads it, and prints a result from it: 

-- create a function to parse the downloaded webpage and display a result
function downloaded_file(_, filename)
  -- is the file that downloaded ours?
  if not filename:find("achaea-who-count.html", 1, true) then return end

  -- read the contents of the webpage in
  local f, s, webpage = io.open(filename)
  if f then webpage = f:read("*a"); io.close(f) end
  -- delete the file on disk, don't clutter
  os.remove(filename)

  -- parse our downloaded file for the player count
  local pc = webpage:match([[Total: (%d+) players online]])
  display("Achaea has "..tostring(pc).." players on right now.")
end

-- register our function to run on the event that something was downloaded
registerAnonymousEventHandler("sysDownloadDone", "downloaded_file")

-- download a list of fake users for a demo
downloadFile(getMudletHomeDir().."/achaea-who-count.html", "https://www.achaea.com/game/who")

Result should look like this:

.

getConnectionInfo

getConnectionInfo()
Returns the server address and port that you're currently connected to, and (in Mudlet 4.12+) true or false indicating if you're currently connected to a game.
See also: connectToServer()
Mudlet VersionAvailable in Mudlet4.2+
Example
local host, port, connected = getConnectionInfo()
cecho(string.format("<light_grey>Playing on <forest_green>%s:%s<light_grey>, currently connected? <forest_green>%s\n", host, port, tostring(connected)))
-- echo the new connection parameters whenever we connect to a different host with connectToServer()
function echoInfo()
    local host, port = getConnectionInfo()
    cecho(string.format("<light_grey>Now connected to <forest_green>%s:%s\n", host, port))
  end

registerAnonymousEventHandler("sysConnectionEvent", "echoInfo")

getIrcChannels

getIrcChannels()
Returns a list of channels the IRC client is joined to as a lua table. If the client is not yet started the value returned is loaded from disk and represents channels the client will auto-join when started.
See also: setIrcChannels()
Mudlet VersionAvailable in Mudlet3.3+
Example
display(getIrcChannels())
-- Prints: {"#mudlet", "#lua"}

getIrcConnectedHost

getIrcConnectedHost()
Returns true+host where host is a string containing the host name of the IRC server, as given to the client by the server while starting the IRC connection. If the client has not yet started or finished connecting this will return false and an empty string.
This function can be particularly useful for testing if the IRC client has connected to a server prior to sending data, and it will not auto-start the IRC client.
The hostname value this function returns can be used to test if sysIrcMessage events are sent from the server or a user on the network.
Example
local status, hostname = getIrcConnectedHost()

if status == true then
  -- do something with connected IRC, send IRC commands, store 'hostname' elsewhere.
  -- if sysIrcMessage sender = hostname from above, message is likely a status, command response, or an error from the Server.
else 
  -- print a status, change connection settings, or just continue waiting to send IRC data.
end
Mudlet VersionAvailable in Mudlet3.3+

getIrcNick

getIrcNick()
Returns a string containing the IRC client nickname. If the client is not yet started, your default nickname is loaded from IRC client configuration.
See also: setIrcNick()
Mudlet VersionAvailable in Mudlet3.3+
Example
local nick = getIrcNick()
echo(nick)
-- Prints: "Sheldor"

getIrcServer

getIrcServer()
Returns the IRC client server name and port as a string and a number respectively. If the client is not yet started your default server is loaded from IRC client configuration.
See also: setIrcServer()
Mudlet VersionAvailable in Mudlet3.3+
Example
local server, port = getIrcServer()
echo("server: "..server..", port: "..port.."\n")

getNetworkLatency

getNetworkLatency()
Returns the last measured response time between the sent command and the server reply in seconds - e.g. 0.058 (=58 milliseconds lag) or 0.309 (=309 milliseconds). This is the N: number you see bottom-right of Mudlet.

Also known as server lag.

Example

Need example

openUrl

openUrl (url)
Opens the default OS browser for the given URL.
Example
openUrl("http://google.com")
openUrl("www.mudlet.org")

reconnect

reconnect()
Force-reconnects (so if you're connected, it'll disconnect) you to the game.
Example
-- you could trigger this on a log out message to reconnect, if you'd like
reconnect()

restartIrc

restartIrc()
Restarts the IRC client connection, reloading configurations from disk before reconnecting the IRC client.
Mudlet VersionAvailable in Mudlet3.3+

sendAll

sendAll(list of things to send, [echo back or not])
sends multiple things to the game. If you'd like the commands not to be shown, include false at the end.
See also: send()
Example
-- instead of using many send() calls, you can use one sendAll
sendAll("outr paint", "outr canvas", "paint canvas")
-- can also have the commands not be echoed
sendAll("hi", "bye", false)

sendATCP

sendATCP(message, what)
Need description
See also: ATCP Protocol, ATCP Extensions, Achaea Telnet Client Protocol specification, Description by forum user KaVir (2013), Description by forum user Iocun (2009)
Parameters
  • message:
The message that you want to send.
  • what:
Need description
Example

Need example

sendGMCP

sendGMCP(command)
Sends a GMCP message to the server. The IRE document on GMCP has information about what can be sent, and what tables it will use, etcetera.
Note that this function is rarely used in practice. For most GMCP modules, the messages are automatically sent by the server when a relevant event happens in the game. For example, LOOKing in your room prompts the server to send the room description and contents, as well as the GMCP message gmcp.Room. A call to sendGMCP would not be required in this case.
When playing an IRE game, a call to send(" ") afterwards is necessary due to a bug in the game with compression (MCCP) is enabled.
See also: GMCP Scripting for Discord status
Example
--This would send "Core.KeepAlive" to the server, which resets the timeout
sendGMCP("Core.KeepAlive")

--This would send a request for the server to send an update to the gmcp.Char.Skills.Groups table.
sendGMCP("Char.Skills.Get {}")

--This would send a request for the server to send a list of the skills in the 
--vision group to the gmcp.Char.Skills.List table.

sendGMCP("Char.Skills.Get " .. yajl.to_string{group = "vision"})

--And finally, this would send a request for the server to send the info for 
--hide in the woodlore group to the gmcp.Char.Skills.Info table

sendGMCP("Char.Skills.Get " .. yajl.to_string{group="MWP", name="block"})

sendMSDP

sendMSDP(variable[, value][, value...])
Sends a MSDP message to the server.
Parameters
  • variable:
The variable, in MSDP terms, that you want to request from the server.
  • value:
The variables value that you want to request. You can request more than one value at a time.
See Also: MSDP support in Mudlet, Mud Server Data Protocol specification
Example
-- ask for a list of commands, lists, and reportable variables that the server supports
sendMSDP("LIST", "COMMANDS", "LISTS", "REPORTABLE_VARIABLES")

-- ask the server to start keeping you up to date on your health
sendMSDP("REPORT", "HEALTH")

-- or on your health and location
sendMSDP("REPORT", "HEALTH", "ROOM_VNUM", "ROOM_NAME")

sendIrc

sendIrc(target, message)
Sends a message to an IRC channel or person. Returns true+status if message could be sent or was successfully processed by the client, or nil+error if the client is not ready for sending, and false+status if the client filtered the message or failed to send it for some reason. If the IRC client hasn't started yet, this function will initiate the IRC client and begin a connection.

To receive an IRC message, check out the sysIrcMessage event.

Note Note: Since Mudlet 3.3, auto-opens the IRC window and returns the success status.

Parameters
  • target:
nick or channel name and if omitted will default to the first available channel in the list of joined channels.
  • message:
The message to send, may contain IRC client commands which start with / and can use all commands which are available through the client window.
Example
-- this would send "hello from Mudlet!" to the channel #mudlet on freenode.net
sendIrc("#mudlet", "hello from Mudlet!")
-- this would send "identify password" in a private message to Nickserv on freenode.net
sendIrc("Nickserv", "identify password")

-- use an in-built IRC command
sendIrc("#mudlet", "/topic")

Note Note: The following IRC commands are available since Mudlet 3.3:

  • /ACTION <target> <message...>
  • /ADMIN (<server>)
  • /AWAY (<reason...>)
  • /CLEAR (<buffer>) -- Clears the text log for the given buffer name. Uses the current active buffer if none are given.
  • /CLOSE (<buffer>) -- Closes the buffer and removes it from the Buffer list. Uses the current active buffer if none are given.
  • /HELP (<command>) -- Displays some help information about a given command or lists all available commands.
  • /INFO (<server>)
  • /INVITE <user> (<#channel>)
  • /JOIN <#channel> (<key>)
  • /KICK (<#channel>) <user> (<reason...>)
  • /KNOCK <#channel> (<message...>)
  • /LIST (<channels>) (<server>)
  • /ME [target] <message...>
  • /MODE (<channel/user>) (<mode>) (<arg>)
  • /MOTD (<server>)
  • /MSG <target> <message...> -- Sends a message to target, can be used to send Private messages.
  • /NAMES (<#channel>)
  • /NICK <nick>
  • /NOTICE <#channel/user> <message...>
  • /PART (<#channel>) (<message...>)
  • /PING (<user>)
  • /RECONNECT -- Issues a Quit command to the IRC Server and closes the IRC connection then reconnects to the IRC server. The same as calling ircRestart() in Lua.
  • /QUIT (<message...>)
  • /QUOTE <command> (<parameters...>)
  • /STATS <query> (<server>)
  • /TIME (<user>)
  • /TOPIC (<#channel>) (<topic...>)
  • /TRACE (<target>)
  • /USERS (<server>)
  • /VERSION (<user>)
  • /WHO <mask>
  • /WHOIS <user>
  • /WHOWAS <user>

Note Note: The following IRC commands are available since Mudlet 3.15:

  • /MSGLIMIT <limit> (<buffer>) -- Sets the limit for messages to keep in the IRC client message buffers and saves this setting. If a specific buffer/channel name is given the limit is not saved and applies to the given buffer until the application is closed or the limit is changed again. For this reason, global settings should be applied first, before settings for specific channels/PM buffers.

sendTelnetChannel102

sendTelnetChannel102(msg)
Sends a message via the 102 subchannel back to the game (that's used in Aardwolf). The msg is in a two byte format; see the link below to the Aardwolf Wiki for how that works.
Example
-- turn prompt flags on:
sendTelnetChannel102("\52\1")

-- turn prompt flags off:
sendTelnetChannel102("\52\2")

To see the list of options that Aardwolf supports go to: Using Telnet negotiation to control MUD client interaction.

setIrcChannels

setIrcChannels(channels)
Saves the given channels to disk as the new IRC client channel auto-join configuration. This value is not applied to the current active IRC client until it is restarted with restartIrc()
See also: getIrcChannels(), restartIrc()
Parameters
  • channels:
A table containing strings which are valid channel names. Any channels in the list which aren't valid are removed from the list.
Mudlet VersionAvailable in Mudlet3.3+
Example
setIrcChannels( {"#mudlet", "#lua", "irc"} )
-- Only the first two will be accepted, as "irc" is not a valid channel name.

setIrcNick

setIrcNick(nickname)
Saves the given nickname to disk as the new IRC client configuration. This value is not applied to the current active IRC client until it is restarted with restartIrc()
See also: getIrcNick(), restartIrc()
Parameters
  • nickname:
A string with your new desired name in IRC.
Mudlet VersionAvailable in Mudlet3.3+
Example
setIrcNick( "Sheldor" )

setIrcServer

setIrcServer(hostname, port[, secure])
Saves the given server's address to disk as the new IRC client connection configuration. These values are not applied to the current active IRC client until it is restarted with restartIrc()
See also: getIrcServer(), restartIrc()
Parameters
  • hostname:
A string containing the hostname of the IRC server.
  • port:
(optional) A number indicating the port of the IRC server. Defaults to 6667, if not provided.
  • secure:
(optional) Boolean, true if server uses Transport Layer Security. Defaults to false.
Mudlet VersionAvailable in Mudlet3.3+
Example
setIrcServer("irc.libera.chat", 6667)

getHTTP

getHTTP(url, headersTable)
Sends an HTTP GET request to the given URL. Raises sysGetHttpDone on success or sysGetHttpError on failure.
See also: downloadFile().
For privacy transparency, URLs accessed are logged in the Central Debug Console
Parameters
  • url:
Location to send the request to.
  • headersTable:
(optional) table of headers to send with your request.
Mudlet VersionAvailable in Mudlet4.10+
Examples
function onHttpGetDone(_, url, body)
  cecho(string.format("<white>url: <dark_green>%s<white>, body: <dark_green>%s", url, body))
end

registerAnonymousEventHandler("sysGetHttpDone", onHttpGetDone)

getHTTP("https://httpbin.org/info")
getHTTP("https://httpbin.org/are_you_awesome", {["X-am-I-awesome"] = "yep I am"})
-- Status requests typically use GET requests
local url = "http://postman-echo.com/status"
local header = {["Content-Type"] = "application/json"}

-- first we create something to handle the success, and tell us what we got
registerAnonymousEventHandler('sysGetHttpDone', function(event, rurl, response)
  if rurl == url then display(r) else return true end -- this will show us the response body, or if it's not the right url, then do not delete the handler
end, true) -- this sets it to delete itself after it fires
-- then we create something to handle the error message, and tell us what went wrong
registerAnonymousEventHandler('sysGetHttpError', function(event, response, rurl)
  if rurl == url then display(r) else return true end -- this will show us the response body, or if it's not the right url, then do not delete the handler
end, true) -- this sets it to delete itself after it fires

-- Lastly, we make the request:
getHTTP(url, header)

-- Pop this into an alias and try it yourself!

postHTTP

postHTTP(dataToSend, url, headersTable, file)
Sends an HTTP POST request to the given URL, either as text or with a specific file you'd like to upload. Raises sysPostHttpDone on success or sysPostHttpError on failure.
See also: downloadFile(), getHTTP(), putHTTP(), deleteHTTP().
For privacy transparency, URLs accessed are logged in the Central Debug Console
Parameters
  • dataToSend:
Text to send in the request (unless you provide a file to upload).
  • url:
Location to send the request to.
  • headersTable:
(optional) table of headers to send with your request.
  • file:
(optional) file to upload as part of the POST request. If provided, this will replace 'dataToSend'.
If you use a scripting language (ex. PHP) to handle this post, remember that the file is sent as raw data. Expecially no field name is provided, dispite it works in common html post.
Mudlet VersionAvailable in Mudlet4.1+
Examples
function onHttpPostDone(_, url, body)
  cecho(string.format("<white>url: <dark_green>%s<white>, body: <dark_green>%s", url, body))
end

registerAnonymousEventHandler("sysPostHttpDone", onHttpPostDone)

postHTTP("why hello there!", "https://httpbin.org/post")
postHTTP("this us a request with custom headers", "https://httpbin.org/post", {["X-am-I-awesome"] = "yep I am"})
postHTTP(nil, "https://httpbin.org/post", {}, "<fill in file location to upload here, maybe get from invokeDialog>")
-- This will create a JSON message body. Many modern REST APIs expect a JSON body. 
local url = "http://postman-echo.com/post"
local data = {message = "I am the banana", user = "admin"}
local header = {["Content-Type"] = "application/json"}

-- first we create something to handle the success, and tell us what we got
registerAnonymousEventHandler('sysPostHttpDone', function(event, rurl, response)
  if rurl == url then display(response) else return true end -- this will show us the response body, or if it's not the right url, then do not delete the handler
end, true) -- this sets it to delete itself after it fires

-- then we create something to handle the error message, and tell us what went wrong
registerAnonymousEventHandler('sysPostHttpError', function(event, response, rurl)
  if rurl == url then display(response) else return true end -- this will show us the response body, or if it's not the right url, then do not delete the handler
end, true) -- this sets it to delete itself after it fires

-- Lastly, we make the request:
postHTTP(yajl.to_string(data), url, header) -- yajl.to_string converts our Lua table into a JSON-like string so the server can understand it

-- Pop this into an alias and try it yourself!
HTTP Basic Authentication Example

If your HTTP endpoint requires authentication to post data, HTTP Basic Authentication is a common method for doing so. There are two ways to do so.

OPTION 1: URL encoding: Many HTTP servers allow you to enter a HTTP Basic Authentication username and password at the beginning of the URL itself, in format: https://username:[email protected]/path/to/endpoint

OPTION 2: Authorization Header: Some HTTP servers may require you to put your Basic Authentication into the 'Authorization' HTTP header value.

This requires encoding the username:password into base64. For example, if your username is 'user' and your password is '12345', you'd need to run the string "user:12345" through a base64 encoder, which would result in the string: dXNlcjoxMjM0NQ==

Then, you'd need to set the HTTP header 'Authorization' field value to indicate it is using Basic auth and inserting the base64 string as: ['Authorization'] = "Basic dXNlcjoxMjM0NQ=="

As you're encoding your username and password, you probably want to do this encoding locally for security reasons. You also probably want to only use https:// and not http:// when sending usernames and passwords over the internet.

In the HTTP Basic Authentication example below, there is an inline base64Encode() function included: 

function base64Encode(data)
  -- Lua 5.1+ base64 v3.0 (c) 2009 by Alex Kloss <[email protected]>
  -- licensed under the terms of the LGPL2
  local b = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/'
    return ((data:gsub('.', function(x) 
        local r,b='',x:byte()
        for i=8,1,-1 do r=r..(b%2^i-b%2^(i-1)>0 and '1' or '0') end
        return r;
    end)..'0000'):gsub('%d%d%d?%d?%d?%d?', function(x)
        if (#x < 6) then return '' end
        local c=0
        for i=1,6 do c=c+(x:sub(i,i)=='1' and 2^(6-i) or 0) end
        return b:sub(c+1,c+1)
    end)..({ '', '==', '=' })[#data%3+1])
end
-- Example: base64Encode("user:12345") -> dXNlcjoxMjM0NQ== 

function postJSON(url,dataTable,headerTable)
  -- This will create a JSON message body. Many modern REST APIs expect a JSON body. 
  local data = dataTable or {text = "hello world"}
  local header = headerTable or {["Content-Type"] = "application/json"}
  -- first we create something to handle the success, and tell us what we got
  registerAnonymousEventHandler('sysPostHttpDone', function(event, rurl, response)
    if rurl == url then sL("HTTP response success"); echo(response) else return true end -- this will show us the response body, or if it's not the right url, then do not delete the handler
  end, true) -- this sets it to delete itself after it fires
  -- then we create something to handle the error message, and tell us what went wrong
  registerAnonymousEventHandler('sysPostHttpError', function(event, response, rurl)
    if rurl == url then sL("HTTP response error",3); echo(response) else return true end -- this will show us the response body, or if it's not the right url, then do not delete the handler
  end, true) -- this sets it to delete itself after it fires
  -- Lastly, we make the request:
  postHTTP(yajl.to_string(data), url, header) -- yajl.to_string converts our Lua table into a JSON-like string so the server can understand it
end

data = {
    message = "I am the banana",
    user = "admin"
}
header = {
    ["Content-Type"] = "application/json",
    ["Authorization"] = "Basic " .. base64Encode("user:12345")
}
postJSON("http://postman-echo.com/post",data,header)
URL Encoding vs JSON encoding

Some HTTP endpoints may not support JSON encoding, and instead may require URL encoding. Here's an example function to convert your lua data table into a URL encoded string:: 

-- Example: URLEncodeTable({message="hello",person="world"}) -> "message=hello&person=world"

function URLEncodeTable(Args)
  -- From: https://help.interfaceware.com/code/details/urlcode-lua
  ----------------------------------------------------------------------------
  -- URL-encode the elements of a table creating a string to be used in a
  -- URL for passing data/parameters to another script
  -- @param args Table where to extract the pairs (name=value).
  -- @return String with the resulting encoding.
  ----------------------------------------------------------------------------
  --
  local ipairs, next, pairs, tonumber, type = ipairs, next, pairs, tonumber, type
  local string = string
  local table = table
  
  --helper functions: 
  ----------------------------------------------------------------------------
  -- Decode an URL-encoded string (see RFC 2396)
  ----------------------------------------------------------------------------
  local unescape = function (str)
     str = string.gsub (str, "+", " ")
     str = string.gsub (str, "%%(%x%x)", function(h) return string.char(tonumber(h,16)) end)
     return str
  end
   
  ----------------------------------------------------------------------------
  -- URL-encode a string (see RFC 2396)
  ----------------------------------------------------------------------------
  local escape = function (str)
     str = string.gsub (str, "([^0-9a-zA-Z !'()*._~-])", -- locale independent
        function (c) return string.format ("%%%02X", string.byte(c)) end)
     str = string.gsub (str, " ", "+")
     return str
  end
   
  ----------------------------------------------------------------------------
  -- Insert a (name=value) pair into table [[args]]
  -- @param args Table to receive the result.
  -- @param name Key for the table.
  -- @param value Value for the key.
  -- Multi-valued names will be represented as tables with numerical indexes
  -- (in the order they came).
  ----------------------------------------------------------------------------
  local insertfield = function (args, name, value)
     if not args[name] then
        args[name] = value
     else
        local t = type (args[name])
        if t == "string" then
           args[name] = {args[name],value,}
        elseif t == "table" then
           table.insert (args[name], value)
        else
           error ("CGILua fatal error (invalid args table)!")
        end
     end
  end
  -- end helper functions 
    
  if Args == nil or next(Args) == nil then -- no args or empty args?
    return ""
  end
  local strp = ""
  for key, vals in pairs(Args) do
    if type(vals) ~= "table" then
       vals = {vals}
    end
    for i,val in ipairs(vals) do
       strp = strp.."&"..key.."="..escape(val)
    end
  end
  -- remove first &
  return string.sub(strp,2)
end

putHTTP

putHTTP(dataToSend, url, [headersTable], [file])
Sends an HTTP PUT request to the given URL, either as text or with a specific file you'd like to upload. Raises sysPutHttpDone on success or sysPutHttpError on failure.
See also: downloadFile(), getHTTP(), postHTTP(), deleteHTTP().
For privacy transparency, URLs accessed are logged in the Central Debug Console
Parameters
  • dataToSend:
Text to send in the request (unless you provide a file to upload).
  • url:
Location to send the request to.
  • headersTable:
(optional) table of headers to send with your request.
  • file:
(optional) file to upload as part of the PUT request. If provided, this will replace 'dataToSend'.
Mudlet VersionAvailable in Mudlet4.1+
Example
function onHttpPutDone(_, url, body)
  cecho(string.format("<white>url: <dark_green>%s<white>, body: <dark_green>%s", url, body))
end

registerAnonymousEventHandler("sysPutHttpDone", onHttpPutDone)
putHTTP("this us a request with custom headers", "https://httpbin.org/put", {["X-am-I-awesome"] = "yep I am"})
putHTTP("https://httpbin.org/put", "<fill in file location to upload here>")

deleteHTTP

deleteHTTP(url, headersTable)
Sends an HTTP DELETE request to the given URL. Raises sysDeleteHttpDone on success or sysDeleteHttpError on failure.
See also: downloadFile(), getHTTP(), postHTTP(), putHTTP().
For privacy transparency, URLs accessed are logged in the Central Debug Console
Parameters
  • url:
Location to send the request to.
  • headersTable:
(optional) table of headers to send with your request.
Mudlet VersionAvailable in Mudlet4.1+
Example
function onHttpDeleteDone(_, url, body)
  cecho(string.format("<white>url: <dark_green>%s<white>, body: <dark_green>%s", url, body))
end

registerAnonymousEventHandler("sysDeleteHttpDone", onHttpDeleteDone)

deleteHTTP("https://httpbin.org/delete")
deleteHTTP("https://httpbin.org/delete", {["X-am-I-awesome"] = "yep I am"})

customHTTP

customHTTP(method, url, headersTable)
Sends an custom method request to the given URL. Raises sysCustomHttpDone on success or sysCustomHttpError on failure.
See also: downloadFile(), getHTTP(), postHTTP(), putHTTP(), deleteHTTP().
Parameters
  • method:
Http method to use (eg. PATCH, HEAD etc.)
  • dataToSend:
Text to send in the request (unless you provide a file to upload).
  • url:
Location to send the request to.
  • headersTable:
(optional) table of headers to send with your request.
  • file:
(optional) file to upload as part of the PUT request. If provided, this will replace 'dataToSend'.
Mudlet VersionAvailable in Mudlet4.11+
Example
function onCustomHttpDone(_, url, body, method)
  cecho(string.format("<white>url: <dark_green>%s<white>, body: <dark_green>%s<white>, method: <dark_green>%s", url, body, method))
end

registerAnonymousEventHandler("sysCustomHttpDone", sysCustomHttpDone)

customHTTP("PATCH", "this us a request with custom headers", "https://httpbin.org/put", {["X-am-I-awesome"] = "yep I am"})
customHTTP("PATCH", "https://httpbin.org/put", "<fill in file location to upload here>")

sendSocket

sendSocket(data)
Sends given binary data as-is (or with some predefined special tokens converted to byte values) to the game. You can use this to implement support for a new telnet protocol, simultronics login etc.
success = sendSocket("data")
See also
feedTelnet(), feedTriggers()

Note Note: Modified in Mudlet tbd to accept some tokens like "<NUL>" to include byte values that are not possible to insert with the standard Lua string escape "\###" form where ### is a three digit number between 000 and 255 inclusive or where the value is more easily provided via a mnemonic. For the table of the tokens that are known about, see the one in feedTelnet().

Note Note: The data (as bytes) once the tokens have been converted to their byte values is sent as is to the Game Server; any encoding to, say, a UTF-8 representation or to duplicate 0xff byte values so they are not considered to be Telnet <IAC> (Interpret As Command) bytes must be done to the data prior to calling this function.

Parameters
  • data:
String containing the bytes to send to the Game Server possibly containing some tokens that are to be converted to bytes as well.
Returns
  • (Only since Mudlet tbd) Boolean true if the whole data string (after token replacement) was sent to the Server, false if that failed for any reason (including if the Server has not been connected or is now disconnected). nil and an error message for any other defect.
Example
-- Tell the Server that we are now willing and able to process  to process Ask the Server to a comment explaining what is going on, if there is multiple functionalities (or optional parameters) the examples should start simple and progress in complexity if needed!
-- the examples should be small, but self-contained so new users can copy & paste immediately without going diving in lots other function examples first.
-- comments up top should introduce / explain what it does

local something = function(exampleValue)
if something then
  -- do something with something (assuming there is a meaningful return value)
end

-- maybe another example for the optional second case
local somethingElse = function(exampleValue, anotherValue)

-- lastly, include an example with error handling to give an idea of good practice
local ok, err = function()
if not ok then
  debugc(f"Error: unable to do <particular thing> because {err}\n")
  return
end
Additional development notes

-- This function is still being written up.

feedTelnet

feedTelnet(data)
Sends given binary data with some predefined special tokens converted to byte values, to the internal telnet engine, as if it had been received from the game. This is primarily to enable testing when new Telnet sub-options/protocols are being developed. The data has to be injected into the system nearer to the point where the Game Server's data starts out than feedTriggers() and unlike the latter the data is not subject to any encoding so as to match the current profile's setting (which normally happens with feedTriggers()). Furthermore - to prevent this function from putting the telnet engine into a state which could damage the processing of real game data it will refuse to work unless the Profile is completely disconnected from the game server.
See also
feedTriggers(), sendSocket()
Mudlet VersionAvailable in Mudlettbd+

Note Note: This is not really intended for end-user's but might be useful in some circumstances.

Parameters
  • data
String containing the bytes to send to the internal telnet engine as if it had come from the Game Server, it can containing some tokens listed below that are to be converted to bytes as well.
Returns
  • Boolean true if the data string was sent to the internal telnet engine. nil and an error message otherwise, specifically the case when there is some traces of a connection or a complete connection to the socket that passes the data to and from the game server. Additionally, if the data is an empty string "" a second return value will be provided as an integer number representing a version for the table of tokens - which will be incremented each time a change is made to that table so that which tokens are valid can be determined. Note that unrecognised tokens should be passed through as is and not get replaced.
Token value table
Token Byte Version Notes
<00> \0x00 1 0 dec.
<O_BINARY> \0x00 1 Telnet option: Binary
<NUL> \0x00 1 ASCII control character: NULL
<01> \x01 1 1 dec.
<O_ECHO> \x01 1 Telnet option: Echo
<SOH> \x01 1 ASCII control character: Start of Heading
<02> \x02 1 2 dec. Telnet option: Reconnect
<STX> \x02 1 ASCII control character: Start of Text
<03> \x03 1 3 dec.
<O_SGA> \x03 1 Telnet option: Suppress Go Ahead
<ETX> \x03 1 ASCII control character: End of Text
<04> \x04 1 Telnet option: Approx Message Size Negotiation
<EOT> \x04 1 ASCII control character: End of Transmission
<05> \x05 1
<O_STATUS> \x05 1
<ENQ> \x05 1 ASCII control character: Enquiry
<06> \x06 1 Telnet option: Timing Mark
<ACK> \x06 1 ASCII control character: Acknowledge
<07> \x07 1 Telnet option: Remote Controlled Trans and Echo
<BELL> \x07 1 ASCII control character: Bell
<08> \x08 1 Telnet option: Output Line Width
<BS> \x08 1
<09> \x09 1 Telnet option: Output Page Size
<HTAB> \x09 1 ASCII control character: Horizontal Tab
<0A> \x0a 1 Telnet option: Output Carriage-Return Disposition
<LF> \x0a 1 ASCII control character: Line-Feed
<0B> \x0b 1 Telnet option: Output Horizontal Tab Stops
<VTAB> \x0b 1 ASCII control character: Vertical Tab
<0C> \x0c 1 Telnet option: Output Horizontal Tab Disposition
<FF> \x0c 1 ASCII control character: Form-Feed
<0D> \x0d 1 Telnet option: Output Form-feed Disposition
<CR> \x0d 1 ASCII control character: Carriage-Return
<0E> \x0e 1 Telnet option: Output Vertical Tab Stops
<SO> \x0e 1 ASCII control character: Shift-Out
<0F> \x0f 1 Telnet option: Output Vertical Tab Disposition
<SI> \x0f 1 ASCII control character: Shift-In
<10> \x10 1 Telnet option: Output Linefeed Disposition
<DLE> \x10 1 ASCII control character: Data Link Escape
<11> \x11 1 Telnet option: Extended ASCII
<DC1> \x11 1 ASCII control character: Device Control 1
<12> \x12 1 Telnet option: Logout
<DC2" \x12 1 ASCII control character: Device Control 2
<13> \x13 1 Telnet option: Byte Macro
<DC3> \x13 1 ASCII control character: Device Control 3
<14> \x14 1 Telnet option: Data Entry Terminal
<DC4> \x14 1 ASCII control character: Device Control 4
<15> \x15 1 Telnet option: SUPDUP
<NAK> \x15 1 ASCII control character: Negative Acknowledge
<16> \x16 1 Telnet option: SUPDUP Output
<SYN> \x16 1 ASCII control character: Synchronous Idle
<17> \x17 1 Telnet option: Send location
<ETB> \x17 1 ASCII control character: End of Transmission Block
<18> \x18 1
<O_TERM> \x18 1 Telnet option: Terminal Type
<CAN> \x18 1 ASCII control character: Cancel
<19> \x19 1
<O_EOR> \x19 1 Telnet option: End-of-Record
<EM> \x19 1 ASCII control character: End of Medium
<1A> \x1a 1 Telnet option: TACACS User Identification
<SUB> \x1a 1 ASCII control character: Substitute
<1B> \x1b 1 Telnet option: Output Marking
<ESC> \x1b 1 ASCII control character: Escape
<1C> \x1c 1 Telnet option: Terminal Location Number
<FS> \x1c 1 ASCII control character: File Separator
<1D> \x1d 1 Telnet option: Telnet 3270 Regime
<GS> \x1d 1 ASCII control character: Group Separator
<1E> \x1e 1 Telnet option: X.3 PAD
<RS> \x1e 1 ASCII control character: Record Separator
<1F> \x1f 1
<O_NAWS> \x1f 1 Telnet option: Negotiate About Window Size
<US> \x1f 1 ASCII control character: Unit Separator
<SP> \x20 1 32 dec. ASCII character: Space
<O_NENV> \x27 1 39 dec. Telnet option: New Environment (also MNES)
<O_CHARS> \x2a 1 42 dec. Telnet option: Character Set
<O_KERMIT> \x2f 1 47 dec. Telnet option: Kermit
<O_MSDP> \x45 1 69 dec. Telnet option: Mud Server Data Protocol
<O_MSSP> \x46 1 70 dec. Telnet option: Mud Server Status Protocol
<O_MCCP> \x55 1 85 dec
<O_MCCP2> \x56 1 86 dec
<O_MSP> \x5a 1 90 dec. Telnet option: Mud Sound Protocol
<O_MXP> \x5b 1 91 dec. Telnet option: Mud eXtension Protocol
<O_ZENITH> \x5d 1 93 dec. Telnet option: Zenith Mud Protocol
<O_AARDWULF> \x66 1 102 dec. Telnet option: Aardwuld Data Protocol
<DEL> \x7f 1 127 dec. ASCII control character: Delete
<O_ATCP> \xc8 1 200 dec
<O_GMCP> \xc9 1 201 dec
<T_EOR> \xef 1 239 dec
<F0> \xf0 1
<T_SE> \xf0 1
<F1> \xf1 1
<T_NOP> \xf1 1
<F2> \xf2 1
<T_DM> \xf2 1
<F3> \xf3 1
<T_BRK> \xf3 1
<F4> \xf4 1
<T_IP> \xf4 1
<F5> \xf5 1
<T_ABOP> \xf5 1
<F6> \xf6 1
<T_AYT> \xf6 1
<F7> \xf7 1
<T_EC> \xf7 1
<F8> \xf8 1
<T_EL> \xf8 1
<F9> \xf9 1
<T_GA> \xf9 1
<FA> \xfa 1
<T_SB> \xfa 1
<FB> \xfb 1
<T_WILL> \xfb 1
<FC> \xfc 1
<T_WONT> \xfc 1
<FD> \xfd 1
<T_DO> \xfd 1
<FE> \xfe 1
<T_DONT> \xfe 1
<FF> \xff 1
<T_IAC> \xff'
Example
-- a comment explaining what is going on, if there is multiple functionalities (or optional parameters) the examples should start simple and progress in complexity if needed!
-- the examples should be small, but self-contained so new users can copy & paste immediately without going diving in lots other function examples first.
-- comments up top should introduce / explain what it does

local something = feedTelnet(exampleValue)
if something then
  -- do something with something (assuming there is a meaningful return value)
end

-- maybe another example for the optional second case
local somethingElse = function(exampleValue, anotherValue)

-- lastly, include an example with error handling to give an idea of good practice
local ok, err = function()
if not ok then
  debugc(f"Error: unable to do <particular thing> because {err}\n")
  return
end
Additional development notes

-- This function is still being written up.

Retrieved from "https://wiki.mudlet.org/index.php?title=User:Molideus&oldid=20748"