Manual:Mudlet Object Functions - Revision history

Tamarindo: /* stopNamedTrigger */

2026-02-04T03:07:30Z

stopNamedTrigger

Tamarindo: /* stopAllNamedTrigger */

2026-02-04T03:06:41Z

stopAllNamedTrigger

Tamarindo: /* resumeNamedTrigger */

2026-02-04T03:05:23Z

resumeNamedTrigger

Tamarindo: /* getNamedTriggers */

2026-02-04T03:04:35Z

getNamedTriggers

Tamarindo: /* registerNamedTrigger */

2026-02-04T03:03:37Z

registerNamedTrigger

Tamarindo: /* deleteNamedTrigger */

2026-02-04T03:02:40Z

deleteNamedTrigger

Tamarindo: /* deleteAllNamedTriggers */

2026-02-04T03:01:27Z

deleteAllNamedTriggers

Tamarindo: /* loadVideoFile */

2026-02-04T02:34:05Z

loadVideoFile

Tamarindo: /* sendCmdLine */

2026-02-04T02:33:37Z

sendCmdLine

Tamarindo: /* loadVideoFile */

2026-02-04T02:32:42Z

loadVideoFile

@@ Line 1,963: / Line 1,963: @@
 else
    cecho("DemonVitals doesn't exist or already stopped; either way it won't fire any more.")
 end
 </syntaxhighlight>

@@ Line 1,922: / Line 1,922: @@
 <syntaxhighlight lang="lua">
 stopAllNamedTimers("Demonnic") -- emergency stop situation, most likely.
 </syntaxhighlight>

@@ Line 1,660: / Line 1,660: @@
 else
    cecho("DemonVitals doesn't exist, so cannot resume it.")
 end
 </syntaxhighlight>

@@ Line 759: / Line 759: @@
    display(timers)
    -- { "Test1", "Test2" }
 </syntaxhighlight>

@@ Line 1,533: / Line 1,533: @@
 -- then the next time you want to make/use the same timer, you can shortcut it with
 resumeNamedTimer("Demonnic", "Check Balance")
 </syntaxhighlight>

@@ Line 311: / Line 311: @@
 else
    cecho("DemonVitals doesn't exist and so could not be deleted.")
 end
 </syntaxhighlight>

← Older revision		Revision as of 02:34, 4 February 2026
Line 1,136:		Line 1,136:
	loadProfile("WoTMUD", true)		loadProfile("WoTMUD", true)

