Manual:Event Engine - Revision history

Tamarindo: /* sysSettingChanged */

2026-02-04T00:56:02Z

sysSettingChanged

Tamarindo: /* sysMapWindowMousePressEvent */

2026-02-04T00:54:00Z

sysMapWindowMousePressEvent

Tamarindo: /* sysLoadEvent */

2026-02-04T00:51:04Z

sysLoadEvent

Tamarindo: /* sysConsoleSizeChanged */

2026-02-04T00:49:04Z

sysConsoleSizeChanged

Tamarindo: /* sysScrollBoxDeleted */

2026-02-04T00:22:22Z

sysScrollBoxDeleted

Tamarindo: /* sysCommandLineDeleted */

2026-02-04T00:17:52Z

sysCommandLineDeleted

Tamarindo: /* sysMiniConsoleDeleted */

2026-02-04T00:08:28Z

sysMiniConsoleDeleted

Tamarindo: /* sysMiniConsoleDeleted */

2026-02-04T00:04:02Z

sysMiniConsoleDeleted

Tamarindo: /* sysLabelDeleted */

2026-02-04T00:01:57Z

sysLabelDeleted

Slysven: /* sysWindowOverflowEvent */ Make links to enableScrolling and disableScrolling functions red-links - as they haven't been documented yet.

2025-02-19T00:57:09Z

sysWindowOverflowEvent: Make links to enableScrolling and disableScrolling functions red-links - as they haven't been documented yet.

@@ Line 702: / Line 702: @@
 -- Output: ScrollBox 'messageBox' has been deleted.
 </syntaxhighlight>
 ===sysSoundFinished===

← Older revision		Revision as of 00:54, 4 February 2026
Line 553:		Line 553:

	Raised whenever an [[Standards:MMP\|MMP map]] is downloaded and loaded in.		Raised whenever an [[Standards:MMP\|MMP map]] is downloaded and loaded in.
		+
		+	===sysMapWindowMousePressEvent===
		+	Raised when the mouse is left-clicked on the mapper window.
		+
		+	{{MudletVersion\|4.20}}

	===sysMiniConsoleDeleted===		===sysMiniConsoleDeleted===

← Older revision		Revision as of 00:51, 4 February 2026
Line 520:		Line 520:

	Raised after Mudlet is done loading the profile, after all of the scripts, packages, and modules are installed. Note that when it does so, it also compiles and runs all scripts - which could be a good idea to initialize everything at once, but beware - scripts are also run when saved. Hence, hooking only on the sysLoadEvent would prevent multiple re-loads as you’re editing the script.		Raised after Mudlet is done loading the profile, after all of the scripts, packages, and modules are installed. Note that when it does so, it also compiles and runs all scripts - which could be a good idea to initialize everything at once, but beware - scripts are also run when saved. Hence, hooking only on the sysLoadEvent would prevent multiple re-loads as you’re editing the script.
		+
		+	In '''4.20.0''' an extra boolean argument was provided which indicates whether the event is from loading a new profile (''true'') or after a call of the ''resetProfile()'' function (''false'').

	===sysLuaInstallModule===		===sysLuaInstallModule===

← Older revision		Revision as of 00:49, 4 February 2026
Line 194:		Line 194:

	Raised when the profile becomes connected to a MUD.		Raised when the profile becomes connected to a MUD.
		+
		+	===sysConsoleSizeChanged===
		+	This event is raised when the (scrollable part of) the main or a sub-console or a user-window changes in size. After the event name as the first argument (as is "standard") additional arguments contain:
		+	* the name (string) of the console involved ("''main''" for the main console)
		+	* the number of characters (''em-space'' equivalents) wide the new size is
		+	* the number of lines tall the new size is
		+	* the number of characters taken up by a visible time stamp (will be '''0''' if this detail is not visible).
		+
		+	{{MudletVersion\|4.20}}

	===sysCustomHttpDone===		===sysCustomHttpDone===

