Manual:Miscellaneous Functions

Miscellaneous Functions

addSupportedTelnetOption

addSupportedTelnetOption(option)

Adds a telnet option, which when queried by a MUD server, Mudlet will return DO (253) on. Use this to register the telnet option that you will be adding support for with Mudlet - see additional protocols section for more.

Example

<lua> <event handlers that add support for MSDP... see http://www.mudbytes.net/index.php?a=topic&t=4104&p=63920#p63920 for an example>

-- register with Mudlet that it should not decline the request of MSDP support local TN_MSDP = 69 addSupportedTelnetOption(TN_MSDP) </lua>

expandAlias

expandAlias(command,true/false)

Runs the command as if it was from the command line - so aliases are checked and if none match, it's sent to the the game. If the second argument is false, it will hide the command from being echoed back in your buffer. Defaults to true.

Example

<lua> expandAlias("t rat")

-- don't echo the command expandAlias("t rat", false) </lua>

Note: If you want to be using the matches table after calling expandAlias, you should save it first as local oldmatches = matches before calling expandAlias, since expandAlias will overwrite it after using it again.

feedTriggers

feedTriggers( text )

This function will have Mudlet parse the given text as if it came from the MUD - one great application is trigger testing. You can use \n to represent a new line - you also want to use it before and after the text you’re testing, like so:

<lua> feedTriggers("\nYou sit yourself down.\n") </lua>

The function also accept ANSI color codes that are used in MUDs. A sample table can be found here.

Example

<lua> feedTriggers("\nThis is \27[1;32mgreen\27[0;37m, \27[1;31mred\27[0;37m, \27[46mcyan background\27[0;37m," .. "\27[32;47mwhite background and green foreground\27[0;37m.\n") </lua>

getModulePath

path = getModulePath(module name)

Returns the location of a module on the disk.

See also: installModule()

Example

<lua> getModulePath("mudlet-mapper") </lua>

getModulePriority

priority = getModulePriority(module name)

Returns the priority of a module as an integer. This determines the order modules will be loaded in - default is 0. Useful if you have a module that depends on another module being loaded first, for example.

See also: setModulePriority()

Example

<lua> getModulePriority("mudlet-mapper") </lua>

getMudletHomeDir

getMudletHomeDir()

Returns the current home directory of the current profile. This can be used to store data, save statistical information, or load resource files from packages.

Example

<lua> -- save a table table.save(getMudletHomeDir().."/myinfo.dat", myinfo)

-- or access package data. The forward slash works even on Windows fine local path = getMudletHomeDir().."/mypackagename" </lua>

installModule

installModule(location)

Installs a Mudlet XML or zip as a module.

Parameters

• location:

Exact location of the file install.

See also: uninstallModule()

Example

<lua> installModule(C:\Documents and Settings\bub\Desktop\myalias.xml) </lua>

installPackage

installPackage(location)

Installs a Mudlet XML or package.

Parameters

• location:

Exact location of the xml or package to install.

See also: uninstallPackage()

Example

<lua> installPackage(C:\Documents and Settings\bub\Desktop\myalias.xml) </lua>

playSoundFile

playSoundFile(fileName)

This function plays a sound file. On 2.0, it can play most sound formats and up to 4 sounds simulaneously.

Parameters

• fileName:

Exact path of the sound file.

Example

<lua> -- play a sound in Windows playSoundFile(C:\My folder\boing.wav)

-- play a sound in Linux playSoundFile(/home/myname/Desktop/boingboing.wav)

-- play a sound from a package playSoundFile(getMudletHomeDir().. /mypackage/boingboing.wav) </lua>

registerAnonymousEventHandler

registerAnonymousEventHandler(event name, function name)

Registers a function to an event handler, not requiring you to set one up via s cript.

At the moment, it's not possible to use handlers inside namespaces, or unregister them.

Example

<lua> -- example taken from the God Wars 2 (http://godwars2.org) Mudlet UI - forces the window to keep to a certain size function keepStaticSize()

 setMainWindowSize(1280,720)

end -- keepStaticSize

registerAnonymousEventHandler("sysWindowResizeEvent", "keepStaticSize") </lua>

resetProfile

resetProfile()

Reloads your entire Mudlet profile - as if you've just opened it. All UI elements will be cleared, so this useful when you're coding your UI. To use this function, call it and then receive input from the game - that will trigger Mudlet to do the reset.

sendSocket

sendSocket(data)

Sends given binary data as-is to the MUD. You can use this to implement support for a new telnet protocol, simultronics login or etcetera.

Example

<lua> TN_IAC = 255 TN_WILL = 251 TN_DO = 253 TN_SB = 250 TN_SE = 240 TN_MSDP = 69

MSDP_VAL = 1 MSDP_VAR = 2

sendSocket( string.char( TN_IAC, TN_DO, TN_MSDP ) ) -- sends IAC DO MSDP

--sends: IAC SB MSDP MSDP_VAR "LIST" MSDP_VAL "COMMANDS" IAC SE local msg = string.char( TN_IAC, TN_SB, TN_MSDP, MSDP_VAR ) .. " LIST " ..string.char( MSDP_VAL ) .. " COMMANDS " .. string.char( TN_IAC, TN_SE ) sendSocket( msg ) </lua>

spawn

spawn(read function, process to spawn)

Spawns a process and opens a communicatable link with it - read function is the function you'd like to use for reading output from the process, and t is a table containing functions specific to this connection - send(data), true/false = isRunning(), and close().

Example

<lua> -- simple example on a program that quits right away, but prints whatever it gets using the 'display' function local f = spawn(display, "ls") display(f.isRunning()) f.close() </lua>

stopSounds

stopSounds()

Stops all currently playing sounds.

Note: Available in Mudlet 3.0.

See also: playSoundFile()

Example

<lua> stopSounds() </lua>

uninstallModule

uninstallModule(name)

Uninstalls a Mudlet module with the given name.

See also: installModule()

Example

<lua> uninstallModule("myalias") </lua>

uninstallPackage

uninstallPackage(name)

Uninstalls a Mudlet package with the given name.

See also: installPackage()

Example

<lua> uninstallPackage("myalias") </lua>

yajl.to_string

yajl.to_string(data)

Encodes a Lua table into JSON data and returns it as a string. This function is very efficient - if you need to encode into JSON, use this.

Example

<lua> -- on IRE MUDs, you can send a GMCP request to request the skills in a particular skillset. Here's an example: sendGMCP("Char.Skills.Get "..yajl.to_string{group = "combat"})

-- you can also use it to convert a Lua table into a string, so you can, for example, store it as room's userdata local toserialize = yajl.to_string(continents) setRoomUserData(1, "areaContinents", toserialize) </lua>

yajl.to_value

yajl.to_value(data)

Decodes JSON data (as a string) into a Lua table. This function is very efficient - if you need to dencode into JSON, use this.

Example

<lua> -- given the serialization example above with yajl.to_string, you can deserialize room userdata back into a table local tmp = getRoomUserData(1, "areaContinents") if tmp == "" then return end

local continents = yajl.to_value(tmp) display(continents) </lua>