Manual:Miscellaneous Functions - Revision history

Dt192 at 08:50, 16 February 2026

2026-02-16T08:50:09Z

Tamarindo: /* pauseMusic & pauseSounds & pauseVideos */

2026-02-04T02:45:26Z

pauseMusic & pauseSounds & pauseVideos

Tamarindo: /* getPlayingVideos */

2026-02-04T02:43:07Z

getPlayingVideos

Tamarindo: /* getPausedSounds & getPausedVideos */

2026-02-04T02:42:03Z

getPausedSounds & getPausedVideos

Tamarindo: /* getPausedMusic */

2026-02-04T02:38:51Z

getPausedMusic

Tamarindo: /* stopVideos */

2026-02-04T02:37:37Z

stopVideos

Tamarindo: /* playVideoFile */

2026-02-04T02:36:15Z

playVideoFile

Tamarindo: /* loadVideoFile */

2026-02-04T02:35:01Z

loadVideoFile

Tamarindo: /* clearVisitedLinks */

2026-02-04T02:24:49Z

clearVisitedLinks

Tamarindo: /* clearVisitedLinks */

2026-02-04T02:24:38Z

clearVisitedLinks

@@ Line 335: / Line 335: @@
 <syntaxhighlight lang="lua">
 -- try using this on the command line
-`echo This is a sample line from the game
+--> `echo This is a sample line from the game
 -- You can use \n to represent a new line - you also want to use it before and after the text you’re testing, like so:

@@ Line 2,058: / Line 2,058: @@
      , url = "https://d2qguwbxlx1sbt.cloudfront.net/"
      , stream = false
 })
 </syntaxhighlight>

@@ Line 995: / Line 995: @@
      , nil -- priority
+)
 </syntaxhighlight>

@@ Line 722: / Line 722: @@
      name = nil  -- nil lines are optional, no need to use
      , key = "rugby" -- key
      , tag = nil  -- nil lines are optional, no need to use
 })

← Older revision		Revision as of 02:38, 4 February 2026
Line 668:		Line 668:

	{{MudletVersion\|4.12}}		{{MudletVersion\|4.12}}
		+
		+	==getPausedMusic==
		+	;getPausedMusic(settings table)
		+	: List all paused music (no filter), or paused music that meets a combination of filters (name, key, and tag) intended to be paired with [[Manual:Miscellaneous_Functions#playMusicFile\|playMusicFile()]].
		+
		+	{\| class="wikitable"
		+	!Required
		+	!Key
		+	!Value
		+	!Default
		+	! style="text-align:left;" \|Purpose
		+	\|-
		+	\| style="text-align:center;" \|No
		+	\|name
		+	\|<file name>
		+	\|
		+	\| style="text-align:left;" \|
		+	*Name of the media file.
		+	\|-
		+	\| style="text-align:center;" \|No
		+	\|key
		+	\|<key>
		+	\|
		+	\| style="text-align:left;" \|
		+	* Uniquely identifies media files with a "key" that is bound to their "name" or "url".
		+	\|-
		+	\| style="text-align:center;" \|No
		+	\|tag
		+	\|<tag>
		+	\|
		+	\| style="text-align:left;" \|
		+	*Helps categorize media.
		+	\|-
		+	\|}
		+
		+	See also: [[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#loadVideoFile\|loadVideoFile()]], [[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 ----
		+
		+	-- List all paused music files for this profile associated with the API
		+	getPausedMusic()
		+
		+	-- List all paused music matching the rugby mp3 name
		+	getPausedMusic({name = "167124__patricia-mcmillen__rugby-club-in-spain.mp3"})
		+
		+	-- List all paused music matching the unique key of "rugby"
		+	getPausedMusic({
		+	name = nil -- nil lines are optional, no need to use
		+	, key = "rugby" -- key
		+	, tag = nil -- nil lines are optional, no need to use
		+	})
		+	</syntaxhighlight>

	==getPlayingMusic==		==getPlayingMusic==

@@ Line 2,655: / Line 2,655: @@
      , 7000 -- fadeout
+)
 </syntaxhighlight>

@@ Line 1,653: / Line 1,653: @@
      , nil -- finish
+)
 </syntaxhighlight>

@@ Line 1,151: / Line 1,151: @@
 -- OR download from the local file system
 loadSoundFile("C:/Users/Tamarindo/Documents/cow.wav")
 </syntaxhighlight>

@@ Line 159: / Line 159: @@
 -- even if they were previously clicked
 </syntaxhighlight>
 ==compare==

@@ Line 135: / Line 135: @@
 appendLog("Add this string to the log.")
 </syntaxhighlight>
 ==compare==
 ; sameValue = compare(a, b)