Manual:Technical Manual TOC - Revision history

Vadi: Plug screen readers in

2022-12-25T20:02:33Z

Plug screen readers in

Vadi: Add link to JSON API

2021-11-10T15:01:44Z

Add link to JSON API

Vadi: Add link to Lua API as a whole

2021-11-08T10:51:42Z

Add link to Lua API as a whole

Vadi: Formatting

2021-11-08T10:43:57Z

Formatting

Vadi: Create Mudlet TOC version

2021-11-08T10:43:05Z

Create Mudlet TOC version

New page

<languages/>
{{#description2:Table of contents to the Mudlet API documentation including explanation of usage, expected behavior and examples for all available functions which were added on top of the regular Lua functions.}}

This is a table of contents view on the Mudlet manual. Looking for the one-page version? [[Manual:Technical_Manual|Available here]].

# [[Manual:General Features|General Mudlet features]]
# [[Manual:Using Variables in Mudlet|Using variables in Mudlet]]
# [[Manual:Alias Engine|Alias engine]]
# [[Manual:Trigger Engine|Trigger engine]]
# [[Manual:Timer Engine|Timer engine]]
# [[Manual:Event_Engine|Event engine]]
# [[Manual:Editor|Editor]]
# [[Manual:Unicode|Unicode]]
# [[Manual:Mapper|Mapper]]
# [[Manual:Advanced Lua|Advanced Lua]]
# [[Manual:Supported Protocols]]
# [[Manual:Mudlet_Packages|Mudlet packages]]
# [[Manual:Scripting|Scripting]]
# [[Manual:Best Practices|Best practices]]
# Lua API:

= API Categories =
[[Manual:Basic_Essentials | 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.

[[Manual:Database_Functions | Database Functions]]: A collection of functions for helping deal with the database.

[[Manual:Date/Time Functions | Date/Time Functions]]: A collection of functions for handling date & time.

[[Manual:File_System_Functions | File System Functions]]: A collection of functions for interacting with the file system.

[[Manual:Mapper_Functions | Mapper Functions]]: A collection of functions that manipulate the mapper and its related features.

[[Manual:Miscellaneous_Functions | Miscellaneous Functions]]: Miscellaneous functions.

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

[[Manual:Networking_Functions | Networking Functions]]: A collection of functions for managing networking.

[[Manual:String_Functions | String Functions]]: These functions are used to manipulate strings.

[[Manual:Table_Functions | 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.

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

[[Manual:UI_Functions | 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.

[[Manual:Discord_Functions | 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 [[Special:MyLanguage/Manual:Scripting#Discord_Rich_Presence|Discord scripting overview]].

Additionally, more advanced functions are available in the [https://www.lua.org/manual/5.1/ Lua 5.1 manual].

@@ Line 18: / Line 18: @@
 # [[Manual:Scripting|Scripting]]
 # [[Manual:Best Practices|Best practices]]
-# [[Manual:Lua Functions|Lua API]]
+# [[Manual:Lua Functions|Lua API]] ([https://github.com/Mudlet/Mudlet/blob/development/src/lua-function-list.json condensed list])
 = Lua API Categories =

@@ Line 16: / Line 16: @@
 # [[Manual:Supported Protocols]]
 # [[Manual:Mudlet_Packages|Mudlet packages]]
 # [[Manual:Scripting|Scripting]]
 # [[Manual:Best Practices|Best practices]]

@@ Line 20: / Line 20: @@
 # Lua API:
-= API Categories =
+= Lua API Categories =
 [[Manual:Basic_Essentials | 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.