Introduction to lua - Revision history

Zooka: /* Generic For Loop */

2025-11-01T23:58:08Z

Generic For Loop

2025-11-01T23:35:04Z

Variables

2025-11-01T23:33:51Z

Tables

2025-11-01T23:06:14Z

Tables

2025-11-01T23:04:47Z

Functions

2025-11-01T23:02:39Z

Introduction to Lua

2025-11-01T23:02:02Z

Introduction to Lua

2025-11-01T22:53:51Z

Generic For Loop

2025-11-01T06:06:05Z

Introduction to Lua

2025-11-01T06:04:10Z

Iteration - for loop

@@ Line 268: / Line 268: @@
    hp is 500
-<code>ipairs</code> is also available to return a key when one doesn't exist already, as in our friends table.
+<code>ipairs</code> is also available and it will return a numerical index number which we could apply to our friends table.
-   for k, v in ipairs(friends) do
+   for index, value in ipairs(friends) do
-     print(f"{key} is {friends[key]}")
+     print(f"{index} is {friends[index]}")
    end
@@ Line 280: / Line 280: @@
 is Jeff
-{{note}} A table can contain tables are values!
+{{note}} A table can contain tables as values!
 == Functions ==

@@ Line 41: / Line 41: @@
 <code>gold</code> started off as <code>100</code> but then later was assigned the sum; it now holds <code>110</code>.
-To add (or concatenate) strings together;
+To join (or concatenate) strings together;
    enemy = "ogre"

@@ Line 102: / Line 102: @@
    target = enemies[3]  -- target now contains goblin
-Tables can also be added to after that have been created;
+Tables can also be added to after thay have been created;
    myStats.mana = 50

@@ Line 102: / Line 102: @@
    target = enemies[3]  -- target now contains goblin
-Tables can also be added to later;
+Tables can also be added to after that have been created;
    myStats.mana = 50

@@ Line 285: / Line 285: @@
 ''Functions'' are pieces of code that perform a certain task, much like a response to a trigger or a button press.  Functions are the basis for reusable code and allow you to write some code once and reuse it many times over.  Functions are ''called'' whenever they need to be ''run''.  You are already familiar with send and echo (if not read the [[Manual:Introduction|introduction]] first), those are both functions being called when we want them to run.
 Functions use the following syntax;
@@ Line 354: / Line 360: @@
 {{note}} Functions can also have scope (global or local) just like variables.

@@ Line 5: / Line 5: @@
 Lua is the programming language used by Mudlet to perform various tasks.  Lua is used in all sorts of ways from game engines to home automation.  The Lua version Mudlet uses is 5.1 and the [https://www.lua.org/manual/5.1/ official manual can be found here].  This page aims to describe the ''syntax'' (grammar and structure) Lua uses so you can become more familiar with the language and write useful scripts to help you in game.  It will introduce various programming concepts such as variables, conditions, loops, etc.. with an eye towards how this can be used in everyday MUDding.
-Mudlet users tend to call snippets of code written in Mudlet '''scripts'''.  These snippets can be used throughout the Script Editor; in triggers, aliases, keybindings, timers and a dedicated script area where you might store your functions which are discussed later.
+Mudlet users tend to call snippets of code written in Mudlet ''scripts''.  These scripts can be used throughout the Script Editor; in triggers, aliases, keybindings, timers and a dedicated script area where you might store your functions which are discussed later.
 {{note}} Have a read through the [[Manual:Introduction|Introduction to Mudlet]] page if you haven't already, it provides a good walkthrough of the features and terminology Mudlet uses.

← Older revision		Revision as of 23:02, 1 November 2025
Line 6:		Line 6:

	Mudlet users tend to call snippets of code written in Mudlet '''scripts'''. These snippets can be used throughout the Script Editor; in triggers, aliases, keybindings, timers and a dedicated script area where you might store your functions which are discussed later.		Mudlet users tend to call snippets of code written in Mudlet '''scripts'''. These snippets can be used throughout the Script Editor; in triggers, aliases, keybindings, timers and a dedicated script area where you might store your functions which are discussed later.
		+
		+	{{note}} Have a read through the [[Manual:Introduction\|Introduction to Mudlet]] page if you haven't already, it provides a good walkthrough of the features and terminology Mudlet uses.

	== Variables ==		== Variables ==

@@ Line 254: / Line 254: @@
    gold is 100
-Notice how they aren't in the original order defined when creating the variable.  Tables do not necessarily keep their order.  If order matters, sort the table first. <code>spairs</code> can return a sorted table (default is alphanumeric sorting by key).
+Notice how they aren't in the original order defined when creating the variable.  Tables do not necessarily keep their order.  If order matters, sort the table first.  Using <code>spairs</code> as the iterator function can return a sorted table (default is alphanumeric sorting by key).
    for k, v in spairs(myStats) do
@@ Line 260: / Line 260: @@
    end
-will result in
+will result in this alphabetically sorted output;
    class is cleric
@@ Line 278: / Line 278: @@
 is Jeff
-{{note}} Table can contain tables are values!
+{{note}} A table can contain tables are values!
 == Functions ==

← Older revision		Revision as of 06:06, 1 November 2025
Line 354:		Line 354:

	=== In-built Functions ===		=== In-built Functions ===
−	~~=== Custom Functions ===~~	+
		+	Mudlet has a load of in-built function to make your life easier. See the [[Manual:Lua API\|Lua API for the entire list.]]

@@ Line 215: / Line 215: @@
    local friends = { "Bob", "Sally", "Jeff" }
-−
    for i = 1, #friends do
      send(f"cast heal {friends[i]}")
@@ Line 243: / Line 243: @@
    local myStats = { hp = 500, class = "cleric", gold = 100 }
-−
    for key, value in pairs(myStats) do
      print(f"{key} is {value}")