← Older revision		Revision as of 00:22, 4 February 2026
Line 654:		Line 654:

	See also [[#sysPutHttpDone\|sysPutHttpDone]].		See also [[#sysPutHttpDone\|sysPutHttpDone]].
		+
		+	===sysScrollBoxDeleted===
		+
		+	Raised when a scrollbox is successfully deleted via [[Manual:UI_Functions#deleteScrollBox\|deleteScrollBox()]] or Geyser's <code>ScrollBox:delete()</code> method. The event provides the name of the deleted scrollbox as an argument.
		+
		+	{{note}} This event is raised after the scrollbox has been marked for deletion but before Qt's event loop has completed the deletion. The scrollbox should be considered gone for practical purposes.
		+
		+	{{MudletVersion\|4.20}}
		+
		+	;Event arguments
		+	* ''event'': The event name: "sysScrollBoxDeleted"
		+	* ''scrollBoxName'': The name of the scrollbox that was deleted
		+
		+	;Example
		+	<syntaxhighlight lang="lua">
		+	-- Register an event handler for scrollbox deletion
		+	function onScrollBoxDeleted(event, scrollBoxName)
		+	cecho(f"<green>ScrollBox '{scrollBoxName}' has been deleted.\n")
		+
		+	-- Clean up any content tables or buffers
		+	if scrollBoxContent[scrollBoxName] then
		+	scrollBoxContent[scrollBoxName] = nil
		+	end
		+	end
		+
		+	registerAnonymousEventHandler("sysScrollBoxDeleted", onScrollBoxDeleted)
		+
		+	-- Now when you delete a scrollbox, the handler will be called
		+	createScrollBox("messageBox", 10, 10, 300, 400)
		+	deleteScrollBox("messageBox")
		+	-- Output: ScrollBox 'messageBox' has been deleted.
		+	</syntaxhighlight>

	===sysSoundFinished===		===sysSoundFinished===

← Older revision		Revision as of 00:17, 4 February 2026
Line 156:		Line 156:

	{{MudletVersion\|4.17}}		{{MudletVersion\|4.17}}
		+
		+	===sysCommandLineDeleted===
		+
		+	Raised when a command line is successfully deleted via [[Manual:UI_Functions#deleteCommandLine\|deleteCommandLine()]] or Geyser's <code>CommandLine:delete()</code> method. The event provides the name of the deleted command line as an argument.
		+
		+	{{note}} This event is raised after the command line has been marked for deletion but before Qt's event loop has completed the deletion. The command line should be considered gone for practical purposes.
		+
		+	{{note}} The main command line cannot be deleted, so this event will never be raised for it.
		+
		+	{{MudletVersion\|4.20}}
		+
		+	;Event arguments
		+	* ''event'': The event name: "sysCommandLineDeleted"
		+	* ''commandLineName'': The name of the command line that was deleted
		+
		+	;Example
		+	<syntaxhighlight lang="lua">
		+	-- Register an event handler for command line deletion
		+	function onCommandLineDeleted(event, commandLineName)
		+	cecho(f"<green>Command line '{commandLineName}' has been deleted.\n")
		+
		+	-- Clean up any command history or aliases specific to this command line
		+	if commandLineHistory[commandLineName] then
		+	commandLineHistory[commandLineName] = nil
		+	end
		+	end
		+
		+	registerAnonymousEventHandler("sysCommandLineDeleted", onCommandLineDeleted)
		+
		+	-- Now when you delete a command line, the handler will be called
		+	createCommandLine("customInput", 10, 400, 300, 30)
		+	deleteCommandLine("customInput")
		+	-- Output: Command line 'customInput' has been deleted.
		+	</syntaxhighlight>

	===sysConnectionEvent===		===sysConnectionEvent===

@@ Line 511: / Line 511: @@
 ===sysMiniConsoleDeleted===
-Raised when a miniconsole is successfully deleted via [[Manual:Lua_Functions#deleteMiniConsole|deleteMiniConsole()]] or Geyser's <code>MiniConsole:delete()</code> method. The event provides the name of the deleted miniconsole as an argument.
+Raised when a miniconsole is successfully deleted via [[Manual:UI_Functions#deleteMiniConsole|deleteMiniConsole()]] or Geyser's <code>MiniConsole:delete()</code> method. The event provides the name of the deleted miniconsole as an argument.
 {{note}} This event is raised after the miniconsole has been marked for deletion but before Qt's event loop has completed the deletion. The miniconsole should be considered gone for practical purposes.

← Older revision		Revision as of 00:04, 4 February 2026
Line 508:		Line 508:

	Raised whenever an [[Standards:MMP\|MMP map]] is downloaded and loaded in.		Raised whenever an [[Standards:MMP\|MMP map]] is downloaded and loaded in.
		+
		+	===sysMiniConsoleDeleted===
		+
		+	Raised when a miniconsole is successfully deleted via [[Manual:Lua_Functions#deleteMiniConsole\|deleteMiniConsole()]] or Geyser's <code>MiniConsole:delete()</code> method. The event provides the name of the deleted miniconsole as an argument.
		+
		+	{{note}} This event is raised after the miniconsole has been marked for deletion but before Qt's event loop has completed the deletion. The miniconsole should be considered gone for practical purposes.
		+
		+	{{MudletVersion\|4.20}}
		+
		+	;Event arguments
		+	* ''event'': The event name: "sysMiniConsoleDeleted"
		+	* ''miniConsoleName'': The name of the miniconsole that was deleted
		+
		+	;Example
		+	<syntaxhighlight lang="lua">
		+	-- Register an event handler for miniconsole deletion
		+	function onMiniConsoleDeleted(event, miniConsoleName)
		+	cecho(f"<green>MiniConsole '{miniConsoleName}' has been deleted.\n")
		+
		+	-- Stop any timers or processes that were sending data to this console
		+	if chatTimers[miniConsoleName] then
		+	killTimer(chatTimers[miniConsoleName])
		+	chatTimers[miniConsoleName] = nil
		+	end
		+	end
		+
		+	registerAnonymousEventHandler("sysMiniConsoleDeleted", onMiniConsoleDeleted)
		+
		+	-- Now when you delete a miniconsole, the handler will be called
		+	createMiniConsole("chatWindow", 10, 10, 300, 200)
		+	deleteMiniConsole("chatWindow")
		+	-- Output: MiniConsole 'chatWindow' has been deleted.
		+	</syntaxhighlight>

	===sysMediaFinished===		===sysMediaFinished===

@@ Line 444: / Line 444: @@
 ===sysLabelDeleted===
-Raised after a label is deleted, with the former label's name as an argument.
+Raised when a label is successfully deleted via [[Manual:Lua_Functions#deleteLabel|deleteLabel()]] or Geyser's <code>Label:delete()</code> method. The event provides the name of the deleted label as an argument.
 ===sysLoadEvent===

@@ Line 686: / Line 686: @@
 ===sysWindowOverflowEvent===
-Raised when the content in a mini-console/user window that has been set to be '''non-scrolling''' (see: [[#enableScrolling|enableScrolling(...)]] and [[#disableScrolling|disableScrolling(...)]]) overflows - i.e. fills the visible window and overflows off the bottom. Returns two additional arguments being the window's name as a string and the number of lines that have gone past that which can be shown on the current size of the window.
+Raised when the content in a mini-console/user window that has been set to be '''non-scrolling''' (see: [[enableScrolling|enableScrolling(...)]] and [[disableScrolling|disableScrolling(...)]]) overflows - i.e. fills the visible window and overflows off the bottom. Returns two additional arguments being the window's name as a string and the number of lines that have gone past that which can be shown on the current size of the window.
 {{MudletVersion| 4.18.0}}