Manual:Technical Manual TOC

From Mudlet
Jump to navigation Jump to search


This is a table of contents view on the Mudlet manual. Looking for the one-page version? Available here.

  1. General Mudlet features
  2. Using variables in Mudlet
  3. Alias engine
  4. Trigger engine
  5. Timer engine
  6. Event engine
  7. Editor
  8. Unicode
  9. Mapper
  10. Advanced Lua
  11. Manual:Supported Protocols
  12. Mudlet packages
  13. Screen readers
  14. Scripting
  15. Best practices
  16. Lua API (condensed list)

Lua API Categories

Basic Essential Functions: These functions are generic functions used in normal scripting. These deal with mainly everyday things, like sending stuff and echoing to the screen.

Database Functions: A collection of functions for helping deal with the database.

Date/Time Functions: A collection of functions for handling date & time.

File System Functions: A collection of functions for interacting with the file system.

Mapper Functions: A collection of functions that manipulate the mapper and its related features.

Miscellaneous Functions: Miscellaneous functions.

Scripting Object Functions: A collection of arrows that manipulate Mudlets scripting objects - triggers, aliases, and so forth.

Networking Functions: A collection of functions for managing networking.

String Functions: These functions are used to manipulate strings.

Table Functions: These functions are used to manipulate tables. Through them you can add to tables, remove values, check if a value is present in the table, check the size of a table, and more.

Text to Speech Functions: These functions are used to create sound from written words. Check out our Text-To-Speech Manual for more detail on how this all works together.

UI Functions: These functions are used to construct custom user GUIs. They deal mainly with miniconsole/label/gauge creation and manipulation as well as displaying or formatting information on the screen.

Discord Functions: These functions are used to customize the information Mudlet displays in Discord's rich presence interface. For an overview on how all of these functions tie in together, see our Discord scripting overview.

Additionally, more advanced functions are available in the Lua 5.1 manual.