Manual:Lua Functions - Revision history

Missionz3r0: Add TOC limit

2026-02-28T19:39:47Z

Add TOC limit

Zooka: bundled modules

2024-05-04T08:04:17Z

bundled modules

Vadi at 10:39, 8 November 2021

2021-11-08T10:39:41Z

Vadi at 10:39, 8 November 2021

2021-11-08T10:39:18Z

Vadi: Split out Lua function basics into its own page

2021-11-08T10:38:35Z

Split out Lua function basics into its own page

Dargoth at 10:38, 4 February 2021

2021-02-04T10:38:23Z

Atari2600tim: Anchors in categories section were using things like basic-essentials rather than Basic_Essentials. Also they are within same page.

2021-01-08T17:08:24Z

Anchors in categories section were using things like basic-essentials rather than Basic_Essentials. Also they are within same page.

Vadi: Add note to Lua 5.1

2021-01-07T16:37:01Z

Add note to Lua 5.1

Kebap: rename MUD to game everywhere

2021-01-05T11:22:05Z

rename MUD to game everywhere

Kebap: add description text for page

2021-01-05T10:12:40Z

add description text for page

@@ Line 1: / Line 1: @@
 <languages/>
-{{TOC right}}
+{{TOC right|limit=3}}
 {{#description2: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.}}

@@ Line 43: / Line 43: @@
 [[#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].
+Additionally, more advanced functions are available in the [https://www.lua.org/manual/5.1/ Lua 5.1 manual].  Mudlet also includes [[Compiling_Mudlet#Lua_.26_Luarocks|several bundled modules]] to assist with various additional tasks, or you can add your own.
 {{Manual:Basic Essentials}}

@@ Line 5: / Line 5: @@
 {{Manual:Lua Functions Basics}}
 = Function Categories = <!--T:4-->
 [[#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.
@@ Line 43: / Line 42: @@
 [[#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].
 {{Manual:Basic Essentials}}

@@ Line 3: / Line 3: @@
 {{#description2: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.}}
-{{Manual:Lua Function Basics}}
+{{Manual:Lua Functions Basics}}
 <translate>

@@ Line 2: / Line 2: @@
 {{TOC right}}
 {{#description2: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.}}
-= Global variables = <!--T:2-->
+{{Manual:Lua Function Basics}}
 = Function Categories = <!--T:4-->
 [[#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.
@@ Line 122: / Line 76: @@
 [[Category:Mudlet Manual]]
-[[Category: Mudlet API]]
+[[Category:Mudlet API]]

@@ Line 27: / Line 27: @@
 If the Perl trigger indicated 'match all' (same effect as the Perl /g switch) to evaluate all possible matches of the given regex within the current line, matches[n+1] will hold the second entire match, matches[n+2] the first capture group of the second match and matches[n+m]
 the m-th capture group of the second match.
 |-
 |colspan="2" | <code>multimatches[n][m]</code>
@@ Line 41: / Line 44: @@
 |-
 |colspan="2" | <code>mudlet.supports</code>
-|colspan="4" | Lists special functionality that the users Mudlet supports - right now, just <code>mudlet.supports.coroutines</code> is listed. Use <code>mudlet.supports</code> to conditionally enable functionality as it's available on the users Mudlet.
+|colspan="4" | Lists special functionality that the users Mudlet supports - right now, just <code>mudlet.supports.coroutines</code> & <code>mudlet.supports.namedGroups</code> is listed. Use <code>mudlet.supports</code> to conditionally enable functionality as it's available on the users Mudlet.
 |-
 |colspan="2" | <code>color_table</code>

@@ Line 50: / Line 50: @@
 = Function Categories = <!--T:4-->
-[[Special:MyLanguage/Manual:Lua_Functions#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.
+[[#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.
 <!--T:5-->
-[[Special:MyLanguage/Manual:Lua_Functions#database-functions | Database Functions]]: A collection of functions for helping deal with the database.
+[[#Database_Functions | Database Functions]]: A collection of functions for helping deal with the database.
 <!--T:6-->
-[[Special:MyLanguage/Manual:Lua_Functions#date/time-functions | Date/Time Functions]]: A collection of functions for handling date & time.
+[[#Date_.26_Time_Functions | Date/Time Functions]]: A collection of functions for handling date & time.
 <!--T:7-->
-[[Special:MyLanguage/Manual:Lua_Functions#file-system functions | File System Functions]]: A collection of functions for interacting with the file system.
+[[#File_System_Functions | File System Functions]]: A collection of functions for interacting with the file system.
 <!--T:8-->
-[[Special:MyLanguage/Manual:Lua_Functions#mapper-functions | Mapper Functions]]: A collection of functions that manipulate the mapper and its related features.
+[[#Mapper_Functions | Mapper Functions]]: A collection of functions that manipulate the mapper and its related features.
 <!--T:9-->
-[[Special:MyLanguage/Manual:Lua_Functions#miscellaneous-functions | Miscellaneous Functions]]: Miscellaneous functions.
+[[#Miscellaneous_Functions | Miscellaneous Functions]]: Miscellaneous functions.
 <!--T:10-->
-[[Special:MyLanguage/Manual:Lua_Functions#mudlet-object functions | Scripting Object Functions]]: A collection of arrows that manipulate Mudlets scripting objects - triggers, aliases, and so forth.
+[[#Mudlet_Object_Functions | Scripting Object Functions]]: A collection of arrows that manipulate Mudlets scripting objects - triggers, aliases, and so forth.
 <!--T:11-->
-[[Special:MyLanguage/Manual:Lua_Functions#networking-functions | Networking Functions]]: A collection of functions for managing networking.
+[[#Networking_Functions | Networking Functions]]: A collection of functions for managing networking.
 <!--T:12-->
-[[Special:MyLanguage/Manual:Lua_Functions#string-functions | String Functions]]: These functions are used to manipulate strings.
+[[#String_Functions | String Functions]]: These functions are used to manipulate strings.
 <!--T:14-->
-[[Special:MyLanguage/Manual:Lua_Functions#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.
+[[#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.
 <!--T:15-->
-[[Special:MyLanguage/Manual:Lua_Functions#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.
+[[#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.
 <!--T:16-->
-[[Special:MyLanguage/Manual:Lua_Functions#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.
+[[#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.
-[[Special:MyLanguage/Manual:Lua_Functions#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]].
+[[#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]].
 </translate>

← Older revision		Revision as of 16:37, 7 January 2021
Line 86:		Line 86:

	[[Special:MyLanguage/Manual:Lua_Functions#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]].		[[Special:MyLanguage/Manual:Lua_Functions#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]].
		+	</translate>
		+
		+	<translate>
		+	Additionally, more advanced functions are available in the [https://www.lua.org/manual/5.1/ Lua 5.1 manual].
	</translate>		</translate>

@@ Line 20: / Line 20: @@
 |-
 |colspan="2" | <code>line</code>
-|colspan="4" | This variable holds the content of the current line as being processed by the trigger engine. The engine runs all triggers on each line as it arrives from the MUD.
+|colspan="4" | This variable holds the content of the current line as being processed by the trigger engine. The engine runs all triggers on each line as it arrives from the game.
 |-
 |colspan="2" | <code>matches[n]</code>
@@ Line 47: / Line 47: @@
 |}
-There are other variables that hold MUD-protocol data that are global as well - see [[Special:MyLanguage/Manual:Technical_Manual#Supported_Protocols|Supported Protocols]].
+There are other variables that hold the game's MUD-protocol data that are global as well - see [[Special:MyLanguage/Manual:Technical_Manual#Supported_Protocols|Supported Protocols]].
 = Function Categories = <!--T:4-->