−	~~</syntaxhighlight>~~
−
−	~~==loadVideoFile==~~
−	~~;loadVideoFile(settings table) or loadVideoFile(name, [url])~~
−	:Loads video files from the Internet or the local file system to the "media" folder of the profile for later use with [[Manual:Miscellaneous_Functions#playVideoFile\|playVideoFile()]] and [[Manual:Miscellaneous_Functions#stopVideos\|stopVideos()]]. Although files could be loaded or streamed directly at playing time from [[Manual:Miscellaneous_Functions#playVideoFile\|playVideoFile()]], loadVideoFile() provides the advantage of loading files in advance.
−
−	~~{{note}} Video files consume drive space on your device. Consider using the streaming feature of [[Manual:Miscellaneous_Functions#playVideoFile\|playVideoFile()]] for large files.~~
−
−	~~{\| class="wikitable"~~
−	~~!Required~~
−	~~!Key~~
−	~~!Value~~
−	~~! style="text-align:left;" \|Purpose~~
−	~~\|- style="color: green;"~~
−	~~\| style="text-align:center;" \|Yes~~
−	~~\|name~~
−	~~\|<file name>~~
−	~~\| style="text-align:left;" \|~~
−	*Name of the media file.
−	*May contain directory information (i.e. weather/maelstrom.mp4).
−	*May be part of the profile (i.e. getMudletHomeDir().. "/congratulations.mp4")
−	*May be on the local device (i.e. "C:/Users/YourNameHere/Movies/nevergoingtogiveyouup.mp4")
−	~~\|- style="color: blue;"~~
−	~~\| style="text-align:center;" \|Maybe~~
−	~~\|url~~
−	~~\|<url>~~
−	~~\| style="text-align:left;" \|~~
−	*Resource location where the media file may be downloaded.
−	*Only required if file to load is not part of the profile or on the local file system.
−	\|-
−	\|}
−
−	See also: [[Manual:Miscellaneous_Functions#getPausedMusic\|getPausedMusic()]], [[Manual:Miscellaneous_Functions#getPausedSounds\|getPausedSounds()]], [[Manual:Miscellaneous_Functions#getPausedVideos\|getPausedVideos()]], [[Manual:Miscellaneous_Functions#getPlayingMusic\|getPlayingMusic()]], [[Manual:Miscellaneous_Functions#getPlayingSounds\|getPlayingSounds()]], [[Manual:Miscellaneous_Functions#getPlayingVideos\|getPausedVideos()]], [[Manual:Miscellaneous_Functions#loadMusicFile\|loadMusicFile()]], [[Manual:Miscellaneous_Functions#loadSoundFile\|loadSoundFile()]], [[Manual:Miscellaneous_Functions#pauseMusic\|pauseMusic()]], [[Manual:Miscellaneous_Functions#pauseSounds\|pauseSounds()]], [[Manual:Miscellaneous_Functions#pauseVideos\|pauseVideos()]], [[Manual:Miscellaneous_Functions#playMusicFile\|playMusicFile()]], [[Manual:Miscellaneous_Functions#playSoundFile\|playSoundFile()]], [[Manual:Miscellaneous_Functions#playVideoFile\|playVideoFile()]], [[Manual:Miscellaneous_Functions#purgeMediaCache\|purgeMediaCache()]], [[Manual:Miscellaneous_Functions#receiveMSP\|receiveMSP()]], [[Manual:Miscellaneous_Functions#stopMusic\|stopMusic()]], [[Manual:Miscellaneous_Functions#stopSounds\|stopSounds()]], [[Manual:Miscellaneous_Functions#stopVideos\|stopVideos()]], [[Manual:Scripting#MUD_Client_Media_Protocol\|Mud Client Media Protocol]]
−
−	~~{{MudletVersion\|4.20}}~~
−
−	~~;Example~~
−
−	~~<syntaxhighlight lang="lua">~~
−	~~---- Table Parameter Syntax ----~~
−
−	~~-- Download from the Internet~~
−	~~loadVideoFile({~~
−	~~name = "TextInMotion-VideoSample-1080p.mp4"~~
−	~~, url = "https://d2qguwbxlx1sbt.cloudfront.net/"~~
−	})
−
−	~~-- OR download from the profile~~
−	~~loadVideoFile({name = getMudletHomeDir().. "/TextInMotion-VideoSample-1080p.mp4"})~~
−
−	~~-- OR download from the local file system~~
−	~~loadVideoFile({name = "C:/Users/Tamarindo/Movies/TextInMotion-VideoSample-1080p.mp4"})~~
	</syntaxhighlight>		</syntaxhighlight>

@@ Line 1,650: / Line 1,650: @@
 </syntaxhighlight>
-= sendCmdLine =
+== sendCmdLine ==
 '''sendCmdLine(command)''' – Sets the text of the main command line or a custom command line to the specified string, but does '''not''' send it to the server. This is useful for scripting command previews, suggestion systems, or autofill behavior in Mudlet.
@@ Line 1,656: / Line 1,656: @@
 {{MudletVersion|4.20}}
-== Syntax ==
+=== Syntax ===
 <syntaxhighlight lang="lua">
 sendCmdLine(command)
 </syntaxhighlight>
-== Parameters ==
+=== Parameters ===
 {| class="wikitable"
 ! Parameter
@@ Line 1,672: / Line 1,672: @@
 |}
-== Return value ==
+=== Return value ===
 Returns `true` if the command line was successfully updated, `false` otherwise.
-== Example ==
+=== Example ===
 <syntaxhighlight lang="lua">
 sendCmdLine("cast fireball at goblin")
@@ Line 1,681: / Line 1,681: @@
 This will place the command `cast fireball at goblin` into the active command line without sending it. The user can edit or press enter to send it.
-== Notes ==
+=== Notes ===
 * This function is primarily intended for scripting support tools, such as suggestion completions or history cycling.
 * To send the command to the server, use the [[send|send()]] function instead.
-== See also ==
+=== See also ===
 * [[send]]
 * [[expandAlias]]

← Older revision		Revision as of 02:32, 4 February 2026
Line 1,136:		Line 1,136:
	loadProfile("WoTMUD", true)		loadProfile("WoTMUD", true)

		+	</syntaxhighlight>
		+
		+	==loadVideoFile==
		+	;loadVideoFile(settings table) or loadVideoFile(name, [url])
		+	:Loads video files from the Internet or the local file system to the "media" folder of the profile for later use with [[Manual:Miscellaneous_Functions#playVideoFile\|playVideoFile()]] and [[Manual:Miscellaneous_Functions#stopVideos\|stopVideos()]]. Although files could be loaded or streamed directly at playing time from [[Manual:Miscellaneous_Functions#playVideoFile\|playVideoFile()]], loadVideoFile() provides the advantage of loading files in advance.
		+
		+	{{note}} Video files consume drive space on your device. Consider using the streaming feature of [[Manual:Miscellaneous_Functions#playVideoFile\|playVideoFile()]] for large files.
		+
		+	{\| class="wikitable"
		+	!Required
		+	!Key
		+	!Value
		+	! style="text-align:left;" \|Purpose
		+	\|- style="color: green;"
		+	\| style="text-align:center;" \|Yes
		+	\|name
		+	\|<file name>
		+	\| style="text-align:left;" \|
		+	*Name of the media file.
		+	*May contain directory information (i.e. weather/maelstrom.mp4).
		+	*May be part of the profile (i.e. getMudletHomeDir().. "/congratulations.mp4")
		+	*May be on the local device (i.e. "C:/Users/YourNameHere/Movies/nevergoingtogiveyouup.mp4")
		+	\|- style="color: blue;"
		+	\| style="text-align:center;" \|Maybe
		+	\|url
		+	\|<url>
		+	\| style="text-align:left;" \|
		+	*Resource location where the media file may be downloaded.
		+	*Only required if file to load is not part of the profile or on the local file system.
		+	\|-
		+	\|}
		+
		+	See also: [[Manual:Miscellaneous_Functions#getPausedMusic\|getPausedMusic()]], [[Manual:Miscellaneous_Functions#getPausedSounds\|getPausedSounds()]], [[Manual:Miscellaneous_Functions#getPausedVideos\|getPausedVideos()]], [[Manual:Miscellaneous_Functions#getPlayingMusic\|getPlayingMusic()]], [[Manual:Miscellaneous_Functions#getPlayingSounds\|getPlayingSounds()]], [[Manual:Miscellaneous_Functions#getPlayingVideos\|getPausedVideos()]], [[Manual:Miscellaneous_Functions#loadMusicFile\|loadMusicFile()]], [[Manual:Miscellaneous_Functions#loadSoundFile\|loadSoundFile()]], [[Manual:Miscellaneous_Functions#pauseMusic\|pauseMusic()]], [[Manual:Miscellaneous_Functions#pauseSounds\|pauseSounds()]], [[Manual:Miscellaneous_Functions#pauseVideos\|pauseVideos()]], [[Manual:Miscellaneous_Functions#playMusicFile\|playMusicFile()]], [[Manual:Miscellaneous_Functions#playSoundFile\|playSoundFile()]], [[Manual:Miscellaneous_Functions#playVideoFile\|playVideoFile()]], [[Manual:Miscellaneous_Functions#purgeMediaCache\|purgeMediaCache()]], [[Manual:Miscellaneous_Functions#receiveMSP\|receiveMSP()]], [[Manual:Miscellaneous_Functions#stopMusic\|stopMusic()]], [[Manual:Miscellaneous_Functions#stopSounds\|stopSounds()]], [[Manual:Miscellaneous_Functions#stopVideos\|stopVideos()]], [[Manual:Scripting#MUD_Client_Media_Protocol\|Mud Client Media Protocol]]
		+
		+	{{MudletVersion\|4.20}}
		+
		+	;Example
		+
		+	<syntaxhighlight lang="lua">
		+	---- Table Parameter Syntax ----
		+
		+	-- Download from the Internet
		+	loadVideoFile({
		+	name = "TextInMotion-VideoSample-1080p.mp4"
		+	, url = "https://d2qguwbxlx1sbt.cloudfront.net/"
		+	})
		+
		+	-- OR download from the profile
		+	loadVideoFile({name = getMudletHomeDir().. "/TextInMotion-VideoSample-1080p.mp4"})
		+
		+	-- OR download from the local file system
		+	loadVideoFile({name = "C:/Users/Tamarindo/Movies/TextInMotion-VideoSample-1080p.mp4"})
	</syntaxhighlight>		</syntaxhighlight>