Difference between revisions of "Area 51"

From Mudlet
Jump to navigation Jump to search
 
(62 intermediate revisions by 7 users not shown)
Line 29: Line 29:
 
: A collection of functions that manipulate the mapper and its related features.
 
: A collection of functions that manipulate the mapper and its related features.
  
−
==mapSymbolFontInfo, PR #4038 closed==
+
==addRoom PR #7184 merged==
−
;mapSymbolFontInfo()
+
;addRoom(roomID, areaID)
−
: See also: [[#setupMapSymbolFont|setupMapSymbolFont()]]
+
 
 +
:Creates a new room with the given room ID and area ID, returns true if the room was successfully created.
  
−
{{note}} pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/4038
+
;Parameters
 +
* ''roomID:''
 +
: Room ID to set the room as, manually assigned or from [[#createRoomID|createRoomID()]].
 +
* ''areaID:''
 +
: Area ID to set the room in, as returned by [[#getAreaTable|getAreaTable()]] or equivalents.
  
−
;returns
+
{{note}} If you're not using incremental room IDs but room IDs stitched together from other factors or in-game hashes for room IDs - and your room IDs are starting off at 250+million numbers, you need to look into incrementally creating Mudlets room IDs with [[#createRoomID|createRoomID()]] and associating your room IDs with Mudlets via [[#setRoomIDbyHash|setRoomIDbyHash()]] and [[#getRoomIDbyHash|getRoomIDbyHash()]]. The reason being is that Mudlet's A* pathfinding implementation from boost cannot deal with extremely large room IDs because the resulting matrices it creates for pathfinding are enormously huge.
−
* either a table of information about the configuration of the font used for symbols in the (2D) map, the elements are:
+
{{note}} Creating your own mapping script? Check out more [[Manual:Mapper#Making_your_own_mapping_script|information here]].
−
:* ''fontName'' - a string of the family name of the font specified
 
−
:* ''onlyUseThisFont'' - a boolean indicating whether glyphs from just the ''fontName'' font are to be used or if there is not a ''glyph'' for the required ''grapheme'' (''character'') then a ''glyph'' from the most suitable different font will be substituted instead. Should this be ''true'' and the specified font does not have the required glyph then the replacement character (typically something like ''�'') could be used instead. Note that this may not affect the use of Color Emoji glyphs that are automatically used in some OSes but that behavior does vary across the range of operating systems that Mudlet can be run on.
 
−
:* ''scalingFactor'' - a floating point number between 0.50 and 2.00 which modifies the size of the symbols somewhat though the extremes are likely to be unsatisfactory because some of the particular symbols may be too small (and be less visible at smaller zoom levels) or too large (and be clipped by the edges of the room rectangle or circle).
 
−
* or ''nil'' and an error message on failure.
 
  
−
::As the symbol font details are stored in the (binary) map file rather than the profile then this function will not work until a map is loaded (or initialized, by activating a map window).
+
: See also: [[#createRoomID|createRoomID()]]
  
−
==moveMapLabel, PR #6014 open==
+
;Example:
−
;moveMapLabel(areaID/Name, labeID/Text, coordX/deltaX, coordY/deltaY[, coordZ/deltaZ][, absoluteNotRelativeMove])
+
<syntaxhighlight lang="lua">
−
Re-positions a map label within an area in the 2D mapper, in a similar manner as the [[#moveRoom|moveRoom()]] function does for rooms and their custom exit lines. When moving a label to given coordinates this is the position that the top-left corner of the label will be positioned at; since the space allocated to a particular room on the map is ± 0.5 around the integer value of its x and y coordinates this means for a label which has a size of 1.0 x 1,0 (w x h) to position it centrally in the space for a single room at the coordinates (x, y, z) it should be positioned at (x - 0.5, y + 0.5, z).
+
local newroomid = createRoomID()
 +
addRoom(newroomid)
 +
</syntaxhighlight>
  
−
:See also: [[Manual:Mapper_Functions#getMapLabels|getMapLabels()]], [[Manual:Mapper_Functions#getMapLabel|getMapLabel()]].
+
==getAreaRooms1, PR #7520 open==
 +
;getAreaRooms1(area id)
  
−
{{MudletVersion| ?.??}}
+
:Returns an indexed table with all rooms IDs for a given area ID (room IDs are values), or ''nil'' if no such area exists. Indexing starts at 1.
  
−
{{note}} pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/6014
+
See also: [[#getAreaRooms|getAreaRooms()]]
  
−
;Parameters
+
==setRoomArea PR #7184 merged====
−
* ''areaID/Name:''
+
;setRoomArea(roomID, newAreaID or newAreaName)
−
: Area ID as number or AreaName as string containing the map label.
 
  
−
* ''labelID/Text:''
+
:Assigns the given room (or set of rooms) to a new or different area. If the area is displayed in the mapper this will have the room be visually moved into the area as well.
−
: Label ID as number (which will be 0 or greater) or the LabelText on a text label. All labels will have a unique ID number but there may be more than one ''text'' labels with a non-empty text string; only the first matching one will be moved by this function and image labels also have no text and will match the empty string.  with mo or AreaName as string containing the map label.
+
:roomID can also be a table of rooms for bulk assigning
  
−
* ''coordX/deltaX:''
+
: See also: [[#resetRoomArea|resetRoomArea()]]
−
: A floating point number for the absolute coordinate to use or the relative amount to move the label in "room coordinates" along the X-axis.
+
 
 +
;Example:
 +
<syntaxhighlight lang="lua">
 +
local newroomid = createRoomID()
 +
setRoomArea(newroomid, "My New Area")
 +
</syntaxhighlight>
  
−
* ''coordY/deltaY:''
+
<syntaxhighlight lang="lua">
−
: A floating point number for the absolute coordinate to use or the relative amount to move the label in "room coordinates" along the Y-axis.
+
local rooms = { 1234, 4321, 5678 }
 +
setRoomArea(rooms, "My New Area")
 +
</syntaxhighlight>
  
−
* ''coordZ/deltaZ:''
+
==updateMap==
−
: (Optional) A floating point number for the absolute coordinate to use or the relative amount to move the label in "room coordinates" along the Z-axis, if omitted the label is not moved in the z-axis at all.
+
;updateMap()
  
−
* ''absoluteNotRelativeMove:''
+
:Updates the mapper display (redraws it). While longer necessary since Mudlet 4.18, you can use this this function to redraw the map after changing it via API.
−
: (Optional) a boolean value (defaults to ''false'' if omitted) as to whether to move the label to the absolute coordinates (''true'') or to move it the relative amount from its current location (''false'').
 
  
−
;Returns
+
: See also: [[#centerview|centerview()]]
−
: ''true'' on success or ''nil'' and an error message on failure, if successful it will also refresh the map display to show the result.
 
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- move the first label in the area with the ID number of 2, three spaces to the east and four spaces to the north
+
-- delete a some room
−
moveMapLabel(0, 2, 3.0, 4.0)
+
deleteRoom(500)
 +
-- now make the map show that it's gone
 +
updateMap()
 +
</syntaxhighlight>
  
−
-- move the first label in the area with the ID number of 2, one space to the west, note the final boolean argument is unneeded
 
−
moveMapLabel(0, 2, -1.0, 0.0, false)
 
  
−
-- move the second label in the area with the ID number of 2, three and a half spaces to the west, and two south **of the center of the current level it is on in the map**:
+
==mapSymbolFontInfo, PR #4038 closed==
−
moveRoom(1, 2, -3.5, -2.0, true)
+
;mapSymbolFontInfo()
 +
: See also: [[#setupMapSymbolFont|setupMapSymbolFont()]]
  
−
-- move the second label in the area with the ID number of 2, up three levels
+
{{note}} pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/4038
−
moveRoom(1, 2, 0.0, 0.0, 3.0)
 
  
−
-- move the second label in the "Test 1" area one space to the west, note the last two arguments are unneeded
+
;returns
−
moveRoom("Test 1", 1, -1.0, 0.0, 0.0, false)
+
* either a table of information about the configuration of the font used for symbols in the (2D) map, the elements are:
 +
:* ''fontName'' - a string of the family name of the font specified
 +
:* ''onlyUseThisFont'' - a boolean indicating whether glyphs from just the ''fontName'' font are to be used or if there is not a ''glyph'' for the required ''grapheme'' (''character'') then a ''glyph'' from the most suitable different font will be substituted instead. Should this be ''true'' and the specified font does not have the required glyph then the replacement character (typically something like ''�'') could be used instead. Note that this may not affect the use of Color Emoji glyphs that are automatically used in some OSes but that behavior does vary across the range of operating systems that Mudlet can be run on.
 +
:* ''scalingFactor'' - a floating point number between 0.50 and 2.00 which modifies the size of the symbols somewhat though the extremes are likely to be unsatisfactory because some of the particular symbols may be too small (and be less visible at smaller zoom levels) or too large (and be clipped by the edges of the room rectangle or circle).
 +
* or ''nil'' and an error message on failure.
  
−
-- move the (top-left corner of the first) label with the text "Home" in the area with ID number 5 to the **center of the whole map**, note the last two arguments are required in this case:
+
::As the symbol font details are stored in the (binary) map file rather than the profile then this function will not work until a map is loaded (or initialized, by activating a map window).
−
moveRoom(5, "Home", 0.0, 0.0, 0.0, true)
 
  
−
-- all of the above will return the 'true'  boolean value assuming there are the indicated labels and areas
+
==moveMapLabel, PR #6014 open==
−
</syntaxhighlight>
+
;moveMapLabel(areaID/Name, labeID/Text, coordX/deltaX, coordY/deltaY[, coordZ/deltaZ][, absoluteNotRelativeMove])
 +
Re-positions a map label within an area in the 2D mapper, in a similar manner as the [[#moveRoom|moveRoom()]] function does for rooms and their custom exit lines. When moving a label to given coordinates this is the position that the top-left corner of the label will be positioned at; since the space allocated to a particular room on the map is ± 0.5 around the integer value of its x and y coordinates this means for a label which has a size of 1.0 x 1,0 (w x h) to position it centrally in the space for a single room at the coordinates (x, y, z) it should be positioned at (x - 0.5, y + 0.5, z).
  
−
==moveRoom, PR #6010 open==
+
:See also: [[Manual:Mapper_Functions#getMapLabels|getMapLabels()]], [[Manual:Mapper_Functions#getMapLabel|getMapLabel()]].
−
;moveRoom(roomID, coordX/deltaX, coordY/deltaY[, coordZ/deltaZ][, absoluteNotRelativeMove])
 
−
Re-positions a room within an area, in the same manner as the "move to" context menu item for one or more rooms in the 2D mapper. Like that method this will also shift the entirety of any custom exit lines defined for the room concerned. This contrasts with the behavior of the [[Manual:Mapper_Functions#setRoomCoordinates|setRoomCoordinates()]] which only moves the starting point of such custom exit lines so that they still emerge from the room to which they belong but otherwise remain pointing to the original place.
 
−
 
 
−
:See also: [[Manual:Mapper_Functions#setRoomCoordinates|setRoomCoordinates()]]
 
  
 
{{MudletVersion| ?.??}}
 
{{MudletVersion| ?.??}}
  
−
{{note}} pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/6010
+
{{note}} pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/6014
  
 
;Parameters
 
;Parameters
−
* ''roomID:''
+
* ''areaID/Name:''
−
: Room ID number to move.
+
: Area ID as number or AreaName as string containing the map label.
 +
 
 +
* ''labelID/Text:''
 +
: Label ID as number (which will be 0 or greater) or the LabelText on a text label. All labels will have a unique ID number but there may be more than one ''text'' labels with a non-empty text string; only the first matching one will be moved by this function and image labels also have no text and will match the empty string.  with mo or AreaName as string containing the map label.
  
 
* ''coordX/deltaX:''
 
* ''coordX/deltaX:''
−
: The absolute coordinate or the relative amount as a number to move the room in "room coordinates" along the X-axis.
+
: A floating point number for the absolute coordinate to use or the relative amount to move the label in "room coordinates" along the X-axis.
  
 
* ''coordY/deltaY:''
 
* ''coordY/deltaY:''
−
: The absolute coordinate or the relative amount as a number to move the room in "room coordinates" along the Y-axis.
+
: A floating point number for the absolute coordinate to use or the relative amount to move the label in "room coordinates" along the Y-axis.
  
 
* ''coordZ/deltaZ:''
 
* ''coordZ/deltaZ:''
−
: (Optional) the absolute coordinate or the relative amount as a number to move the room in "room coordinates" along the Z-axis, if omitted the room is not moved in the z-axis at all.
+
: (Optional) A floating point number for the absolute coordinate to use or the relative amount to move the label in "room coordinates" along the Z-axis, if omitted the label is not moved in the z-axis at all.
  
 
* ''absoluteNotRelativeMove:''
 
* ''absoluteNotRelativeMove:''
−
: (Optional) a boolean value (defaults to ''false'' if omitted) as to whether to move the room to the absolute coordinates (''true'') or the relative amount from its current location (''false'').
+
: (Optional) a boolean value (defaults to ''false'' if omitted) as to whether to move the label to the absolute coordinates (''true'') or to move it the relative amount from its current location (''false'').
  
 
;Returns
 
;Returns
Line 130: Line 142:
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- move the first room one space to the east and two spaces to the north
+
-- move the first label in the area with the ID number of 2, three spaces to the east and four spaces to the north
−
moveRoom(1, 1, 2)
+
moveMapLabel(0, 2, 3.0, 4.0)
  
−
-- move the first room one space to the west, note the final boolean argument is unneeded
+
-- move the first label in the area with the ID number of 2, one space to the west, note the final boolean argument is unneeded
−
moveRoom(1, -1, 0, false)
+
moveMapLabel(0, 2, -1.0, 0.0, false)
  
−
-- move the first room three spaces to the west, and two south **of the center of the current level it is on in the map**:
+
-- move the second label in the area with the ID number of 2, three and a half spaces to the west, and two south **of the center of the current level it is on in the map**:
−
moveRoom(1, -3, -2, true)
+
moveRoom(1, 2, -3.5, -2.0, true)
  
−
-- move the second room up three levels
+
-- move the second label in the area with the ID number of 2, up three levels
−
moveRoom(2, 0, 0, 3)
+
moveRoom(1, 2, 0.0, 0.0, 3.0)
  
−
-- move the second room one space to the west, note the last two arguments are unneeded
+
-- move the second label in the "Test 1" area one space to the west, note the last two arguments are unneeded
−
moveRoom(2, -1, 0, 0, false)
+
moveRoom("Test 1", 1, -1.0, 0.0, 0.0, false)
  
−
-- move the second room to the **center of the whole map**, note the last two arguments are required in this case:
+
-- move the (top-left corner of the first) label with the text "Home" in the area with ID number 5 to the **center of the whole map**, note the last two arguments are required in this case:
−
moveRoom(2, 0, 0, 0, true)
+
moveRoom(5, "Home", 0.0, 0.0, 0.0, true)
  
−
-- all of the above will return the 'true'  boolean value assuming there are rooms with 1 and 2 as ID numbers
+
-- all of the above will return the 'true'  boolean value assuming there are the indicated labels and areas
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==setupMapSymbolFont, PR #4038 closed==
+
==moveRoom, PR #6010 open==
−
;setupMapSymbolFont(fontName[, onlyUseThisFont[, scalingFactor]])
+
;moveRoom(roomID, coordX/deltaX, coordY/deltaY[, coordZ/deltaZ][, absoluteNotRelativeMove])
−
:configures the font used for symbols in the (2D) map.
+
Re-positions a room within an area, in the same manner as the "move to" context menu item for one or more rooms in the 2D mapper. Like that method this will also shift the entirety of any custom exit lines defined for the room concerned. This contrasts with the behavior of the [[Manual:Mapper_Functions#setRoomCoordinates|setRoomCoordinates()]] which only moves the starting point of such custom exit lines so that they still emerge from the room to which they belong but otherwise remain pointing to the original place.
−
: See also: [[#mapSymbolFontInfo|mapSymbolFontInfo()]]
+
 
 +
:See also: [[Manual:Mapper_Functions#setRoomCoordinates|setRoomCoordinates()]]
 +
 
 +
{{MudletVersion| ?.??}}
  
−
{{note}} pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/4038
+
{{note}} pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/6010
  
 
;Parameters
 
;Parameters
−
* ''fontName'' one of:
+
* ''roomID:''
−
:* - a string that is the family name of the font to use;
+
: Room ID number to move.
−
:* - the empty string ''""'' to reset to the default {which is '''"Bitstream Vera Sans Mono"'''};
+
 
−
:* - a Lua ''nil'' as a placeholder to not change this parameter but still allow a following one to be modified.
+
* ''coordX/deltaX:''
−
* ''onlyUseThisFont'' (optional) one of:
+
: The absolute coordinate or the relative amount as a number to move the room in "room coordinates" along the X-axis.
−
:* - a Lua boolean ''true'' to require Mudlet to use graphemes (''character'') '''only''' from the selected font. Should a requested grapheme not be included in the selected font then the font replacement character (�) might be used instead; note that under some circumstances it is possible that the OS (or Mudlet) provided color Emoji Font may still be used but that cannot be guaranteed across all OS platforms that Mudlet might be run on;
 
−
:* - a Lua boolean ''false'' to allow Mudlet to get a different ''glyph'' for a particular ''grapheme'' from the most suitable other font found in the system should there not be a ''glyph'' for it in the requested font. This is the default unless previously changed by this function or by the corresponding checkbox in the Profile Preferences dialogue for the profile concerned;
 
−
:* - a Lua ''nil'' as a placeholder to not change this parameter but still allow the following one to be modified.
 
−
* ''scalingFactor'' (optional): a floating point value in the range ''0.5'' to ''2.0'' (default ''1.0'') that can be used to tweak the rectangular space that each different room symbol is scaled to fit inside; this might be useful should the range of characters used to make the room symbols be consistently under- or over-sized.
 
  
−
;Returns
+
* ''coordY/deltaY:''
−
* ''true'' on success
+
: The absolute coordinate or the relative amount as a number to move the room in "room coordinates" along the Y-axis.
−
* ''nil'' and an error message on failure. As the symbol font details are stored in the (binary) map file rather than the profile then this function will not work until a map is loaded (or initialised, by activating a map window).
 
  
−
=Miscellaneous Functions=
+
* ''coordZ/deltaZ:''
−
: Miscellaneous functions.
+
: (Optional) the absolute coordinate or the relative amount as a number to move the room in "room coordinates" along the Z-axis, if omitted the room is not moved in the z-axis at all.
  
−
==playMusicFile, PR #7026==
+
* ''absoluteNotRelativeMove:''
−
;playMusicFile(settings table)
+
: (Optional) a boolean value (defaults to ''false'' if omitted) as to whether to move the room to the absolute coordinates (''true'') or the relative amount from its current location (''false'').
−
:Plays music files from the Internet or the local file system to the "media" folder of the profile for later use with [[Manual:Miscellaneous_Functions#stopMusic|stopMusic()]].
 
  
−
{| class="wikitable"
+
;Returns
−
! Required
+
: ''true'' on success or ''nil'' and an error message on failure, if successful it will also refresh the map display to show the result.
−
! Key
+
 
−
! Value
+
;Example
−
! Default
+
<syntaxhighlight lang="lua">
−
! style="text-align:left;"| Purpose
+
-- move the first room one space to the east and two spaces to the north
−
|- style="color: green;"
+
moveRoom(1, 1, 2)
−
| style="text-align:center;"| Yes
+
 
−
| name
+
-- move the first room one space to the west, note the final boolean argument is unneeded
−
| <file name>
+
moveRoom(1, -1, 0, false)
−
| &nbsp;
+
 
−
| style="text-align:left;"|
+
-- move the first room three spaces to the west, and two south **of the center of the current level it is on in the map**:
−
* Name of the media file.
+
moveRoom(1, -3, -2, true)
−
* May contain directory information (i.e. weather/lightning.wav).
+
 
−
* May be part of the profile (i.e. getMudletHomeDir().. "/cow.mp3")
+
-- move the second room up three levels
−
* May be on the local device (i.e. "C:/Users/YourNameHere/Documents/nevergoingtogiveyouup.mp3")
+
moveRoom(2, 0, 0, 3)
−
* Wildcards ''*'' and ''?'' may be used within the name to randomize media files selection.
+
 
−
|-
+
-- move the second room one space to the west, note the last two arguments are unneeded
−
| style="text-align:center;"| No
+
moveRoom(2, -1, 0, 0, false)
−
| volume
+
 
−
| 1 to 100
+
-- move the second room to the **center of the whole map**, note the last two arguments are required in this case:
−
| 50
+
moveRoom(2, 0, 0, 0, true)
−
| style="text-align:left;"|
+
 
−
* Relative to the volume set on the player's client.
+
-- all of the above will return the 'true'  boolean value assuming there are rooms with 1 and 2 as ID numbers
−
|-
+
</syntaxhighlight>
−
| style="text-align:center;"| No
+
 
−
| fadein
+
==setupMapSymbolFont, PR #4038 closed==
−
|<msec>
+
;setupMapSymbolFont(fontName[, onlyUseThisFont[, scalingFactor]])
−
|
+
:configures the font used for symbols in the (2D) map.
−
|
+
: See also: [[#mapSymbolFontInfo|mapSymbolFontInfo()]]
−
*Volume increases, or fades in, ranged across a linear pattern from one to the volume set with the "volume" key.
 
−
*Start position:  Start of media.
 
−
*End position:  Start of media plus the number of milliseconds (msec) specified.
 
−
*1000 milliseconds = 1 second.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
| fadeout
 
−
|<msec>
 
−
|
 
−
|
 
−
*Volume decreases, or fades out, ranged across a linear pattern from the volume set with the "volume" key to one.
 
−
*Start position:  End of the media minus the number of milliseconds (msec) specified.
 
−
*End position: End of the media.
 
−
*1000 milliseconds = 1 second.
 
−
|-
 
−
| style="text-align:center;"| No
 
−
| start
 
−
| <msec>
 
−
| 0
 
−
| style="text-align:left;"|
 
−
*  Begin play at the specified position in milliseconds.
 
−
|-
 
−
| style="text-align:center;"| No
 
−
| finish
 
−
| <msec>
 
−
|
 
−
| style="text-align:left;"|
 
−
*  End play at the specified position in milliseconds.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
| loops
 
−
| -1, or >= 1
 
−
|1
 
−
| style="text-align:left;" |
 
−
*Number of iterations that the media plays.
 
−
* A value of -1 allows the media to loop indefinitely.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
| key
 
−
|<key>
 
−
|&nbsp;
 
−
| style="text-align:left;" |
 
−
*Uniquely identifies media files with a "key" that is bound to their "name" or "url".
 
−
*Halts the play of current media files with the same "key" that have a different "name" or "url" while this media plays.
 
−
|-
 
−
| style="text-align:center;"| No
 
−
| tag
 
−
| <tag>
 
−
| &nbsp;
 
−
| style="text-align:left;"|
 
−
* Helps categorize media.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
| continue
 
−
| true or false
 
−
| true
 
−
| style="text-align:left;" |
 
−
*Continues playing matching new music files when true.
 
−
*Restarts matching new music files when false.
 
−
|- style="color: blue;"
 
−
| style="text-align:center;"| Maybe
 
−
| url
 
−
| <url>
 
−
| &nbsp;
 
−
| style="text-align:left;"|
 
−
* Resource location where the media file may be downloaded.
 
−
* Only required if the file is to be downloaded remotely.
 
−
|-
 
−
|}
 
  
−
See also: [[Manual:Miscellaneous_Functions#loadMusicFile|loadMusicFile()]], [[Manual:Miscellaneous_Functions#loadSoundFile|loadSoundFile()]], [[Manual:Miscellaneous_Functions#playSoundFile|playSoundFile()]], [[Manual:Miscellaneous_Functions#stopMusic|stopMusic()]], [[Manual:Miscellaneous_Functions#stopSounds|stopSounds()]], [[Manual:Miscellaneous_Functions#purgeMediaCache|purgeMediaCache()]], [[Manual:Scripting#MUD_Client_Media_Protocol|Mud Client Media Protocol]]
+
{{note}} pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/4038
  
−
{{Note}} on Windows and certain files are not playing? Try installing the 3rd party [https://codecguide.com/download_k-lite_codec_pack_standard.htm K-lite codec pack].
+
;Parameters
−
 
+
* ''fontName'' one of:
−
{{MudletVersion|4.15}}
+
:* - a string that is the family name of the font to use;
−
 
+
:* - the empty string ''""'' to reset to the default {which is '''"Bitstream Vera Sans Mono"'''};
−
;Example
+
:* - a Lua ''nil'' as a placeholder to not change this parameter but still allow a following one to be modified.
 +
* ''onlyUseThisFont'' (optional) one of:
 +
:* - a Lua boolean ''true'' to require Mudlet to use graphemes (''character'') '''only''' from the selected font. Should a requested grapheme not be included in the selected font then the font replacement character (�) might be used instead; note that under some circumstances it is possible that the OS (or Mudlet) provided color Emoji Font may still be used but that cannot be guaranteed across all OS platforms that Mudlet might be run on;
 +
:* - a Lua boolean ''false'' to allow Mudlet to get a different ''glyph'' for a particular ''grapheme'' from the most suitable other font found in the system should there not be a ''glyph'' for it in the requested font. This is the default unless previously changed by this function or by the corresponding checkbox in the Profile Preferences dialogue for the profile concerned;
 +
:* - a Lua ''nil'' as a placeholder to not change this parameter but still allow the following one to be modified.
 +
* ''scalingFactor'' (optional): a floating point value in the range ''0.5'' to ''2.0'' (default ''1.0'') that can be used to tweak the rectangular space that each different room symbol is scaled to fit inside; this might be useful should the range of characters used to make the room symbols be consistently under- or over-sized.
  
−
<syntaxhighlight lang="lua">
+
;Returns
−
---- Table Parameter Syntax ----
+
* ''true'' on success
 +
* ''nil'' and an error message on failure. As the symbol font details are stored in the (binary) map file rather than the profile then this function will not work until a map is loaded (or initialised, by activating a map window).
  
−
-- Play a music file stored in the profile's media directory (i.e. /Users/Tamarindo/mudlet-data/profiles/StickMUD/media)
+
=Miscellaneous Functions=
−
playMusicFile({
+
: Miscellaneous functions.
−
    name = "167124__patricia-mcmillen__rugby-club-in-spain.mp3"
 
−
})
 
  
−
-- OR copy once from the game's profile, and play a music file stored in the profile's media directory
+
==compare, PR#7122 open==
−
---- [volume] of 75 (1 to 100)
 
−
playMusicFile({
 
−
    name = getMudletHomeDir().. "/167124__patricia-mcmillen__rugby-club-in-spain.mp3"
 
−
    , volume = 75
 
−
})
 
  
−
-- OR copy once from the local file system, and play a music file stored in the profile's media directory
+
; sameValue = compare(a, b)
−
---- [volume] of 75 (1 to 100)
 
−
playMusicFile({
 
−
    name = "C:/Users/Tamarindo/Documents/167124__patricia-mcmillen__rugby-club-in-spain.mp3"
 
−
    , volume = 75
 
−
})
 
  
−
-- OR download once from the Internet, and play music stored in the profile's media directory
+
:This function takes two items, and compares their values. It will compare numbers, strings, but most importantly it will compare two tables by value, not reference. For instance, ''{} == {}'' is ''false'', but ''compare({}, {})'' is ''true''
−
---- [fadein] and increase the volume from 1 at the start position to default volume up until the position of 20 seconds
 
−
---- [fadeout] and decrease the volume from default volume to one, 53 seconds from the end of the music
 
−
---- [start] 10 seconds after position 0 (fadein scales its volume increase over a shorter duration, too)
 
−
---- [finish] 110 seconds from the track start (fadeout scales its volume decrease over a shorter duration, too)
 
−
---- [key] reference of "rugby" for stopping this unique music later
 
−
---- [tag] reference of "ambience" to stop and music later with the same tag
 
−
---- [continue] playing this music if another request for the same music comes in (false restarts it)
 
−
---- [url] to download once from the Internet if the music does not exist in the profile's media directory
 
−
playMusicFile({
 
−
    name = "167124__patricia-mcmillen__rugby-club-in-spain.mp3"
 
−
    , volume = nil -- nil lines are optional, no need to use
 
−
    , fadein = 20000
 
−
    , fadeout = 53000
 
−
    , start = 10000
 
−
    , finish = 110000
 
−
    , loops = nil -- nil lines are optional, no need to use
 
−
    , key = "rugby"
 
−
    , tag = "ambience"
 
−
    , continue = true
 
−
    , url = "https://raw.githubusercontent.com/StickMUD/StickMUDSounds/master/sounds/"
 
−
})
 
−
</syntaxhighlight>
 
−
<syntaxhighlight lang="lua">
 
−
---- Ordered Parameter Syntax of playMusicFile(name[,volume][,fadein][,fadeout][,loops][,key][,tag][,continue][,url][,finish]) ----
 
  
−
-- Play a music file stored in the profile's media directory (i.e. /Users/Tamarindo/mudlet-data/profiles/StickMUD/media)
+
;See also: [[Manual:Lua_Functions#table.complement|table.complement()]], [[Manual:Lua_Functions#table.n_union|table.n_union()]]
−
playMusicFile(
+
 
−
    "167124__patricia-mcmillen__rugby-club-in-spain.mp3"  -- name
+
{{MudletVersion|4.18}}
−
)
 
  
−
-- OR copy once from the game's profile, and play a music file stored in the profile's media directory
+
;Parameters
−
---- [volume] of 75 (1 to 100)
+
* ''a:''
−
playMusicFile(
+
: The first item to compare
−
    getMudletHomeDir().. "/167124__patricia-mcmillen__rugby-club-in-spain.mp3" -- name
+
* ''b:''
−
    , 75 -- volume
+
: The second item to compare
−
)
 
  
−
-- OR copy once from the local file system, and play a music file stored in the profile's media directory
+
;Returns
−
---- [volume] of 75 (1 to 100)
+
* Boolean true if the items have the same value, otherwise boolean false
−
playMusicFile(
 
−
    "C:/Users/Tamarindo/Documents/167124__patricia-mcmillen__rugby-club-in-spain.mp3" -- name
 
−
    , 75 -- volume
 
−
)
 
  
−
-- OR download once from the Internet, and play music stored in the profile's media directory
+
;Example
−
---- [fadein] and increase the volume from 1 at the start position to default volume up until the position of 20 seconds
+
<syntaxhighlight lang="lua">
−
---- [fadeout] and decrease the volume from default volume to one, 53 seconds from the end of the music
+
local tblA = { 255, 0, 0 }
−
---- [start] 10 seconds after position 0 (fadein scales its volume increase over a shorter duration, too)
+
local tblB = color_table.red
−
---- [finish] 110 seconds from the track start (fadeout scales its volume decrease over a shorter duration, too)
+
local same = compare(tblA, tblB)
−
---- [key] reference of "rugby" for stopping this unique music later
+
display(same)
−
---- [tag] reference of "ambience" to stop and music later with the same tag
+
-- this will return true
−
---- [continue] playing this music if another request for the same music comes in (false restarts it)
+
display(tblA == tblB)
−
---- [url] to download once from the Internet if the music does not exist in the profile's media directory
+
-- this will display false, as they are different tables
−
playMusicFile(
+
-- even though they have the same value
−
    "167124__patricia-mcmillen__rugby-club-in-spain.mp3" -- name
 
−
    , nil -- volume
 
−
    , 20000 -- fadein
 
−
    , 53000 -- fadeout
 
−
    , 10000 -- start
 
−
    , nil -- loops
 
−
    , "rugby" -- key
 
−
    , "ambience" -- tag
 
−
    , true -- continue
 
−
    , "https://raw.githubusercontent.com/StickMUD/StickMUDSounds/master/sounds/" -- url
 
−
    , 110000 -- finish
 
−
)
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==playSoundFile, PR #7026==
+
; Additional development notes
−
;playSoundFile(settings table)
+
This is just exposing the existing _comp function, which is currently the best way to compare two tables by value. --[[User:Demonnic|Demonnic]] ([[User talk:Demonnic|talk]]) 18:51, 7 February 2024 (UTC)
−
:Plays sound files from the Internet or the local file system to the "media" folder of the profile for later use with [[Manual:Miscellaneous_Functions#stopSounds|stopSounds()]].
 
  
−
{| class="wikitable"
+
==createVideoPlayer, PR #6439==
−
! Required
+
;createVideoPlayer([name of userwindow], x, y, width, height)
−
! Key
+
 
−
! Value
+
:Creates a miniconsole window for the video player to render in, the with the given dimensions. One can only create one video player at a time (currently), and it is not currently possible to have a label on or under the video player - otherwise, clicks won't register.
−
! Default
+
 
−
! style="text-align:left;"| Purpose
+
{{note}} A video player may also be created through use of the [[Manual:Scripting#MUD_Client_Media_Protocol|Mud Client Media Protocol]], the [[Manual:Miscellaneous_Functions#playVideoFile|playVideoFile()]] API command, or adding a Geyser.VideoPlayer object to ones user interface such as the example below.
−
|- style="color: green;"
+
 
−
| style="text-align:center;"| Yes
+
{{Note}} The Main Toolbar will show a '''Video''' button to hide/show the video player, which is located in a userwindow generated through createVideoPlayer, embedded in a user interface, or a dock-able widget (that can be floated free to anywhere on the Desktop, it can be resized and does not have to even reside on the same monitor should there be multiple screens in your system). Further clicks on the '''Video''' button will toggle between showing and hiding the map whether it was created using the ''createVideo'' function or as a dock-able widget.
−
| name
+
 
−
| <file name>
+
See also: [[Manual:Miscellaneous_Functions#loadSoundFile|loadSoundFile()]], [[Manual:Miscellaneous Functions#loadMusicFile|loadMusicFile()]], [[Manual:Miscellaneous Functions#loadVideoFile|loadVideoFile()]], [[Manual:Miscellaneous Functions#playSoundFile|playSoundFile()]], [[Manual:Miscellaneous_Functions#playMusicFile|playMusicFile()]], [[Manual:Miscellaneous Functions#playVideoFile|playVideoFile()]], [[Manual:Miscellaneous_Functions#stopSounds|stopSounds()]], [[Manual:Miscellaneous_Functions#stopMusic|stopMusic()]], [[Manual:Miscellaneous Functions#stopVideos|stopVideos()]], [[Manual:Miscellaneous_Functions#purgeMediaCache|purgeMediaCache()]], [[Manual:Scripting#MUD_Client_Media_Protocol|Mud Client Media Protocol]]
−
| &nbsp;
+
 
−
| style="text-align:left;"|
+
{{MudletVersion|4.??}}
−
* Name of the media file.
+
 
−
* May contain directory information (i.e. weather/lightning.wav).
+
;Example
−
* May be part of the profile (i.e. getMudletHomeDir().. "/cow.mp3")
+
<syntaxhighlight lang="lua">
−
* May be on the local device (i.e. "C:/Users/YourNameHere/Documents/nevergoingtogiveyouup.mp3")
+
-- Create a 300x300 video player in the top-left corner of Mudlet
−
* Wildcards ''*'' and ''?'' may be used within the name to randomize media files selection.
+
createVideoPlayer(0,0,300,300)
−
|-
+
 
−
| style="text-align:center;"| No
+
-- Alternative examples using Geyser.VideoPlayer
−
| volume
+
GUI.VideoPlayer = GUI.VideoPlayer or Geyser.VideoPlayer:new({name="GUI.VideoPlayer", x = 0, y = 0, width = "25%", height = "25%"})
−
| 1 to 100
+
   
−
| 50
+
GUI.VideoPlayer = GUI.VideoPlayer or Geyser.VideoPlayer:new({
−
| style="text-align:left;"|
+
  name = "GUI.VideoPlayer",
−
* Relative to the volume set on the player's client.
+
  x = "70%", y = 0, -- edit here if you want to move it
−
|-
+
  width = "30%", height = "50%"
−
| style="text-align:center;"| No
+
}, GUI.Right)
−
| fadein
+
</syntaxhighlight>
−
|<msec>
+
 
−
|
+
==loadVideoFile, PR #6439==
−
|
+
;loadVideoFile(settings table) or loadVideoFile(name, [url])
−
*Volume increases, or fades in, ranged across a linear pattern from one to the volume set with the "volume" key.
+
: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.
−
*Start position: Start of media.
+
 
−
*End position: Start of media plus the number of milliseconds (msec) specified.
+
{{note}} Video files consume drive space on your device. Consider using the streaming feature of [[Manual:Miscellaneous_Functions#playVideoFile|playVideoFile()]] for large files.
−
*1000 milliseconds = 1 second.
+
 
−
|-
+
{| class="wikitable"
−
| style="text-align:center;" |No
+
!Required
−
| fadeout
+
!Key
−
|<msec>
+
!Value
−
|
+
! style="text-align:left;" |Purpose
−
|
+
|- style="color: green;"
−
*Volume decreases, or fades out, ranged across a linear pattern from the volume set with the "volume" key to one.
+
| style="text-align:center;" |Yes
−
*Start position:  End of the media minus the number of milliseconds (msec) specified.
+
|name
−
*End position: End of the media.
+
|<file name>
−
*1000 milliseconds = 1 second.
+
| style="text-align:left;" |
−
|-
+
*Name of the media file.
−
| style="text-align:center;"| No
+
*May contain directory information (i.e. weather/maelstrom.mp4).
−
| start
+
*May be part of the profile (i.e. getMudletHomeDir().. "/congratulations.mp4")
−
| <msec>
+
*May be on the local device (i.e. "C:/Users/YourNameHere/Movies/nevergoingtogiveyouup.mp4")
−
| 0
+
|- style="color: blue;"
−
| style="text-align:left;"|
+
| style="text-align:center;" |Maybe
−
*  Begin play at the specified position in milliseconds.
+
|url
−
|-
+
|<url>
−
| style="text-align:center;"| No
 
−
| finish
 
−
| <msec>
 
−
|
 
−
| style="text-align:left;"|
 
−
* Finish play at the specified position in milliseconds.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
| loops
 
−
| -1, or >= 1
 
−
|1
 
 
| style="text-align:left;" |
 
| style="text-align:left;" |
−
*Number of iterations that the media plays.
+
*Resource location where the media file may be downloaded.
−
* A value of -1 allows the media to loop indefinitely.
+
*Only required if file to load is not part of the profile or on the local file system.
 
|-
 
|-
−
| style="text-align:center;" |No
+
|}
−
| key
 
−
|<key>
 
−
|&nbsp;
 
−
| style="text-align:left;" |
 
−
*Uniquely identifies media files with a "key" that is bound to their "name" or "url".
 
−
*Halts the play of current media files with the same "key" that have a different "name" or "url" while this media plays.
 
−
|-
 
−
| style="text-align:center;"| No
 
−
| tag
 
−
| <tag>
 
−
| &nbsp;
 
−
| style="text-align:left;"|
 
−
* Helps categorize media.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
| priority
 
−
| 1 to 100
 
−
|&nbsp;
 
−
| style="text-align:left;" |
 
−
*Halts the play of current or future played media files with a lower priority while this media plays.
 
−
|- style="color: blue;"
 
−
| style="text-align:center;"| Maybe
 
−
| url
 
−
| <url>
 
−
| &nbsp;
 
−
| style="text-align:left;"|
 
−
* Resource location where the media file may be downloaded.
 
−
* Only required if the file is to be downloaded remotely.
 
−
|-
 
−
|}
 
  
−
See also: [[Manual:Miscellaneous_Functions#loadMusicFile|loadMusicFile()]], [[Manual:Miscellaneous_Functions#loadSoundFile|loadSoundFile()]], [[Manual:Miscellaneous_Functions#playMusicFile|playMusicFile()]], [[Manual:Miscellaneous_Functions#stopMusic|stopMusic()]], [[Manual:Miscellaneous_Functions#stopSounds|stopSounds()]], [[Manual:Miscellaneous_Functions#purgeMediaCache|purgeMediaCache()]], [[Manual:Scripting#MUD_Client_Media_Protocol|Mud Client Media Protocol]]
+
See also: [[Manual:Miscellaneous_Functions#playSoundFile|loadSoundFile()]], [[Manual:Miscellaneous Functions#loadMusicFile|loadMusicFile()]], [[Manual:Miscellaneous Functions#playSoundFile|playSoundFile()]], [[Manual:Miscellaneous_Functions#playMusicFile|playMusicFile()]], [[Manual:Miscellaneous Functions#playVideoFile|playVideoFile()]], [[Manual:Miscellaneous_Functions#stopSounds|stopSounds()]], [[Manual:Miscellaneous_Functions#stopMusic|stopMusic()]], [[Manual:Miscellaneous Functions#stopVideos|stopVideos()]], [[Manual:Miscellaneous Functions#createVideoPlayer|createVideoPlayer()]], [[Manual:Miscellaneous_Functions#purgeMediaCache|purgeMediaCache()]], [[Manual:Scripting#MUD_Client_Media_Protocol|Mud Client Media Protocol]]
  
−
{{Note}} on Windows and certain files are not playing? Try installing the 3rd party [https://codecguide.com/download_k-lite_codec_pack_standard.htm K-lite codec pack].
+
{{MudletVersion|4.??}}
−
 
 
−
{{MudletVersion|4.15}}
 
  
 
;Example
 
;Example
Line 493: Line 341:
 
---- Table Parameter Syntax ----
 
---- Table Parameter Syntax ----
  
−
-- Play a sound file stored in the profile's media directory (i.e. /Users/Tamarindo/mudlet-data/profiles/StickMUD/media)
+
-- Download from the Internet
−
playSoundFile({
+
loadVideoFile({
−
     name = "cow.wav"
+
     name = "TextInMotion-VideoSample-1080p.mp4"
 +
    , url = "https://d2qguwbxlx1sbt.cloudfront.net/"
 
})
 
})
  
−
-- OR copy once from the game's profile, and play a sound file stored in the profile's media directory
+
-- OR download from the profile
−
---- [volume] of 75 (1 to 100)
+
loadVideoFile({name = getMudletHomeDir().. "/TextInMotion-VideoSample-1080p.mp4"})
−
playSoundFile({
 
−
    name = getMudletHomeDir().. "/cow.wav"
 
−
    , volume = 75
 
−
})
 
  
−
-- OR copy once from the local file system, and play a sound file stored in the profile's media directory
+
-- OR download from the local file system
−
---- [volume] of 75 (1 to 100)
+
loadVideoFile({name = "C:/Users/Tamarindo/Movies/TextInMotion-VideoSample-1080p.mp4"})
−
playSoundFile({
+
</syntaxhighlight>
−
    name = "C:/Users/Tamarindo/Documents/cow.wav"
 
−
    , volume = 75
 
−
})
 
−
 
 
−
-- OR download once from the Internet, and play a sound stored in the profile's media directory
 
−
---- [volume] of 75
 
−
---- [loops] of 2 (-1 for indefinite repeats, 1+ for finite repeats)
 
−
---- [key] reference of "cow" for stopping this unique sound later
 
−
---- [tag] reference of "animals" to stop a group of sounds later with the same tag
 
−
---- [priority] of 25 (1 to 100, 50 default, a sound with a higher priority would stop this one)
 
−
---- [url] to download once from the Internet if the sound does not exist in the profile's media directory
 
−
playSoundFile({
 
−
    name = "cow.wav"
 
−
    , volume = 75
 
−
    , fadein = nil -- nil lines are optional, no need to use
 
−
    , fadeout = nil -- nil lines are optional, no need to use
 
−
    , start = nil -- nil lines are optional, no need to use
 
−
    , finish = nil -- nil lines are optional, no need to use
 
−
    , loops = 2
 
−
    , key = "cow"
 
−
    , tag = "animals"
 
−
    , priority = 25
 
−
    , url = "https://raw.githubusercontent.com/StickMUD/StickMUDSounds/master/sounds/"
 
−
})
 
−
</syntaxhighlight>
 
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
---- Ordered Parameter Syntax of playSoundFile(name[,volume][,fadein][,fadeout][,loops][,key][,tag][,priority][,url][,finish]) ----
+
---- Ordered Parameter Syntax of loadVideoFile(name[, url]) ----
  
−
-- Play a sound file stored in the profile's media directory (i.e. /Users/Tamarindo/mudlet-data/profiles/StickMUD/media)
+
-- Download from the Internet
−
playSoundFile(
+
loadVideoFile(
−
     "cow.wav" -- name
+
    "TextInMotion-VideoSample-1080p.mp4"
 +
     , "https://d2qguwbxlx1sbt.cloudfront.net/"
 
)
 
)
  
−
-- OR copy once from the game's profile, and play a sound file stored in the profile's media directory
+
-- OR download from the profile
−
---- [volume] of 75 (1 to 100)
+
loadVideoFile(getMudletHomeDir().. "/TextInMotion-VideoSample-1080p.mp4")
−
playSoundFile(
 
−
    getMudletHomeDir().. "/cow.wav" -- name
 
−
    , 75 -- volume
 
−
)
 
  
−
-- OR copy once from the local file system, and play a sound file stored in the profile's media directory
+
-- OR download from the local file system
−
---- [volume] of 75 (1 to 100)
+
loadVideoFile("C:/Users/Tamarindo/Movies/TextInMotion-VideoSample-1080p.mp4")
−
playSoundFile(
 
−
    "C:/Users/Tamarindo/Documents/cow.wav" -- name
 
−
    , 75 -- volume
 
−
)
 
−
 
 
−
-- OR download once from the Internet, and play a sound stored in the profile's media directory
 
−
---- [volume] of 75
 
−
---- [loops] of 2 (-1 for indefinite repeats, 1+ for finite repeats)
 
−
---- [key] reference of "cow" for stopping this unique sound later
 
−
---- [tag] reference of "animals" to stop a group of sounds later with the same tag
 
−
---- [priority] of 25 (1 to 100, 50 default, a sound with a higher priority would stop this one)
 
−
---- [url] to download once from the Internet if the sound does not exist in the profile's media directory
 
−
playSoundFile(
 
−
    "cow.wav" -- name
 
−
    , 75 -- volume
 
−
    , nil -- fadein
 
−
    , nil -- fadeout
 
−
    , nil -- start
 
−
    , 2 -- loops
 
−
    , "cow" -- key
 
−
    , "animals" -- tag
 
−
    , 25 -- priority
 
−
    , "https://raw.githubusercontent.com/StickMUD/StickMUDSounds/master/sounds/" -- url
 
−
    , nil -- finish
 
−
)
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==stopMusic, PR #7026==
+
==playVideoFile, PR #6439==
−
;stopMusic(settings table)
+
;playVideoFile(settings table)
−
:Stop all music (no filter), or music that meets a combination of filters (name, key, and tag) intended to be paired with [[Manual:Miscellaneous_Functions#playMusicFile|playMusicFile()]].
+
:Plays video files from the Internet or the local file system for later use with [[Manual:Miscellaneous_Functions#stopMusic|stopMusic()]]. Video files may be downloaded to the device and played, or streamed from the Internet when the value of the <code>stream</code> parameter is <code>true</code>.
  
 
{| class="wikitable"
 
{| class="wikitable"
−
! Required
+
!Required
−
! Key
+
!Key
−
! Value
+
!Value
 
!Default
 
!Default
−
! style="text-align:left;"| Purpose
+
! style="text-align:left;" |Purpose
 +
|- style="color: green;"
 +
| style="text-align:center;" |Yes
 +
|name
 +
|<file name>
 +
|&nbsp;
 +
| 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().. "/cow.mp4")
 +
* May be on the local device (i.e. "C:/Users/YourNameHere/Documents/nevergoingtogiveyouup.mp4")
 +
*Wildcards ''*'' and ''?'' may be used within the name to randomize media files selection.
 
|-
 
|-
−
| style="text-align:center;"| No
+
| style="text-align:center;" |No
−
| name
+
| volume
−
| <file name>
+
|1 to 100
−
|
+
|50
−
| style="text-align:left;"|
+
| style="text-align:left;" |
−
* Name of the media file.
+
*Relative to the volume set on the player's client.
 
|-
 
|-
 
| style="text-align:center;" |No
 
| style="text-align:center;" |No
−
| key
+
|fadein
−
|<key>
+
|<msec>
 +
|
 
|
 
|
−
| style="text-align:left;" |
+
*Volume increases, or fades in, ranged across a linear pattern from one to the volume set with the "volume" key.
−
*Uniquely identifies media files with a "key" that is bound to their "name" or "url".
+
*Start position:  Start of media.
−
*Halts the play of current media files with the same "key" that have a different "name" or "url" while this media plays.
+
*End position:  Start of media plus the number of milliseconds (msec) specified.
 +
*1000 milliseconds = 1 second.
 
|-
 
|-
−
| style="text-align:center;"| No
+
| style="text-align:center;" |No
−
| tag
+
|fadeout
−
| <tag>
+
|<msec>
 
|
 
|
−
| style="text-align:left;"|
+
|
−
* Helps categorize media.
+
*Volume decreases, or fades out, ranged across a linear pattern from the volume set with the "volume" key to one.
 +
*Start position: End of the media minus the number of milliseconds (msec) specified.
 +
*End position:  End of the media.
 +
*1000 milliseconds = 1 second.
 
|-
 
|-
−
| style="text-align:center;"| No
+
| style="text-align:center;" |No
−
| fadeaway
+
|start
−
| true or false
+
|<msec>
−
|false
+
| 0
 
| style="text-align:left;" |
 
| style="text-align:left;" |
−
* Decrease volume from the current position for a given duration, then stops the track.
+
*Begin play at the specified position in milliseconds.
−
* Given duration is the lesser of the remaining track duration or the fadeout specified in playMusicFile().
 
−
* If fadeout was not specified in playMusicFile(), then the optional fadeout parameter from stopMusic() or a default of 5000 milliseconds will be applied.
 
 
|-
 
|-
−
| style="text-align:center;"| No
+
| style="text-align:center;" |No
−
| fadeout
+
|loops
−
|  
+
| -1, or >= 1
−
|5000
+
|1
−
| style="text-align:left;" |
+
| style="text-align:left;" |
−
* Default duration in milliseconds to decrease volume to the end of the track.
+
*Number of iterations that the media plays.
−
* Only used if fadeout was not defined in playMusicFile().
+
*A value of -1 allows the media to loop indefinitely.
 +
|-
 +
| style="text-align:center;" |No
 +
|key
 +
|<key>
 +
|&nbsp;
 +
| style="text-align:left;" |
 +
*Uniquely identifies media files with a "key" that is bound to their "name" or "url".
 +
*Halts the play of current media files with the same "key" that have a different "name" or "url" while this media plays.
 
|-
 
|-
−
|}
+
| style="text-align:center;" |No
−
 
+
|tag
−
See also: [[Manual:Miscellaneous_Functions#loadMusicFile|loadMusicFile()]], [[Manual:Miscellaneous_Functions#loadSoundFile|loadSoundFile()]], [[Manual:Miscellaneous_Functions#playMusicFile|playMusicFile()]], [[Manual:Miscellaneous_Functions#playSoundFile|playSoundFile()]], [[Manual:Miscellaneous_Functions#stopSounds|stopSounds()]], [[Manual:Miscellaneous_Functions#purgeMediaCache|purgeMediaCache()]], [[Manual:Scripting#MUD_Client_Media_Protocol|Mud Client Media Protocol]]
+
|<tag>
−
 
+
|&nbsp;
−
{{MudletVersion|4.15}}
+
| style="text-align:left;" |
−
 
+
*Helps categorize media.
−
;Example
+
|-
−
 
+
| style="text-align:center;" |No
−
<syntaxhighlight lang="lua">
+
|continue
−
---- Table Parameter Syntax ----
+
|true or false
−
 
+
|true
−
-- Stop all playing music files for this profile associated with the API
+
| style="text-align:left;" |
−
stopMusic()
+
*Continues playing matching new video files when true.
−
 
+
*Restarts matching new video files when false.
−
-- Stop playing the rugby mp3 by name
+
|- style="color: blue;"
−
stopMusic({name = "167124__patricia-mcmillen__rugby-club-in-spain.mp3"})
+
| style="text-align:center;" |Maybe
−
 
+
|url
−
-- Stop playing the unique sound identified as "rugby"
+
|<url>
−
stopMusic({
+
|&nbsp;
−
    name = nil  -- nil lines are optional, no need to use
+
| style="text-align:left;" |
−
    , key = "rugby" -- key
+
*Resource location where the media file may be downloaded.
−
    , tag = nil  -- nil lines are optional, no need to use
+
*Only required if the file is to be downloaded remotely or for streaming from the Internet.
−
})
+
|- style="color: blue;"
−
 
+
| style="text-align:center;" |Maybe
−
-- Decrease volume for 5 seconds and then stop all playing music files for this profile associated with the API
+
|stream
−
stopMusic({
+
|true or false
−
    fadeaway = true
+
|false
−
})
+
| style="text-align:left;" |
−
 
+
*Streams files from the Internet when true.
−
-- Decrease volume for 10 seconds (or apply the duration of fadeout set in playMusicFile()) and then stop all playing music files for this profile associated with the API
+
*Download files when false (default).
−
stopMusic({
+
*Used in combination with the `url` key.
−
    fadeaway = true
+
|-
−
    , fadeout = 10000
+
|}
−
})
 
−
 
 
−
-- Decrease volume for 5 seconds and then stop all the unique "rugby" music for this profile associated with the API
 
−
stopMusic({
 
−
    key = "rugby"
 
−
    , fadeaway = true
 
−
})
 
−
</syntaxhighlight>
 
−
<syntaxhighlight lang="lua">
 
−
---- Ordered Parameter Syntax of stopMusic([name][,key][,tag][,fadeaway][,fadeout]) ----
 
−
 
 
−
-- Stop all playing music files for this profile associated with the API
 
−
stopMusic()
 
  
−
-- Stop playing the rugby mp3 by name
+
See also: [[Manual:Miscellaneous Functions#loadSoundFile|loadSoundFile()]], [[Manual:Miscellaneous Functions#loadMusicFile|loadMusicFile()]], [[Manual:Miscellaneous Functions#loadVideoFile|loadVideoFile()]], [[Manual:Miscellaneous_Functions#playSoundFile|playSoundFile()]], [[Manual:Miscellaneous Functions#playMusicFile|playMusicFile()]], [[Manual:Miscellaneous Functions#stopSounds|stopSounds()]], [[Manual:Miscellaneous Functions#stopMusic|stopMusic()]], [[Manual:Miscellaneous Functions#stopVideos|stopVideos()]], [[Manual:Miscellaneous Functions#createVideoPlayer|createVideoPlayer()]], [[Manual:Miscellaneous_Functions#purgeMediaCache|purgeMediaCache()]], [[Manual:Scripting#MUD_Client_Media_Protocol|Mud Client Media Protocol]]
−
stopMusic("167124__patricia-mcmillen__rugby-club-in-spain.mp3")
 
  
−
-- Stop playing the unique sound identified as "rugby"
+
{{MudletVersion|4.??}}
−
stopMusic(
 
−
    nil -- name
 
−
    , "rugby" -- key
 
−
    , nil -- tag
 
−
)
 
  
−
-- Decrease the volume for 10 seconds then stop playing the unique sound identified as "rugby"
+
;Example
−
stopMusic(
 
−
    nil -- name
 
−
    , "rugby" -- key
 
−
    , nil -- tag
 
−
    , true -- fadeaway
 
−
    , 10000 -- fadeout
 
−
)
 
−
</syntaxhighlight>
 
  
−
==stopSounds, PR #7026==
+
<syntaxhighlight lang="lua">
−
;stopSounds(settings table)
+
---- Table Parameter Syntax ----
−
:Stop all sounds (no filter), or sounds that meets a combination of filters (name, key, tag, and priority) intended to be paired with [[Manual:Miscellaneous_Functions#playSoundFile|playSoundFile()]].
 
  
−
{| class="wikitable"
+
-- Stream a video file from the Internet and play it.
−
! Required
+
playVideoFile({
−
! Key
+
    name = "TextInMotion-VideoSample-1080p.mp4"
−
! Value
+
    , url = "https://d2qguwbxlx1sbt.cloudfront.net/"
−
! Default
+
    , stream = true
−
! style="text-align:left;"| Purpose
+
})
−
|-
+
 
−
| style="text-align:center;"| No
+
-- Play a video file from the Internet, storing it in the profile's media directory (i.e. /Users/Tamarindo/mudlet-data/profiles/StickMUD/media) so you don't need to download it over and over. You could add ", stream = false" below, but that is the default and is not needed.
−
| name
+
 
−
| <file name>
+
playVideoFile({
−
|
+
    name = "TextInMotion-VideoSample-1080p.mp4"
−
| style="text-align:left;"|
+
    , url = "https://d2qguwbxlx1sbt.cloudfront.net/"
−
* Name of the media file.
+
})
−
|-
+
 
−
| style="text-align:center;" |No
+
-- Play a video file stored in the profile's media directory (i.e. /Users/Tamarindo/mudlet-data/profiles/StickMUD/media)
−
| key
+
playVideoFile({
−
|<key>
+
     name = "TextInMotion-VideoSample-1080p.mp4"
−
|
 
−
| style="text-align:left;" |
 
−
*Uniquely identifies media files with a "key" that is bound to their "name" or "url".
 
−
*Halts the play of current media files with the same "key" that have a different "name" or "url" while this media plays.
 
−
|-
 
−
| style="text-align:center;"| No
 
−
| tag
 
−
| <tag>
 
−
|
 
−
| style="text-align:left;"|
 
−
* Helps categorize media.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
| priority
 
−
| 1 to 100
 
−
|
 
−
| style="text-align:left;" |
 
−
*Halts the play of current or future played media files with a matching or lower priority.
 
−
|-
 
−
| style="text-align:center;"| No
 
−
| fadeaway
 
−
| true or false
 
−
|false
 
−
| style="text-align:left;" |
 
−
* Decrease volume from the current position for a given duration, then stops the track.
 
−
* Given duration is the lesser of the remaining track duration or the fadeout specified in playSoundFile().
 
−
* If fadeout was not specified in playSoundFile(), then the optional fadeout parameter from stopSounds() or a default of 5000 milliseconds will be applied.
 
−
|-
 
−
| style="text-align:center;"| No
 
−
| fadeout
 
−
|
 
−
|5000
 
−
| style="text-align:left;" |
 
−
* Default duration in milliseconds to decrease volume to the end of the track.
 
−
* Only used if fadeout was not defined in playSoundFile().
 
−
|-
 
−
|}
 
−
 
 
−
See also: [[Manual:Miscellaneous_Functions#loadMusicFile|loadMusicFile()]], [[Manual:Miscellaneous_Functions#loadSoundFile|loadSoundFile()]], [[Manual:Miscellaneous_Functions#playMusicFile|playMusicFile()]], [[Manual:Miscellaneous_Functions#playSoundFile|playSoundFile()]], [[Manual:Miscellaneous_Functions#stopMusic|stopMusic()]], [[Manual:Miscellaneous_Functions#purgeMediaCache|purgeMediaCache()]], [[Manual:Scripting#MUD_Client_Media_Protocol|Mud Client Media Protocol]]
 
−
 
 
−
{{MudletVersion|4.15}}
 
−
 
 
−
;Example
 
−
 
 
−
<syntaxhighlight lang="lua">
 
−
---- Table Parameter Syntax ----
 
−
 
 
−
-- Stop all playing sound files for this profile associated with the API
 
−
stopSounds()
 
−
 
 
−
-- Stop playing the cow sound
 
−
stopSounds({name = "cow.wav"})
 
−
 
 
−
-- Stop playing any sounds tagged as "animals" with a priority less than or equal to 50
 
−
---- This would not stop sounds tagged as "animals" greater than priority 50. This is an "AND" and not an "OR".
 
−
stopSounds({
 
−
     name = nil -- nil lines are optional, no need to use
 
−
    , key = nil -- nil lines are optional, no need to use
 
−
    , tag = "animals"
 
−
    , priority = 50
 
 
})
 
})
  
−
-- Decrease volume for 5 seconds and then stop all playing sound files for this profile associated with the API
+
-- OR copy once from the game's profile, and play a video file stored in the profile's media directory
−
stopSounds({
+
---- [volume] of 75 (1 to 100)
−
     fadeaway = true
+
playVideoFile({
 +
     name = getMudletHomeDir().. "/TextInMotion-VideoSample-1080p.mp4"
 +
    , volume = 75
 
})
 
})
  
−
-- Decrease volume for 10 seconds (or apply the duration of fadeout set in playSoundFile()) and then stop all playing music files for this profile associated with the API
+
-- OR copy once from the local file system, and play a video file stored in the profile's media directory
−
stopSounds({
+
---- [volume] of 75 (1 to 100)
−
     fadeaway = true
+
playVideoFile({
−
     , fadeout = 10000
+
     name = "C:/Users/Tamarindo/Movies/TextInMotion-VideoSample-1080p.mp4"
 +
     , volume = 75
 
})
 
})
  
−
-- Decrease volume for 3 seconds and then stop all the tagged "animals" music for this profile associated with the API
+
-- OR download once from the Internet, and play a video stored in the profile's media directory
−
stopSounds({
+
---- [fadein] and increase the volume from 1 at the start position to default volume up until the position of 10 seconds
−
     tag = "animals"
+
---- [fadeout] and decrease the volume from default volume to one, 15 seconds from the end of the video
−
     , fadeaway = true
+
---- [start] 5 seconds after position 0 (fadein scales its volume increase over a shorter duration, too)
−
     , fadeout = 3000
+
---- [key] reference of "text" for stopping this unique video later
 +
---- [tag] reference of "ambience" to stop any video later with the same tag
 +
---- [continue] playing this video if another request for the same video comes in (false restarts it)
 +
---- [url] resource location where the file may be accessed on the Internet
 +
---- [stream] download once from the Internet if the video does not exist in the profile's media directory when false (true streams from the Internet and will not download to the device)
 +
playVideoFile({
 +
     name = "TextInMotion-VideoSample-1080p.mp4"
 +
    , volume = nil -- nil lines are optional, no need to use
 +
    , fadein = 10000
 +
    , fadeout = 15000
 +
    , start = 5000
 +
    , loops = nil -- nil lines are optional, no need to use
 +
    , key = "text"
 +
    , tag = "ambience"
 +
     , continue = true
 +
     , url = "https://d2qguwbxlx1sbt.cloudfront.net/"
 +
    , stream = false
 
})
 
})
 
</syntaxhighlight>
 
</syntaxhighlight>
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
---- Ordered Parameter Syntax of stopSounds([name][,key][,tag][,priority][,fadeaway][,fadeout]) ----
+
---- Ordered Parameter Syntax of playVideoFile(name[,volume][,fadein][,fadeout][,loops][,key][,tag][,continue][,url][,stream]) ----
  
−
-- Stop all playing sound files for this profile associated with the API
+
-- Stream a video file from the Internet and play it.
−
stopSounds()
+
playVideoFile(
−
 
+
    "TextInMotion-VideoSample-1080p.mp4"
−
-- Stop playing the cow sound
+
    , nil -- volume
−
stopSounds("cow.wav")
+
    , nil -- fadein
−
 
+
    , nil -- fadeout
−
-- Stop playing any sounds tagged as "animals" with a priority less than or equal to 50
+
    , nil -- start
−
---- This would not stop sounds tagged as "animals" greater than priority 50.  This is an "AND" and not an "OR".
+
     , nil -- loops
−
stopSounds(
 
−
     nil -- name
 
 
     , nil -- key
 
     , nil -- key
−
     , "animals" -- tag
+
    , nil -- tag
−
     , 50 -- priority
+
    , true -- continue
 +
     , "https://d2qguwbxlx1sbt.cloudfront.net/" -- url
 +
     , false -- stream
 
)
 
)
  
−
-- Decrease the volume for 7 seconds and then stop playing sounds
+
-- Play a video file from the Internet, storing it in the profile's media directory (i.e. /Users/Tamarindo/mudlet-data/profiles/StickMUD/media) so you don't need to download it over and over.
−
stopSounds(
+
playVideoFile(
−
     nil -- name
+
     "TextInMotion-VideoSample-1080p.mp4"
 +
    , nil -- volume
 +
    , nil -- fadein
 +
    , nil -- fadeout
 +
    , nil -- start
 +
    , nil -- loops
 
     , nil -- key
 
     , nil -- key
 
     , nil -- tag
 
     , nil -- tag
−
     , nil -- priority
+
     , true -- continue
−
     , true -- fadeaway
+
     , "https://d2qguwbxlx1sbt.cloudfront.net/" -- url
−
     , 7000 -- fadeout
+
     , false -- stream
 
)
 
)
−
</syntaxhighlight>
 
  
−
==createVideoPlayer, PR #6439==
+
-- Play a video file stored in the profile's media directory (i.e. /Users/Tamarindo/mudlet-data/profiles/StickMUD/media)
−
;createVideoPlayer([name of userwindow], x, y, width, height)
+
playVideoFile(
 +
    "TextInMotion-VideoSample-1080p.mp4"  -- name
 +
)
  
−
:Creates a miniconsole window for the video player to render in, the with the given dimensions. One can only create one video player at a time (currently), and it is not currently possible to have a label on or under the video player - otherwise, clicks won't register.
+
-- OR copy once from the game's profile, and play a video file stored in the profile's media directory
 +
---- [volume] of 75 (1 to 100)
 +
playVideoFile(
 +
    getMudletHomeDir().. "/TextInMotion-VideoSample-1080p.mp4" -- name
 +
    , 75 -- volume
 +
)
  
−
{{note}} A video player may also be created through use of the [[Manual:Scripting#MUD_Client_Media_Protocol|Mud Client Media Protocol]], the [[Manual:Miscellaneous_Functions#playVideoFile|playVideoFile()]] API command, or adding a Geyser.VideoPlayer object to ones user interface such as the example below.
+
-- OR copy once from the local file system, and play a video file stored in the profile's media directory
 +
---- [volume] of 75 (1 to 100)
 +
playVideoFile(
 +
    "C:/Users/Tamarindo/Documents/TextInMotion-VideoSample-1080p.mp4" -- name
 +
    , 75 -- volume
 +
)
  
−
{{Note}} The Main Toolbar will show a '''Video''' button to hide/show the video player, which is located in a userwindow generated through createVideoPlayer, embedded in a user interface, or a dock-able widget (that can be floated free to anywhere on the Desktop, it can be resized and does not have to even reside on the same monitor should there be multiple screens in your system). Further clicks on the '''Video''' button will toggle between showing and hiding the map whether it was created using the ''createVideo'' function or as a dock-able widget.
+
-- OR download once from the Internet, and play a video stored in the profile's media directory
−
 
+
---- [fadein] and increase the volume from 1 at the start position to default volume up until the position of 10 seconds
−
See also: [[Manual:Miscellaneous_Functions#loadSoundFile|loadSoundFile()]], [[Manual:Miscellaneous Functions#loadMusicFile|loadMusicFile()]], [[Manual:Miscellaneous Functions#loadVideoFile|loadVideoFile()]], [[Manual:Miscellaneous Functions#playSoundFile|playSoundFile()]], [[Manual:Miscellaneous_Functions#playMusicFile|playMusicFile()]], [[Manual:Miscellaneous Functions#playVideoFile|playVideoFile()]], [[Manual:Miscellaneous_Functions#stopSounds|stopSounds()]], [[Manual:Miscellaneous_Functions#stopMusic|stopMusic()]], [[Manual:Miscellaneous Functions#stopVideos|stopVideos()]], [[Manual:Miscellaneous_Functions#purgeMediaCache|purgeMediaCache()]], [[Manual:Scripting#MUD_Client_Media_Protocol|Mud Client Media Protocol]]
+
---- [fadeout] and decrease the volume from default volume to one, 15 seconds from the end of the video
 +
---- [start] 5 seconds after position 0 (fadein scales its volume increase over a shorter duration, too)
 +
---- [key] reference of "text" for stopping this unique video later
 +
---- [tag] reference of "ambience" to stop any video later with the same tag
 +
---- [continue] playing this video if another request for the same video comes in (false restarts it)  
 +
---- [url] resource location where the file may be accessed on the Internet
 +
---- [stream] download once from the Internet if the video does not exist in the profile's media directory when false (true streams from the Internet and will not download to the device)  
 +
playVideoFile(
 +
    "TextInMotion-VideoSample-1080p.mp4" -- name
 +
    , nil -- volume
 +
    , 10000 -- fadein
 +
    , 15000 -- fadeout
 +
    , 5000 -- start
 +
    , nil -- loops
 +
    , "text" -- key
 +
    , "ambience" -- tag
 +
    , true -- continue
 +
    , "https://d2qguwbxlx1sbt.cloudfront.net/" -- url
 +
    , false -- stream
 +
)
 +
</syntaxhighlight>
  
−
{{MudletVersion|4.18}}
 
  
−
;Example
+
==stopVideos, PR #6439==
−
<syntaxhighlight lang="lua">
+
;stopVideos(settings table)
−
-- Create a 300x300 video player in the top-left corner of Mudlet
+
:Stop all videos (no filter), or videos that meet a combination of filters (name, key, and tag) intended to be paired with [[Manual:Miscellaneous_Functions#playVideoFile|playVideoFile()]].
−
createVideoPlayer(0,0,300,300)
 
−
 
 
−
-- Alternative examples using Geyser.VideoPlayer
 
−
GUI.VideoPlayer = GUI.VideoPlayer or Geyser.VideoPlayer:new({name="GUI.VideoPlayer", x = 0, y = 0, width = "25%", height = "25%"})
 
−
 
−
GUI.VideoPlayer = GUI.VideoPlayer or Geyser.VideoPlayer:new({
 
−
  name = "GUI.VideoPlayer",
 
−
  x = "70%", y = 0, -- edit here if you want to move it
 
−
  width = "30%", height = "50%"
 
−
}, GUI.Right)
 
−
</syntaxhighlight>
 
−
 
 
−
==loadVideoFile, PR #6439==
 
−
;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"
 
{| class="wikitable"
Line 863: Line 626:
 
!Value
 
!Value
 
! style="text-align:left;" |Purpose
 
! style="text-align:left;" |Purpose
−
|- style="color: green;"
+
|-
−
| style="text-align:center;" |Yes
+
| style="text-align:center;" |No
−
|name
+
| name
−
|<file name>
+
| <file name>
 
| style="text-align:left;" |
 
| style="text-align:left;" |
−
*Name of the media file.
+
* 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")
+
| style="text-align:center;" |No
−
*May be on the local device (i.e. "C:/Users/YourNameHere/Movies/nevergoingtogiveyouup.mp4")
+
|key
−
|- style="color: blue;"
+
|<key>
−
| style="text-align:center;" |Maybe
+
| style="text-align:left;" |
−
|url
+
*Uniquely identifies media files with a "key" that is bound to their "name" or "url".
−
|<url>
+
*Halts the play of current media files with the same "key" that have a different "name" or "url" while this media plays.
 +
|-
 +
| style="text-align:center;" |No
 +
|tag
 +
|<tag>
 
| style="text-align:left;" |
 
| style="text-align:left;" |
−
*Resource location where the media file may be downloaded.
+
*Helps categorize media.
−
*Only required if file to load is not part of the profile or on the local file system.
 
 
|-
 
|-
 
|}
 
|}
  
−
See also: [[Manual:Miscellaneous_Functions#playSoundFile|loadSoundFile()]], [[Manual:Miscellaneous Functions#loadMusicFile|loadMusicFile()]], [[Manual:Miscellaneous Functions#playSoundFile|playSoundFile()]], [[Manual:Miscellaneous_Functions#playMusicFile|playMusicFile()]], [[Manual:Miscellaneous Functions#playVideoFile|playVideoFile()]], [[Manual:Miscellaneous_Functions#stopSounds|stopSounds()]], [[Manual:Miscellaneous_Functions#stopMusic|stopMusic()]], [[Manual:Miscellaneous Functions#stopVideos|stopVideos()]], [[Manual:Miscellaneous Functions#createVideoPlayer|createVideoPlayer()]], [[Manual:Miscellaneous_Functions#purgeMediaCache|purgeMediaCache()]], [[Manual:Scripting#MUD_Client_Media_Protocol|Mud Client Media Protocol]]
+
See also: [[Manual:Miscellaneous_Functions#loadSoundFile|loadSoundFile()]], [[Manual:Miscellaneous_Functions#loadMusicFile|loadMusicFile()]], [[Manual:Miscellaneous_Functions#loadVideoFile|loadVideoFile()]], [[Manual:Miscellaneous_Functions#playSoundFile|playSoundFile()]], [[Manual:Miscellaneous_Functions#playMusicFile|playMusicFile()]], [[Manual:Miscellaneous_Functions#playVideoFile|playVideoFile()]], [[Manual:Miscellaneous_Functions#stopSounds|stopSounds()]], [[Manual:Miscellaneous Functions#stopMusic|stopMusic()]], [[Manual:Miscellaneous Functions#createVideoPlayer|createVideoPlayer()]], [[Manual:Miscellaneous_Functions#purgeMediaCache|purgeMediaCache()]], [[Manual:Scripting#MUD_Client_Media_Protocol|Mud Client Media Protocol]]
  
−
{{MudletVersion|4.18}}
+
{{MudletVersion|4.??}}
  
 
;Example
 
;Example
Line 891: Line 657:
 
---- Table Parameter Syntax ----
 
---- Table Parameter Syntax ----
  
−
-- Download from the Internet
+
-- Stop all playing video files for this profile associated with the API
−
loadVideoFile({
+
stopVideos()
−
    name = "TextInMotion-VideoSample-1080p.mp4"
 
−
    , url = "https://d2qguwbxlx1sbt.cloudfront.net/"
 
−
})
 
  
−
-- OR download from the profile
+
-- Stop playing the text mp4 by name
−
loadVideoFile({name = getMudletHomeDir().. "/TextInMotion-VideoSample-1080p.mp4"})
+
stopVideos({name = "TextInMotion-VideoSample-1080p.mp4"})
  
−
-- OR download from the local file system
+
-- Stop playing the unique sound identified as "text"
−
loadVideoFile({name = "C:/Users/Tamarindo/Movies/TextInMotion-VideoSample-1080p.mp4"})
+
stopVideos({
 +
    name = nil  -- nil lines are optional, no need to use
 +
    , key = "text" -- key
 +
    , tag = nil  -- nil lines are optional, no need to use
 +
})
 
</syntaxhighlight>
 
</syntaxhighlight>
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
---- Ordered Parameter Syntax of loadVideoFile(name[, url]) ----
+
---- Ordered Parameter Syntax of stopVideos([name][,key][,tag]) ----
  
−
-- Download from the Internet
+
-- Stop all playing video files for this profile associated with the API
−
loadVideoFile(
+
stopVideos()
−
    "TextInMotion-VideoSample-1080p.mp4"
 
−
    , "https://d2qguwbxlx1sbt.cloudfront.net/"
 
−
)
 
  
−
-- OR download from the profile
+
-- Stop playing the text mp4 by name
−
loadVideoFile(getMudletHomeDir().. "/TextInMotion-VideoSample-1080p.mp4")
+
stopVideos("TextInMotion-VideoSample-1080p.mp4")
  
−
-- OR download from the local file system
+
-- Stop playing the unique sound identified as "text"
−
loadVideoFile("C:/Users/Tamarindo/Movies/TextInMotion-VideoSample-1080p.mp4")
+
stopVideos(
 +
    nil -- name
 +
    , "text" -- key
 +
    , nil -- tag
 +
)
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==playVideoFile, PR #6439==
 
−
;playVideoFile(settings table)
 
−
:Plays video files from the Internet or the local file system for later use with [[Manual:Miscellaneous_Functions#stopMusic|stopMusic()]]. Video files may be downloaded to the device and played, or streamed from the Internet when the value of the <code>stream</code> parameter is <code>true</code>.
 
  
 +
==getCustomLoginTextId, PR #3952 open==
 +
;getCustomLoginTextId()
 +
 +
Returns the Id number of the custom login text setting from the profile's preferences. Returns ''0'' if the option is disabled or a number greater than that for the item in the table; note it is possible if using an old saved profile in the future that the number might be higher than expected. As a design policy decision it is not permitted for a script to change the setting, this function is intended to allow a script or package to check that the setting is what it expects.
 +
 +
Introduced along with four other functions to enable game server log-in to be scripted with the simultaneous movement of that functionality from the Mudlet application core code to a predefined ''doLogin()'' function, a replacement for which is shown below.
 +
:See also: [[#getCharacterName|getCharacterName()]], [[#sendCharacterName|sendCharacterName()]], [[#sendCustomLoginText|sendCustomLoginText()]], [[#sendPassword|sendPassword()]].
 +
 +
{{note}} Not available yet. See https://github.com/Mudlet/Mudlet/pull/3952
 +
 +
Only one custom login text has been defined initially:
 
{| class="wikitable"
 
{| class="wikitable"
−
!Required
+
|+Predefined custom login texts
−
!Key
+
|-
−
!Value
+
!Id!!Custom text!!Introduced in Mudlet version
−
!Default
 
−
! style="text-align:left;" |Purpose
 
−
|- style="color: green;"
 
−
| style="text-align:center;" |Yes
 
−
|name
 
−
|<file name>
 
−
|&nbsp;
 
−
| 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().. "/cow.mp4")
 
−
* May be on the local device (i.e. "C:/Users/YourNameHere/Documents/nevergoingtogiveyouup.mp4")
 
−
*Wildcards ''*'' and ''?'' may be used within the name to randomize media files selection.
 
 
|-
 
|-
−
| style="text-align:center;" |No
+
|1||"connect {character name} {password}"||TBD
−
| volume
+
|}
−
|1 to 100
+
 
−
|50
+
The addition of further texts would be subject to negotiation with the Mudlet Makers.
−
| style="text-align:left;" |
+
 
−
*Relative to the volume set on the player's client.
+
;Example
−
|-
+
<syntaxhighlight lang="lua">
−
| style="text-align:center;" |No
+
-- A replacement for the default function placed into LuaGlobal.lua to reproduce the previous behavior of the Mudlet application:
−
|fadein
+
function doLogin()
−
|<msec>
+
  if getCustomLoginTextId() ~= 1 then
−
|
+
    -- We need this particular option but it is not permitted for a script to change the setting, it can only check what it is
−
|
+
    echo("\nUnable to login - please select the 'connect {character name} {password}` custom login option in the profile preferences.\n")
−
*Volume increases, or fades in, ranged across a linear pattern from one to the volume set with the "volume" key.
+
  else
−
*Start position: Start of media.
+
    tempTime(2.0, [[sendCustomLoginText()]], 1)
−
*End position:  Start of media plus the number of milliseconds (msec) specified.
+
  end
−
*1000 milliseconds = 1 second.
+
end
−
|-
+
</syntaxhighlight>
−
| style="text-align:center;" |No
+
 
−
|fadeout
+
==sendCharacterName, PR #3952 open==
−
|<msec>
+
;sendCharacterName()
−
|
+
 
−
|
+
Sends the name entered into the "Character name" field on the Connection Preferences form directly to the game server. Returns ''true'' unless there is nothing set in that entry in which case a ''nil'' and an error message will be returned instead.
−
*Volume decreases, or fades out, ranged across a linear pattern from the volume set with the "volume" key to one.
+
 
−
*Start position:  End of the media minus the number of milliseconds (msec) specified.
+
Introduced along with four other functions to enable game server log-in to be scripted with the simultaneous movement of that functionality from the Mudlet application core code to a predefined ''doLogin()'' function that may be replaced for more sophisticated requirements.
−
*End position: End of the media.
+
:See also: [[#getCharacterName|getCharacterName()]], [[#sendCharacterPassword|sendCharacterPassword()]], [[#sendCustomLoginText|sendCustomLoginText()]], [[#getCustomLoginTextId|getCustomLoginTextId()]].
−
*1000 milliseconds = 1 second.
+
 
−
|-
+
{{note}} Not available yet. See https://github.com/Mudlet/Mudlet/pull/3952
−
| style="text-align:center;" |No
+
 
−
|start
+
==sendCharacterPassword, PR #3952 open==
−
|<msec>
+
;sendCharacterPassword()
−
| 0
+
 
−
| style="text-align:left;" |
+
Sends the password entered into the "Password" field on the Connection Preferences form directly to the game server. Returns ''true'' unless there is nothing set in that entry or it is too long after (or before) a connection was successfully made in which case a ''nil'' and an error message will be returned instead.
−
*Begin play at the specified position in milliseconds.
+
 
−
|-
+
Introduced along with four other functions to enable game server log-in to be scripted with the simultaneous movement of that functionality from the Mudlet application core code to a predefined ''doLogin()'' function, reproduced below, that may be replaced for more sophisticated requirements.
−
| style="text-align:center;" |No
+
:See also: [[#getCharacterName|getCharacterName()]], [[#sendCustomLoginText|sendCustomLoginText()]], [[#getCustomLoginTextId|getCustomLoginTextId()]], [[#sendCharacterName|sendCharacterName()]].
−
|loops
+
 
−
| -1, or >= 1
+
{{note}} Not available yet. See https://github.com/Mudlet/Mudlet/pull/3952
−
|1
+
 
−
| style="text-align:left;" |
+
;Example
−
*Number of iterations that the media plays.
+
<syntaxhighlight lang="lua">
−
*A value of -1 allows the media to loop indefinitely.
+
-- The default function placed into LuaGlobal.lua to reproduce the previous behavior of the Mudlet application:
−
|-
+
function doLogin()
−
| style="text-align:center;" |No
+
  if getCharacterName() ~= "" then
−
|key
+
    tempTime(2.0, [[sendCharacterName()]], 1)
−
|<key>
+
    tempTime(3.0, [[sendCharacterPassword()]], 1)
−
|&nbsp;
+
  end
−
| style="text-align:left;" |
+
end
−
*Uniquely identifies media files with a "key" that is bound to their "name" or "url".
+
</syntaxhighlight>
−
*Halts the play of current media files with the same "key" that have a different "name" or "url" while this media plays.
+
 
 +
==sendCustomLoginText, PR #3952 open ==
 +
;sendCustomLoginText()
 +
 
 +
Sends the custom login text (which does NOT depend on the user's choice of GUI language) selected in the preferences for this profile. The {password} (and {character name} if present) fields will be replaced with the values entered into the "Password" and "Character name" fields on the Connection Preferences form and then sent directly to the game server. Returns ''true'' unless there is nothing set in either of those entries (though only if required for the character name) or it is too long after (or before) a connection was successfully made or if the custom login feature is disabled, in which case a ''nil'' and an error message will be returned instead.
 +
 
 +
Introduced along with four other functions to enable game server log-in to be scripted with the simultaneous movement of that functionality from the Mudlet application core code to a predefined ''doLogin()'' function, a replacement for which is shown below.
 +
:See also: [[#getCharacterName|getCharacterName()]], [[#sendCharacterName|sendCharacterName()]], [[#sendPassword|sendPassword()]], [[#getCustomLoginTextId|getCustomLoginTextId()]].
 +
 
 +
{{note}} Not available yet. See https://github.com/Mudlet/Mudlet/pull/3952
 +
 
 +
Only one custom login text has been defined initially:
 +
{| class="wikitable"
 +
|+Predefined custom login texts
 
|-
 
|-
−
| style="text-align:center;" |No
+
!Id!!Custom text!!Introduced in Mudlet version
−
|tag
 
−
|<tag>
 
−
|&nbsp;
 
−
| style="text-align:left;" |
 
−
*Helps categorize media.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
|continue
 
−
|true or false
 
−
|true
 
−
| style="text-align:left;" |
 
−
*Continues playing matching new video files when true.
 
−
*Restarts matching new video files when false.
 
−
|- style="color: blue;"
 
−
| style="text-align:center;" |Maybe
 
−
|url
 
−
|<url>
 
−
|&nbsp;
 
−
| style="text-align:left;" |
 
−
*Resource location where the media file may be downloaded.
 
−
*Only required if the file is to be downloaded remotely or for streaming from the Internet.
 
−
|- style="color: blue;"
 
−
| style="text-align:center;" |Maybe
 
−
|stream
 
−
|true or false
 
−
|false
 
−
| style="text-align:left;" |
 
−
*Streams files from the Internet when true.
 
−
*Download files when false (default).
 
−
*Used in combination with the `url` key.
 
 
|-
 
|-
 +
|1||"connect {character name} {password}"||TBD
 
|}
 
|}
  
−
See also: [[Manual:Miscellaneous Functions#loadSoundFile|loadSoundFile()]], [[Manual:Miscellaneous Functions#loadMusicFile|loadMusicFile()]], [[Manual:Miscellaneous Functions#loadVideoFile|loadVideoFile()]], [[Manual:Miscellaneous_Functions#playSoundFile|playSoundFile()]], [[Manual:Miscellaneous Functions#playMusicFile|playMusicFile()]], [[Manual:Miscellaneous Functions#stopSounds|stopSounds()]], [[Manual:Miscellaneous Functions#stopMusic|stopMusic()]], [[Manual:Miscellaneous Functions#stopVideos|stopVideos()]], [[Manual:Miscellaneous Functions#createVideoPlayer|createVideoPlayer()]], [[Manual:Miscellaneous_Functions#purgeMediaCache|purgeMediaCache()]], [[Manual:Scripting#MUD_Client_Media_Protocol|Mud Client Media Protocol]]
+
The addition of further texts would be subject to negotiation with the Mudlet Makers.
−
 
 
−
{{MudletVersion|4.18}}
 
  
 
;Example
 
;Example
−
 
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
---- Table Parameter Syntax ----
+
-- A replacement for the default function placed into LuaGlobal.lua to reproduce the previous behavior of the Mudlet application:
 +
function doLogin()
 +
  if getCustomLoginTextId() ~= 1 then
 +
    -- We need this particular option but it is not permitted for a script to change the setting, it can only check what it is
 +
    echo("\nUnable to login - please select the 'connect {character name} {password}` custom login option in the profile preferences.\n")
 +
  else
 +
    tempTime(2.0, [[sendCustomLoginText()]], 1)
 +
  end
 +
end
 +
</syntaxhighlight>
  
−
-- Stream a video file from the Internet and play it.
+
=Mudlet Object Functions=
−
playVideoFile({
+
:A collection of functions that manipulate Mudlet's scripting objects - triggers, aliases, and so forth.
−
    name = "TextInMotion-VideoSample-1080p.mp4"
 
−
    , url = "https://d2qguwbxlx1sbt.cloudfront.net/"
 
−
    , stream = true
 
−
})
 
  
−
-- Play a video file from the Internet, storing it in the profile's media directory (i.e. /Users/Tamarindo/mudlet-data/profiles/StickMUD/media) so you don't need to download it over and over.  You could add ", stream = false" below, but that is the default and is not needed.
+
==ancestors, new in PR #6726==
 +
;ancestors(IDnumber, type)
 +
:You can use this function to find out about all the ancestors of something.
  
−
playVideoFile({
+
:Returns a list as a table with the details of each successively distance ancestor (if any) of the given item; the details are in the form of a sub-table, within each containing specifically:
−
    name = "TextInMotion-VideoSample-1080p.mp4"
+
:* its IDnumber as a number
−
    , url = "https://d2qguwbxlx1sbt.cloudfront.net/"
+
:* its name as a string
−
})
+
:* whether it is active as a boolean
 +
:* its "node" (type) as a string, one of "item", "group" (folder) or "package" (module)
 +
:Returns ''nil'' and an error message if either parameter is not valid
  
−
-- Play a video file stored in the profile's media directory (i.e. /Users/Tamarindo/mudlet-data/profiles/StickMUD/media)
+
;Parameters
−
playVideoFile({
+
* ''IDnumber:''
−
    name = "TextInMotion-VideoSample-1080p.mp4"
+
: The ID number of a single item, (which will be that returned by a ''temp*'' or ''perm*'' function to create such an item to identify the item).
−
})
+
* ''type:''
 +
: The type can be 'alias', 'button', 'trigger', 'timer', 'keybind', or 'script'.
  
−
-- OR copy once from the game's profile, and play a video file stored in the profile's media directory
+
: See also: [[#isAncestorsActive|isAncestorsActive(...)]], [[#isActive|isActive(...)]]
−
---- [volume] of 75 (1 to 100)
 
−
playVideoFile({
 
−
    name = getMudletHomeDir().. "/TextInMotion-VideoSample-1080p.mp4"
 
−
    , volume = 75
 
−
})
 
  
−
-- OR copy once from the local file system, and play a video file stored in the profile's media directory
+
;Example
−
---- [volume] of 75 (1 to 100)
+
<syntaxhighlight lang="lua">
−
playVideoFile({
+
-- To do
−
    name = "C:/Users/Tamarindo/Movies/TextInMotion-VideoSample-1080p.mp4"
+
</syntaxhighlight>
−
    , volume = 75
+
 
−
})
+
==findItems, new in PR #6742==
 +
;findItems("name", "type"[, exact[, case sensitive]])
 +
: You can use this function to determine the ID number or numbers of items of a particular type with a given name.
 +
 
 +
:Returns a list as a table with ids of each Mudlet item that matched or ''nil'' and an error message should an incorrect type string be given.
  
−
-- OR download once from the Internet, and play a video stored in the profile's media directory
+
;Parameters
−
---- [fadein] and increase the volume from 1 at the start position to default volume up until the position of 10 seconds
+
* ''name:''
−
---- [fadeout] and decrease the volume from default volume to one, 15 seconds from the end of the video
+
:The name (as a string) of the item, (which will be that returned by a ''temp*'' or ''perm*'' function to create such an item to identify the item).
−
---- [start] 5 seconds after position 0 (fadein scales its volume increase over a shorter duration, too)
+
* ''type:''
−
---- [key] reference of "text" for stopping this unique video later
+
:The type (as a string) can be 'alias', 'button', 'trigger', 'timer', 'keybind' , or 'script'.
−
---- [tag] reference of "ambience" to stop any video later with the same tag
+
* ''exact:''
−
---- [continue] playing this video if another request for the same video comes in (false restarts it)  
+
:(Optional) a boolean which if omitted or ''true'' specifies to match the given name against the whole of the names for items or only as a sub-string of them. As a side effect, if this is provided and is ''false'' and an empty string (i.e. ''""'') is given as the first argument then the function will return the ID numbers of ''all'' items (both temporary and permanent) of the given type in existence at the time.
−
---- [url] resource location where the file may be accessed on the Internet
+
* ''case sensitive:''
−
---- [stream] download once from the Internet if the video does not exist in the profile's media directory when false (true streams from the Internet and will not download to the device)
+
:(Optional) a boolean which if omitted or ''true'' specifies to match in a case-sensitive manner the given name against the names for items.
−
playVideoFile({
+
 
−
    name = "TextInMotion-VideoSample-1080p.mp4"
+
;Example
−
    , volume = nil -- nil lines are optional, no need to use
+
Given a profile with just the default packages installed (automatically) - including the '''echo''' one:
−
    , fadein = 10000
+
[[File:View of standard aliases with focus on echo package.png|border|none|400px|link=]]
−
    , fadeout = 15000
 
−
    , start = 5000
 
−
    , loops = nil -- nil lines are optional, no need to use
 
−
    , key = "text"
 
−
    , tag = "ambience"
 
−
    , continue = true
 
−
    , url = "https://d2qguwbxlx1sbt.cloudfront.net/"
 
−
    , stream = false
 
−
})
 
−
</syntaxhighlight>
 
−
<syntaxhighlight lang="lua">
 
−
---- Ordered Parameter Syntax of playVideoFile(name[,volume][,fadein][,fadeout][,loops][,key][,tag][,continue][,url][,stream]) ----
 
  
−
-- Stream a video file from the Internet and play it.
+
<syntaxhighlight lang="lua">
−
playVideoFile(
+
-- Should find just the package with the name:
−
    "TextInMotion-VideoSample-1080p.mp4"
+
lua findItems("echo", "alias")
−
    , nil -- volume
+
{ 3 }
−
    , nil -- fadein
+
 
−
    , nil -- fadeout
+
-- Should find both the package and the alias - as the latter contains "echo" with another character
−
    , nil -- start
+
lua findItems("echo", "alias", false)
−
    , nil -- loops
+
{ 3, 4 }
−
    , nil -- key
 
−
    , nil -- tag
 
−
    , true -- continue
 
−
    , "https://d2qguwbxlx1sbt.cloudfront.net/" -- url
 
−
    , false -- stream
 
−
)
 
  
−
-- Play a video file from the Internet, storing it in the profile's media directory (i.e. /Users/Tamarindo/mudlet-data/profiles/StickMUD/media) so you don't need to download it over and over.
+
-- Finds the ID numbers of all the aliases:
−
playVideoFile(
+
lua findItems("", "alias", false)
−
    "TextInMotion-VideoSample-1080p.mp4"
+
{ 1, 2, 3, 4, 5, 6, 7 }
−
    , nil -- volume
 
−
    , nil -- fadein
 
−
    , nil -- fadeout
 
−
    , nil -- start
 
−
    , nil -- loops
 
−
    , nil -- key
 
−
    , nil -- tag
 
−
    , true -- continue
 
−
    , "https://d2qguwbxlx1sbt.cloudfront.net/" -- url
 
−
    , false -- stream
 
−
)
 
  
−
-- Play a video file stored in the profile's media directory (i.e. /Users/Tamarindo/mudlet-data/profiles/StickMUD/media)
+
-- Will still find the package with the name "echo" as we are not concerned with the casing now:
−
playVideoFile(
+
lua findItems("Echo", "alias", true, false)
−
    "TextInMotion-VideoSample-1080p.mp4" -- name
+
{ 3 }
−
)
 
  
−
-- OR copy once from the game's profile, and play a video file stored in the profile's media directory
+
-- Won't find the package with the name "echo" now as we are concerned with the casing:
−
---- [volume] of 75 (1 to 100)
+
lua findItems("Echo", "alias", true, true)
−
playVideoFile(
+
{}
−
    getMudletHomeDir().. "/TextInMotion-VideoSample-1080p.mp4" -- name
+
</syntaxhighlight>
−
    , 75 -- volume
 
−
)
 
  
−
-- OR copy once from the local file system, and play a video file stored in the profile's media directory
+
==getExitStubsNames, new in PR #7519==
−
---- [volume] of 75 (1 to 100)
+
;table = getExitStubsNames(roomid)
−
playVideoFile(
+
 
−
    "C:/Users/Tamarindo/Documents/TextInMotion-VideoSample-1080p.mp4" -- name
+
:Returns a table of directions that have an exit stub marked in them. Returns nil plus error message of called on a non-existent room.
−
    , 75 -- volume
+
 
−
)
+
: See also: [[#setExitStub|setExitStub()]], [[#connectExitStub|connectExitStub()]], [[#getExitStubs|getExitStubs()]], [[#getExitStubs1|getExitStubs1()]]
 +
 
 +
;Example
 +
<syntaxhighlight lang="lua">
 +
-- show the exit stubs in room 6 as direction names
 +
local directions = getExitStubsNames(6)
 +
for i = 1, #directions do print(directions[i]) end
 +
-- will return a table such as
 +
{ "north", "south", "up", "in" }
 +
</syntaxhighlight>
 +
 
 +
==getProfiles, new in PR #7423==
 +
;getProfiles()
 +
 
 +
:Return a table containing some basic information about the game profiles available to Mudlet.  The key is the profile name and values can be <code>host</code>, <code>port</code>, <code>loaded</code>, and <code>connected</code>.
 +
 
 +
* <code>host</code> is the hostname or IP of the server
 +
* <code>port</code> is the port of the server
 +
* <code>loaded</code> means the profile is open and can be edited, true if loaded, false otherwise
 +
* <code>connected</code> means the profile is connected to the game server (ie. playing), true if connected, false or nil otherwise
  
−
-- OR download once from the Internet, and play a video stored in the profile's media directory
+
;Example
−
---- [fadein] and increase the volume from 1 at the start position to default volume up until the position of 10 seconds
+
<syntaxhighlight lang="lua">
−
---- [fadeout] and decrease the volume from default volume to one, 15 seconds from the end of the video
+
local profiles = getProfiles()
−
---- [start] 5 seconds after position 0 (fadein scales its volume increase over a shorter duration, too)
+
display(profiles)
−
---- [key] reference of "text" for stopping this unique video later
+
 
−
---- [tag] reference of "ambience" to stop any video later with the same tag
+
--output
−
---- [continue] playing this video if another request for the same video comes in (false restarts it)
+
{
−
---- [url] resource location where the file may be accessed on the Internet
+
  ["Abandoned Realms"] = {
−
---- [stream] download once from the Internet if the video does not exist in the profile's media directory when false (true streams from the Internet and will not download to the device)
+
     host = "abandonedrealms.com",
−
playVideoFile(
+
     loaded = false,
−
     "TextInMotion-VideoSample-1080p.mp4" -- name
+
     port = "9000"
−
     , nil -- volume
+
  },
−
     , 10000 -- fadein
+
  FieryMUD = {
−
    , 15000 -- fadeout
+
     connected = true,
−
    , 5000 -- start
+
     host = "fierymud.org",
−
     , nil -- loops
+
     loaded = true,
−
     , "text" -- key
+
     port = "4000"
−
    , "ambience" -- tag
+
  }
−
     , true -- continue
+
}
−
     , "https://d2qguwbxlx1sbt.cloudfront.net/" -- url
 
−
    , false -- stream
 
−
)
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
==isActive, modified by PR #6726==
 +
;isActive(name/IDnumber, type[, checkAncestors])
 +
:You can use this function to check if something, or somethings, are active.
  
−
==stopVideos, PR #6439==
+
:Returns the number of active things - and 0 if none are active. Beware that all numbers are true in Lua, including zero.
−
;stopVideos(settings table)
 
−
:Stop all videos (no filter), or videos that meet a combination of filters (name, key, and tag) intended to be paired with [[Manual:Miscellaneous_Functions#playVideoFile|playVideoFile()]].
 
  
−
{| class="wikitable"
+
;Parameters
−
!Required
+
* ''name:''
−
!Key
+
:The name (as a string) or, from '''Mudlet 4.17.0''', the ID number of a single item, (which will be that returned by a ''temp*'' or ''perm*'' function to create such an item to identify the item).
−
!Value
+
* ''type:''
−
! style="text-align:left;" |Purpose
+
:The type can be 'alias', 'button' (from '''Mudlet 4.10'''), 'trigger', 'timer', 'keybind' (from '''Mudlet 3.2'''), or 'script' (from '''Mudlet 3.17''').
−
|-
+
* ''checkAncestors:''
−
| style="text-align:center;" |No
+
:(Optional) If provided AND ''true'' (considered ''false'' if absent to reproduce behavior of previous versions of Mudlet) then this function will only count an item as active if it '''and''' all its parents (ancestors) are active (from '''Mudlet tbd''').
−
| 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".
 
−
*Halts the play of current media files with the same "key" that have a different "name" or "url" while this media plays.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
|tag
 
−
|<tag>
 
−
| style="text-align:left;" |
 
−
*Helps categorize media.
 
−
|-
 
−
|}
 
  
−
See also: [[Manual:Miscellaneous_Functions#loadSoundFile|loadSoundFile()]], [[Manual:Miscellaneous_Functions#loadMusicFile|loadMusicFile()]], [[Manual:Miscellaneous_Functions#loadVideoFile|loadVideoFile()]], [[Manual:Miscellaneous_Functions#playSoundFile|playSoundFile()]], [[Manual:Miscellaneous_Functions#playMusicFile|playMusicFile()]], [[Manual:Miscellaneous_Functions#playVideoFile|playVideoFile()]], [[Manual:Miscellaneous_Functions#stopSounds|stopSounds()]], [[Manual:Miscellaneous Functions#stopMusic|stopMusic()]], [[Manual:Miscellaneous Functions#createVideoPlayer|createVideoPlayer()]], [[Manual:Miscellaneous_Functions#purgeMediaCache|purgeMediaCache()]], [[Manual:Scripting#MUD_Client_Media_Protocol|Mud Client Media Protocol]]
+
:See also: [[#exists|exists(...)]], [[#isAncestorsActive|isAncestorsActive(...)]], [[#ancestors|ancestors(...)]]
−
 
 
−
{{MudletVersion|4.18}}
 
  
 
;Example
 
;Example
 +
<syntaxhighlight lang="lua">
 +
echo("I have " .. isActive("my trigger", "trigger") .. " currently active trigger(s) called 'my trigger'!")
  
−
<syntaxhighlight lang="lua">
+
-- Can also be used to check if a specific item is enabled or not.
−
---- Table Parameter Syntax ----
+
if isActive("spellname", "trigger") > 0 then
 +
  -- the spellname trigger is active
 +
else
 +
  -- it is not active
 +
end
 +
</syntaxhighlight>
  
−
-- Stop all playing video files for this profile associated with the API
+
{{note}} A positive ID number that does not exist will still return a ''0'' value, this is for constancy with the way the function behaves for a name that does not refer to any item either. If necessary the existence of an item should be confirmed with [[#exists|exists(...)]] first.
−
stopVideos()
 
  
−
-- Stop playing the text mp4 by name
+
==isAncestorsActive, new in PR #6726==
−
stopVideos({name = "TextInMotion-VideoSample-1080p.mp4"})
+
;isAncestorsActive(IDnumber, "type")
 +
:You can use this function to check if '''all''' the ancestors of something are active independent of whether it itself is, (for that use the two argument form of [[#isActive|isActive(...)]]).
  
−
-- Stop playing the unique sound identified as "text"
+
:Returns ''true'' if all (if any) of the ancestors of the item with the specified ID number and type are active, if there are no such parents then it will also returns ''true''; otherwise returns ''false''. In the event that an invalid type string or item number is provided returns ''nil'' and an error message.
−
stopVideos({
 
−
    name = nil  -- nil lines are optional, no need to use
 
−
    , key = "text" -- key
 
−
    , tag = nil -- nil lines are optional, no need to use
 
−
})
 
−
</syntaxhighlight>
 
−
<syntaxhighlight lang="lua">
 
−
---- Ordered Parameter Syntax of stopVideos([name][,key][,tag]) ----
 
  
−
-- Stop all playing video files for this profile associated with the API
+
;Parameters
−
stopVideos()
+
* ''IDnumber:''
 +
:The ID number of a single item, (which will be that returned by a ''temp*'' or ''perm*'' function to create such an item to identify the item).
 +
* ''type:''
 +
:The type can be 'alias', 'button', 'trigger', 'timer', 'keybind' or 'script' to define which item type is to be checked.
  
−
-- Stop playing the text mp4 by name
+
:See also: [[#exists|exists(...)]]
−
stopVideos("TextInMotion-VideoSample-1080p.mp4")
 
  
−
-- Stop playing the unique sound identified as "text"
+
;Example
−
stopVideos(
+
<syntaxhighlight lang="lua">
−
    nil -- name
+
-- To do
−
    , "text" -- key
 
−
    , nil -- tag
 
−
)
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
==loadProfile, new in PR #7423==
 +
;loadProfile(name, offline)
 +
:Load a profile, same as clicking the profile icon in the Profile Manager.
  
−
==getCustomLoginTextId, PR #3952 open==
+
:Returns ''nil'' and an error message if either parameter is not valid.
−
;getCustomLoginTextId()
 
  
−
Returns the Id number of the custom login text setting from the profile's preferences. Returns ''0'' if the option is disabled or a number greater than that for the item in the table; note it is possible if using an old saved profile in the future that the number might be higher than expected. As a design policy decision it is not permitted for a script to change the setting, this function is intended to allow a script or package to check that the setting is what it expects.
+
;Parameters
 +
* ''name:''
 +
: The profile name to open, as identified in the Profile Manager.
 +
* ''offline:''
 +
: true - load the profile but do not connect to the game, false - load the profile and connect to the game
  
−
Introduced along with four other functions to enable game server log-in to be scripted with the simultaneous movement of that functionality from the Mudlet application core code to a predefined ''doLogin()'' function, a replacement for which is shown below.
+
;Example
−
:See also: [[#getCharacterName|getCharacterName()]], [[#sendCharacterName|sendCharacterName()]], [[#sendCustomLoginText|sendCustomLoginText()]], [[#sendPassword|sendPassword()]].
+
<syntaxhighlight lang="lua">
 +
-- load and connect to the Archaea profile
 +
loadProfile("Archaea", false)
 +
</syntaxhighlight>
  
−
{{note}} Not available yet. See https://github.com/Mudlet/Mudlet/pull/3952
+
== clearProfileInformation(), new in PR #7511==
 +
;clearProfileInformation(text)
 +
:Clears the information text as displayed in the Profile Connection Window. If this is a prepackaged game the text is reverted to the default text.
  
−
Only one custom login text has been defined initially:
+
:See also: [[#getProfileInformation|getProfileInformation()]], [[#setProfileInformation|setProfileInformation()]]
−
{| class="wikitable"
 
−
|+Predefined custom login texts
 
−
|-
 
−
!Id!!Custom text!!Introduced in Mudlet version
 
−
|-
 
−
|1||"connect {character name} {password}"||TBD
 
−
|}
 
−
 
 
−
The addition of further texts would be subject to negotiation with the Mudlet Makers.
 
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- A replacement for the default function placed into LuaGlobal.lua to reproduce the previous behavior of the Mudlet application:
+
clearProfileInformation()
−
function doLogin()
 
−
  if getCustomLoginTextId() ~= 1 then
 
−
    -- We need this particular option but it is not permitted for a script to change the setting, it can only check what it is
 
−
    echo("\nUnable to login - please select the 'connect {character name} {password}` custom login option in the profile preferences.\n")
 
−
  else
 
−
    tempTime(2.0, [[sendCustomLoginText()]], 1)
 
−
  end
 
−
end
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==sendCharacterName, PR #3952 open==
+
== getProfileInformation(), new in PR #7511==
−
;sendCharacterName()
+
;getProfileInformation()
 +
:Return a string containing the information text as displayed in the Profile Connection Window.
  
−
Sends the name entered into the "Character name" field on the Connection Preferences form directly to the game server. Returns ''true'' unless there is nothing set in that entry in which case a ''nil'' and an error message will be returned instead.
+
:See also: [[#clearProfileInformation|clearProfileInformation()]], [[#setProfileInformation|setProfileInformation()]]
  
−
Introduced along with four other functions to enable game server log-in to be scripted with the simultaneous movement of that functionality from the Mudlet application core code to a predefined ''doLogin()'' function that may be replaced for more sophisticated requirements.
+
;Example
−
:See also: [[#getCharacterName|getCharacterName()]], [[#sendCharacterPassword|sendCharacterPassword()]], [[#sendCustomLoginText|sendCustomLoginText()]], [[#getCustomLoginTextId|getCustomLoginTextId()]].
+
<syntaxhighlight lang="lua">
 +
echo(getProfileInformation())
 +
</syntaxhighlight>
  
−
{{note}} Not available yet. See https://github.com/Mudlet/Mudlet/pull/3952
+
== setProfileInformation(), new in PR #7511==
 +
;setProfileInformation(text)
 +
:Set the information text as displayed in the Profile Connection Window. Returns nil and an error messages if no string is supplied.
  
−
==sendCharacterPassword, PR #3952 open==
+
:See also: [[#clearProfileInformation|clearProfileInformation()]], [[#getProfileInformation|getProfileInformation()]]
−
;sendCharacterPassword()
 
−
 
 
−
Sends the password entered into the "Password" field on the Connection Preferences form directly to the game server. Returns ''true'' unless there is nothing set in that entry or it is too long after (or before) a connection was successfully made in which case a ''nil'' and an error message will be returned instead.
 
−
 
 
−
Introduced along with four other functions to enable game server log-in to be scripted with the simultaneous movement of that functionality from the Mudlet application core code to a predefined ''doLogin()'' function, reproduced below, that may be replaced for more sophisticated requirements.
 
−
:See also: [[#getCharacterName|getCharacterName()]], [[#sendCustomLoginText|sendCustomLoginText()]], [[#getCustomLoginTextId|getCustomLoginTextId()]], [[#sendCharacterName|sendCharacterName()]].
 
−
 
 
−
{{note}} Not available yet. See https://github.com/Mudlet/Mudlet/pull/3952
 
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- The default function placed into LuaGlobal.lua to reproduce the previous behavior of the Mudlet application:
+
setProfileInformation("Elf warrior, lvl 15")
−
function doLogin()
 
−
  if getCharacterName() ~= "" then
 
−
    tempTime(2.0, [[sendCharacterName()]], 1)
 
−
    tempTime(3.0, [[sendCharacterPassword()]], 1)
 
−
  end
 
−
end
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==sendCustomLoginText, PR #3952 open ==
+
=Networking Functions=
−
;sendCustomLoginText()
+
:A collection of functions for managing networking.
 +
==sendSocket revised in PR #7066 (Open)==
 +
 
 +
;sendSocket(data)
 +
 
 +
:Sends given binary data as-is (or with some predefined special tokens converted to byte values) to the game. You can use this to implement support for a [[Manual:Supported_Protocols#Adding_support_for_a_telnet_protocol|new telnet protocol]], [http://forums.mudlet.org/viewtopic.php?f=5&t=2272 simultronics] [http://forums.mudlet.org/viewtopic.php?f=5&t=2213#p9810 login] etc.
 +
 
 +
; success = sendSocket("data")
  
−
Sends the custom login text (which does NOT depend on the user's choice of GUI language) selected in the preferences for this profile. The {password} (and {character name} if present) fields will be replaced with the values entered into the "Password" and "Character name" fields on the Connection Preferences form and then sent directly to the game server. Returns ''true'' unless there is nothing set in either of those entries (though only if required for the character name) or it is too long after (or before) a connection was successfully made or if the custom login feature is disabled, in which case a ''nil'' and an error message will be returned instead.
+
;See also: [[Manual:Lua_Functions#feedTelnet|feedTelnet()]], [[Manual:Lua_Functions#feedTriggers|feedTriggers()]]
  
−
Introduced along with four other functions to enable game server log-in to be scripted with the simultaneous movement of that functionality from the Mudlet application core code to a predefined ''doLogin()'' function, a replacement for which is shown below.
+
{{note}} Modified in Mudlet '''tbd''' to accept some tokens like "''<NUL>''" to include byte values that are not possible to insert with the standard Lua string escape "''\###''" form where ### is a three digit number between 000 and 255 inclusive or where the value is more easily provided via a mnemonic. For the table of the tokens that are known about, see the one in [[Manual:Lua_Functions#feedTelnet|feedTelnet()]].
−
:See also: [[#getCharacterName|getCharacterName()]], [[#sendCharacterName|sendCharacterName()]], [[#sendPassword|sendPassword()]], [[#getCustomLoginTextId|getCustomLoginTextId()]].
 
  
−
{{note}} Not available yet. See https://github.com/Mudlet/Mudlet/pull/3952
+
{{note}} The data (as bytes) once the tokens have been converted to their byte values is sent as is to the Game Server; any encoding to, say, a UTF-8 representation or to duplicate ''0xff'' byte values so they are not considered to be Telnet ''<IAC>'' (Interpret As Command) bytes must be done to the data prior to calling this function.
  
−
Only one custom login text has been defined initially:
+
;Parameters
−
{| class="wikitable"
+
* ''data:''
−
|+Predefined custom login texts
+
: String containing the bytes to send to the Game Server possibly containing some tokens that are to be converted to bytes as well.
−
|-
 
−
!Id!!Custom text!!Introduced in Mudlet version
 
−
|-
 
−
|1||"connect {character name} {password}"||TBD
 
−
|}
 
  
−
The addition of further texts would be subject to negotiation with the Mudlet Makers.
+
;Returns
 +
* (Only since Mudlet '''tbd''') Boolean ''true'' if the whole data string (after token replacement) was sent to the Server, ''false'' if that failed for any reason (including if the Server has not been connected or is now disconnected). ''nil'' and an error message for any other defect.
  
 
;Example
 
;Example
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- A replacement for the default function placed into LuaGlobal.lua to reproduce the previous behavior of the Mudlet application:
+
-- Tell the Server that we are now willing and able to process  to process Ask the Server to a comment explaining what is going on, if there is multiple functionalities (or optional parameters) the examples should start simple and progress in complexity if needed!
−
function doLogin()
+
-- the examples should be small, but self-contained so new users can copy & paste immediately without going diving in lots other function examples first.
−
   if getCustomLoginTextId() ~= 1 then
+
-- comments up top should introduce / explain what it does
−
    -- We need this particular option but it is not permitted for a script to change the setting, it can only check what it is
+
 
−
    echo("\nUnable to login - please select the 'connect {character name} {password}` custom login option in the profile preferences.\n")
+
local something = function(exampleValue)
−
   else
+
if something then
−
    tempTime(2.0, [[sendCustomLoginText()]], 1)
+
   -- do something with something (assuming there is a meaningful return value)
−
  end
+
end
 +
 
 +
-- maybe another example for the optional second case
 +
local somethingElse = function(exampleValue, anotherValue)
 +
 
 +
-- lastly, include an example with error handling to give an idea of good practice
 +
local ok, err = function()
 +
if not ok then
 +
  debugc(f"Error: unable to do <particular thing> because {err}\n")
 +
   return
 
end
 
end
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
=Mudlet Object Functions=
+
; Additional development notes
−
:A collection of functions that manipulate Mudlet's scripting objects - triggers, aliases, and so forth.
+
-- This function is still being written up.
 +
 
 +
==feedTelnet added in PR #7066 (Open)====
 +
 
 +
; feedTelnet(data)
  
−
==ancestors, new in PR #6726==
+
:Sends given binary data with some predefined special tokens converted to byte values, to the internal telnet engine, as if it had been received from the game. This is primarily to enable testing when new Telnet sub-options/protocols are being developed. The data has to be injected into the system nearer to the point where the Game Server's data starts out than ''feedTriggers()'' and unlike the latter the data is not subject to any encoding so as to match the current profile's setting (which normally happens with ''feedTriggers()''). Furthermore - to prevent this function from putting the telnet engine into a state which could damage the processing of real game data it will refuse to work unless the Profile is completely disconnected from the game server.
−
;ancestors(IDnumber, type)
 
−
:You can use this function to find out about all the ancestors of something.
 
  
−
:Returns a list as a table with the details of each successively distance ancestor (if any) of the given item; the details are in the form of a sub-table, within each containing specifically:
+
;See also: [[Manual:Lua_Functions#feedTriggers|feedTriggers()]], [[Manual:Lua_Functions#sendSocket|sendSocket()]]
−
:* its IDnumber as a number
 
−
:* its name as a string
 
−
:* whether it is active as a boolean
 
−
:* its "node" (type) as a string, one of "item", "group" (folder) or "package" (module)
 
−
:Returns ''nil'' and an error message if either parameter is not valid
 
  
−
;Parameters
+
{{MudletVersion|tbd}}
−
* ''IDnumber:''
 
−
: The ID number of a single item, (which will be that returned by a ''temp*'' or ''perm*'' function to create such an item to identify the item).
 
−
* ''type:''
 
−
: The type can be 'alias', 'button', 'trigger', 'timer', 'keybind', or 'script'.
 
  
−
: See also: [[#isAncestorsActive|isAncestorsActive(...)]], [[#isActive|isActive(...)]]
+
{{note}} This is not really intended for end-user's but might be useful in some circumstances.
  
−
;Example
+
;Parameters
−
<syntaxhighlight lang="lua">
+
* ''data''
−
-- To do
+
: String containing the bytes to send to the internal telnet engine as if it had come from the Game Server, it can containing some tokens listed below that are to be converted to bytes as well.
−
</syntaxhighlight>
 
  
−
==findItems, new in PR #6742==
+
;Returns
−
;findItems("name", "type"[, exact[, case sensitive]])
+
* Boolean ''true'' if the ''data'' string was sent to the internal telnet engine. ''nil'' and an error message otherwise, specifically the case when there is some traces of a connection or a complete connection to the socket that passes the data to and from the game server. Additionally, if the data is an empty string ''""'' a second return value will be provided as an integer number representing a version for the table of tokens - which will be incremented each time a change is made to that table so that which tokens are valid can be determined. Note that unrecognised tokens should be passed through as is and not get replaced.
−
: You can use this function to determine the ID number or numbers of items of a particular type with a given name.
 
  
−
:Returns a list as a table with ids of each Mudlet item that matched or ''nil'' and an error message should an incorrect type string be given.
+
{| class="wikitable sortable"
−
 
+
|+ Token value table
−
;Parameters
+
|-
−
* ''name:''
+
! Token !! Byte !! Version!! Notes
−
:The name (as a string) of the item, (which will be that returned by a ''temp*'' or ''perm*'' function to create such an item to identify the item).
+
|-
−
* ''type:''
+
|| <00> || \0x00 || 1 || 0 dec.
−
:The type (as a string) can be 'alias', 'button', 'trigger', 'timer', 'keybind' , or 'script'.
+
|-
−
* ''exact:''
+
|| <O_BINARY> || \0x00 || 1 || Telnet option: Binary
−
:(Optional) a boolean which if omitted or ''true'' specifies to match the given name against the whole of the names for items or only as a sub-string of them. As a side effect, if this is provided and is ''false'' and an empty string (i.e. ''""'') is given as the first argument then the function will return the ID numbers of ''all'' items (both temporary and permanent) of the given type in existence at the time.
+
|-
−
* ''case sensitive:''
+
|| <NUL> || \0x00 || 1 || ASCII control character: NULL
−
:(Optional) a boolean which if omitted or ''true'' specifies to match in a case-sensitive manner the given name against the names for items.
+
|-
−
 
+
|| <01> || \x01 || 1 || 1 dec.
−
;Example
+
|-
−
Given a profile with just the default packages installed (automatically) - including the '''echo''' one:
+
|| <O_ECHO> || \x01 || 1 || Telnet option: Echo
−
[[File:View of standard aliases with focus on echo package.png|border|none|400px|link=]]
+
|-
−
 
+
|| <SOH> || \x01 || 1 || ASCII control character: Start of Heading
−
<syntaxhighlight lang="lua">
+
|-
−
-- Should find just the package with the name:
+
|| <02> || \x02 || 1 || 2 dec. Telnet option: Reconnect
−
lua findItems("echo", "alias")
+
|-
−
{ 3 }
+
|| <STX> || \x02 || 1 || ASCII control character: Start of Text
−
 
+
|-
−
-- Should find both the package and the alias - as the latter contains "echo" with another character
+
|| <03> || \x03 || 1 || 3 dec.
−
lua findItems("echo", "alias", false)
+
|-
−
{ 3, 4 }
+
|| <O_SGA> || \x03 || 1 || Telnet option: Suppress Go Ahead
−
 
+
|-
−
-- Finds the ID numbers of all the aliases:
+
|| <ETX> || \x03 || 1 || ASCII control character: End of Text
−
lua findItems("", "alias", false)
+
|-
−
{ 1, 2, 3, 4, 5, 6, 7 }
+
|| <04> || \x04 || 1 || Telnet option: Approx Message Size Negotiation
−
 
+
|-
−
-- Will still find the package with the name "echo" as we are not concerned with the casing now:
+
|| <EOT> || \x04 || 1 || ASCII control character: End of Transmission
−
lua findItems("Echo", "alias", true, false)
+
|-
−
{ 3 }
+
|| <05> || \x05 || 1 ||
−
 
+
|-
−
-- Won't find the package with the name "echo" now as we are concerned with the casing:
+
|| <O_STATUS> || \x05 || 1 ||
−
lua findItems("Echo", "alias", true, true)
+
|-
−
{}
+
|| <ENQ> || \x05 || 1 || ASCII control character: Enquiry
−
</syntaxhighlight>
+
|-
−
 
+
|| <06> || \x06 || 1 || Telnet option: Timing Mark
−
==isActive, modified by PR #6726==
+
|-
−
;isActive(name/IDnumber, type[, checkAncestors])
+
|| <ACK> || \x06 || 1 || ASCII control character: Acknowledge
−
:You can use this function to check if something, or somethings, are active.
+
|-
−
 
+
|| <07> || \x07 || 1 || Telnet option: Remote Controlled Trans and Echo
−
:Returns the number of active things - and 0 if none are active. Beware that all numbers are true in Lua, including zero.
+
|-
−
 
+
|| <BELL> || \x07 || 1 || ASCII control character: Bell
−
;Parameters
+
|-
−
* ''name:''
+
|| <08> || \x08 || 1 || Telnet option: Output Line Width
−
:The name (as a string) or, from '''Mudlet 4.17.0''', the ID number of a single item, (which will be that returned by a ''temp*'' or ''perm*'' function to create such an item to identify the item).
+
|-
−
* ''type:''
+
|| <BS> || \x08 || 1 ||
−
:The type can be 'alias', 'button' (from '''Mudlet 4.10'''), 'trigger', 'timer', 'keybind' (from '''Mudlet 3.2'''), or 'script' (from '''Mudlet 3.17''').
+
|-
−
* ''checkAncestors:''
+
|| <09> || \x09 || 1 || Telnet option: Output Page Size
−
:(Optional) If provided AND ''true'' (considered ''false'' if absent to reproduce behavior of previous versions of Mudlet) then this function will only count an item as active if it '''and''' all its parents (ancestors) are active (from '''Mudlet tbd''').
+
|-
−
 
+
|| <HTAB> || \x09 || 1 || ASCII control character: Horizontal Tab
−
:See also: [[#exists|exists(...)]], [[#isAncestorsActive|isAncestorsActive(...)]], [[#ancestors|ancestors(...)]]
+
|-
−
 
+
|| <0A> || \x0a || 1 || Telnet option: Output Carriage-Return Disposition
−
;Example
+
|-
−
<syntaxhighlight lang="lua">
+
|| <LF> || \x0a || 1 || ASCII control character: Line-Feed
−
echo("I have " .. isActive("my trigger", "trigger") .. " currently active trigger(s) called 'my trigger'!")
+
|-
−
 
+
|| <0B> || \x0b || 1 || Telnet option: Output Horizontal Tab Stops
−
-- Can also be used to check if a specific item is enabled or not.
+
|-
−
if isActive("spellname", "trigger") > 0 then
+
|| <VTAB> || \x0b || 1 || ASCII control character: Vertical Tab
−
  -- the spellname trigger is active
+
|-
−
else
+
|| <0C> || \x0c || 1 || Telnet option: Output Horizontal Tab Disposition
−
  -- it is not active
+
|-
−
end
+
|| <FF> || \x0c || 1 || ASCII control character: Form-Feed
−
</syntaxhighlight>
+
|-
−
 
+
|| <0D> || \x0d || 1 || Telnet option: Output Form-feed Disposition
−
{{note}} A positive ID number that does not exist will still return a ''0'' value, this is for constancy with the way the function behaves for a name that does not refer to any item either. If necessary the existence of an item should be confirmed with [[#exists|exists(...)]] first.
+
|-
−
 
+
|| <CR> || \x0d || 1 || ASCII control character: Carriage-Return
−
==isAncestorsActive, new in PR #6726==
+
|-
−
;isAncestorsActive(IDnumber, "type")
+
|| <0E> || \x0e || 1 || Telnet option: Output Vertical Tab Stops
−
:You can use this function to check if '''all''' the ancestors of something are active independent of whether it itself is, (for that use the two argument form of [[#isActive|isActive(...)]]).
+
|-
−
 
+
|| <SO> || \x0e || 1 || ASCII control character: Shift-Out
−
:Returns ''true'' if all (if any) of the ancestors of the item with the specified ID number and type are active, if there are no such parents then it will also returns ''true''; otherwise returns ''false''. In the event that an invalid type string or item number is provided returns ''nil'' and an error message.
+
|-
−
 
+
|| <0F> || \x0f || 1 || Telnet option: Output Vertical Tab Disposition
−
;Parameters
+
|-
−
* ''IDnumber:''
+
|| <SI> || \x0f || 1 || ASCII control character: Shift-In
−
:The ID number of a single item, (which will be that returned by a ''temp*'' or ''perm*'' function to create such an item to identify the item).
+
|-
−
* ''type:''
+
|| <10> || \x10 || 1 || Telnet option: Output Linefeed Disposition
−
:The type can be 'alias', 'button', 'trigger', 'timer', 'keybind' or 'script' to define which item type is to be checked.
+
|-
−
 
+
|| <DLE> || \x10 || 1 || ASCII control character: Data Link Escape
−
:See also: [[#exists|exists(...)]]
+
|-
−
 
+
|| <11> || \x11 || 1 || Telnet option: Extended ASCII
−
;Example
+
|-
−
<syntaxhighlight lang="lua">
+
|| <DC1> || \x11 || 1 || ASCII control character: Device Control 1
−
-- To do
+
|-
−
</syntaxhighlight>
+
|| <12> || \x12 || 1 || Telnet option: Logout
−
 
+
|-
−
=Networking Functions=
+
|| <DC2" || \x12 || 1 || ASCII control character: Device Control 2
−
:A collection of functions for managing networking.
+
|-
−
 
+
|| <13> || \x13 || 1 || Telnet option: Byte Macro
−
=String Functions=
+
|-
−
:These functions are used to manipulate strings.
+
|| <DC3> || \x13 || 1 || ASCII control character: Device Control 3
−
 
+
|-
−
=Table Functions=
+
|| <14> || \x14 || 1 || Telnet option: Data Entry Terminal
−
: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.
+
|-
−
 
+
|| <DC4> || \x14 || 1 || ASCII control character: Device Control 4
−
=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.
+
|| <15> || \x15 || 1 || Telnet option: SUPDUP
−
 
+
|-
−
=UI Functions=
+
|| <NAK> || \x15 || 1 || ASCII control character: Negative Acknowledge
−
: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.
+
|-
 +
|| <16> || \x16 || 1 || Telnet option: SUPDUP Output
 +
|-
 +
|| <SYN> || \x16 || 1 || ASCII control character: Synchronous Idle
 +
|-
 +
|| <17> || \x17 || 1 || Telnet option: Send location
 +
|-
 +
|| <ETB> || \x17 || 1 || ASCII control character: End of Transmission Block
 +
|-
 +
|| <18> || \x18 || 1 ||
 +
|-
 +
|| <O_TERM> || \x18 || 1 || Telnet option: Terminal Type
 +
|-
 +
|| <CAN> || \x18 || 1 || ASCII control character: Cancel
 +
|-
 +
|| <19> || \x19 || 1 ||
 +
|-
 +
|| <O_EOR> || \x19 || 1 || Telnet option: End-of-Record
 +
|-
 +
|| <nowiki><EM></nowiki> || \x19 || 1 || ASCII control character: End of Medium
 +
|-
 +
|| <1A> || \x1a || 1 || Telnet option:  TACACS User Identification
 +
|-
 +
|| <nowiki><SUB></nowiki> || \x1a || 1 || ASCII control character: Substitute
 +
|-
 +
|| <1B> || \x1b || 1 || Telnet option: Output Marking
 +
|-
 +
|| <ESC> || \x1b || 1 || ASCII control character: Escape
 +
|-
 +
|| <1C> || \x1c || 1 || Telnet option: Terminal Location Number
 +
|-
 +
|| <FS> || \x1c || 1 || ASCII control character: File Separator
 +
|-
 +
|| <1D> || \x1d || 1 || Telnet option: Telnet 3270 Regime
 +
|-
 +
|| <GS> || \x1d || 1 || ASCII control character: Group Separator
 +
|-
 +
|| <1E> || \x1e || 1 || Telnet option: X.3 PAD
 +
|-
 +
|| <RS> || \x1e || 1 || ASCII control character: Record Separator
 +
|-
 +
|| <1F> || \x1f || 1 ||
 +
|-
 +
|| <O_NAWS> || \x1f || 1 || Telnet option: Negotiate About Window Size
 +
|-
 +
|| <US> || \x1f || 1 || ASCII control character: Unit Separator
 +
|-
 +
|| <SP> || \x20 || 1 || 32 dec. ASCII character: Space
 +
|-
 +
|| <O_NENV> || \x27 || 1 || 39 dec. Telnet option: New Environment (also MNES)
 +
|-
 +
|| <O_CHARS> || \x2a || 1 || 42 dec. Telnet option: Character Set
 +
|-
 +
|| <O_KERMIT> || \x2f || 1 || 47 dec. Telnet option: Kermit
 +
|-
 +
|| <O_MSDP> || \x45 || 1 || 69 dec. Telnet option: Mud Server Data Protocol
 +
|-
 +
|| <O_MSSP> || \x46 || 1 || 70 dec. Telnet option: Mud Server Status Protocol
 +
|-
 +
|| <O_MCCP> || \x55 || 1 || 85 dec
 +
|-
 +
|| <O_MCCP2> || \x56 || 1 || 86 dec
 +
|-
 +
|| <O_MSP> || \x5a || 1 || 90 dec. Telnet option: Mud Sound Protocol
 +
|-
 +
|| <O_MXP> || \x5b || 1 || 91 dec. Telnet option: Mud eXtension Protocol
 +
|-
 +
|| <O_ZENITH> || \x5d || 1 || 93 dec. Telnet option: Zenith Mud Protocol
 +
|-
 +
|| <O_AARDWULF> || \x66 || 1 || 102 dec. Telnet option: Aardwuld Data Protocol
 +
|-
 +
|| <nowiki><DEL></nowiki> || \x7f || 1 || 127 dec. ASCII control character: Delete
 +
|-
 +
|| <O_ATCP> || \xc8 || 1 || 200 dec
 +
|-
 +
|| <O_GMCP> || \xc9 || 1 || 201 dec
 +
|-
 +
|| <T_EOR> || \xef || 1 || 239 dec
 +
|-
 +
|| <F0> || \xf0 || 1 ||
 +
|-
 +
|| <T_SE> || \xf0 || 1 ||
 +
|-
 +
|| <F1> || \xf1 || 1 ||
 +
|-
 +
|| <T_NOP> || \xf1 || 1 ||
 +
|-
 +
|| <F2> || \xf2 || 1 ||
 +
|-
 +
|| <T_DM> || \xf2 || 1 ||
 +
|-
 +
|| <F3> || \xf3 || 1 ||
 +
|-
 +
|| <T_BRK> || \xf3 || 1 ||
 +
|-
 +
|| <F4> || \xf4 || 1 ||
 +
|-
 +
|| <T_IP> || \xf4 || 1 ||
 +
|-
 +
|| <F5> || \xf5 || 1 ||
 +
|-
 +
|| <T_ABOP> || \xf5 || 1 ||
 +
|-
 +
|| <F6> || \xf6 || 1 ||
 +
|-
 +
|| <T_AYT> || \xf6 || 1 ||
 +
|-
 +
|| <F7> || \xf7 || 1 ||
 +
|-
 +
|| <T_EC> || \xf7 || 1 ||
 +
|-
 +
|| <F8> || \xf8 || 1 ||
 +
|-
 +
|| <T_EL> || \xf8 || 1 ||
 +
|-
 +
|| <F9> || \xf9 || 1 ||
 +
|-
 +
|| <T_GA> || \xf9 || 1 ||
 +
|-
 +
|| <FA> || \xfa || 1 ||
 +
|-
 +
|| <T_SB> || \xfa || 1 ||
 +
|-
 +
|| <FB> || \xfb || 1 ||
 +
|-
 +
|| <T_WILL> || \xfb || 1 ||
 +
|-
 +
|| <FC> || \xfc || 1 ||
 +
|-
 +
|| <T_WONT> || \xfc || 1 ||
 +
|-
 +
|| <FD> || \xfd || 1 ||
 +
|-
 +
|| <T_DO> || \xfd || 1 ||
 +
|-
 +
|| <FE> || \xfe || 1 ||
 +
|-
 +
|| <T_DONT> || \xfe || 1 ||
 +
|-
 +
|| <FF> || \xff || 1 ||
 +
|-
 +
|| <T_IAC> || \xff'
 +
|}
  
−
==cecho2decho PR#6849 merged==
+
;Example
−
; convertedString = cecho2decho(str)
+
<syntaxhighlight lang="lua">
 +
-- a comment explaining what is going on, if there is multiple functionalities (or optional parameters) the examples should start simple and progress in complexity if needed!
 +
-- the examples should be small, but self-contained so new users can copy & paste immediately without going diving in lots other function examples first.
 +
-- comments up top should introduce / explain what it does
  
−
:Converts a cecho formatted string to a decho formatted one.
+
local something = feedTelnet(exampleValue)
−
;See also: [[Manual:Lua_Functions#decho2cecho|decho2cecho()]], [[Manual:Lua_Functions#cecho2html|cecho2html()]]
+
if something then
 +
  -- do something with something (assuming there is a meaningful return value)
 +
end
  
−
{{MudletVersion|4.18}}
+
-- maybe another example for the optional second case
 +
local somethingElse = function(exampleValue, anotherValue)
  
−
;Parameters
+
-- lastly, include an example with error handling to give an idea of good practice
−
* ''str''
+
local ok, err = function()
 +
if not ok then
 +
  debugc(f"Error: unable to do <particular thing> because {err}\n")
 +
  return
 +
end
 +
</syntaxhighlight>
 +
 
 +
; Additional development notes
 +
-- This function is still being written up.
 +
 
 +
=String Functions=
 +
:These functions are used to manipulate strings.
 +
 
 +
=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.
 +
 
 +
=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.
 +
 
 +
=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.
 +
 
 +
==cecho2decho PR#6849 merged==
 +
; convertedString = cecho2decho(str)
 +
 
 +
:Converts a cecho formatted string to a decho formatted one.
 +
;See also: [[Manual:Lua_Functions#decho2cecho|decho2cecho()]], [[Manual:Lua_Functions#cecho2html|cecho2html()]]
 +
 
 +
{{MudletVersion|4.18}}
 +
 
 +
;Parameters
 +
* ''str''
 
: string you wish to convert from cecho to decho
 
: string you wish to convert from cecho to decho
 
;Returns  
 
;Returns  
Line 1,618: Line 1,499:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==deleteMultiline PR-6779 merged==
+
==deleteMultiline PR #6779 merged==
  
 
; ok,err = deleteMultiline([triggerDelta])
 
; ok,err = deleteMultiline([triggerDelta])
Line 1,650: Line 1,531:
 
; Additional development notes
 
; Additional development notes
  
−
==echoPopup, revised in PR #6945==
+
==echoPopup, revised in PR #6946==
 
;echoPopup([windowName,] text, {commands}, {hints}[, useCurrentFormatElseDefault])
 
;echoPopup([windowName,] text, {commands}, {hints}[, useCurrentFormatElseDefault])
 
: Creates text with a left-clickable link, and a right-click menu for more options at the end of the current line, like echo. The added text, upon being left-clicked, will do the first command in the list. Upon being right-clicked, it'll display a menu with all possible commands. The menu will be populated with hints, one for each line; if there is one extra hint then the first one will be used as a (maybe containing Qt rich-text markup) tool-tip for the text otherwise the remaining hints will be concatenated, one-per-line, as a tool-tip when the text is hovered over by the pointer.
 
: Creates text with a left-clickable link, and a right-click menu for more options at the end of the current line, like echo. The added text, upon being left-clicked, will do the first command in the list. Upon being right-clicked, it'll display a menu with all possible commands. The menu will be populated with hints, one for each line; if there is one extra hint then the first one will be used as a (maybe containing Qt rich-text markup) tool-tip for the text otherwise the remaining hints will be concatenated, one-per-line, as a tool-tip when the text is hovered over by the pointer.
Line 1,798: Line 1,679:
 
:All GMCP functions to send sound and music events. For an overview on how all of these functions tie in together, see our [[Special:MyLanguage/Manual:Scripting#MUD_Client_Media_Protocol|MUD Client Media Protocol scripting overview]].
 
:All GMCP functions to send sound and music events. For an overview on how all of these functions tie in together, see our [[Special:MyLanguage/Manual:Scripting#MUD_Client_Media_Protocol|MUD Client Media Protocol scripting overview]].
  
−
==Playing Media, PR #7026==
+
=Supported Protocols=
  
−
===Playing Media===
+
=Events=
 +
:New or revised events that Mudlet can raise to inform a profile about changes. See [[Manual:Event_Engine#Mudlet-raised_events|Mudlet-raised events]] for the existing ones.
  
−
Send '''Client.Media.Play''' GMCP events to play sound or music files.
+
===sysSettingChanged, PR #7476===
 +
This event is raised when a Preferences or Mudlet setting has changed. The first argument contains the setting that was changed, further arguments detail the change.
  
−
{| class="wikitable"
+
Currently implemented sysSettingChanged events are;
−
! Required
+
 
−
! Key
+
* "main window font" - raised when the main window/console font has changed via API or Preferences window. Returns two additional arguments, the font family and the font size. e.g. {"main window font", "Times New Roman", 12 }
−
! Value
+
 
−
! Default
+
{{MudletVersion| ?.??}}
−
! style="text-align:left;"| Purpose
+
 
−
|- style="color: green;"
+
{{note}} pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/7476
−
| style="text-align:center;"| Yes
+
 
−
| "name"
+
===sysMapAreaChanged, PR #6615===
−
| <file name>
+
Raised when the area being viewed in the mapper is changed, either by the player-room being set to a new area or the user selecting a different area in the area selection combo-box in the mapper controls area. Returns two additional arguments being the areaID of the area being switched to and then the one for the area that is being left.
−
| &nbsp;
+
 
−
| style="text-align:left;"|
+
{{MudletVersion| ?.??}}
−
* Name of the media file.
 
−
* May contain directory information (i.e. weather/lightning.wav).
 
−
* Wildcards ''*'' and ''?'' may be used within the name to randomize media files selection.
 
−
|- style="color: blue;"
 
−
| style="text-align:center;"| Maybe
 
−
| "url"
 
−
| <url>
 
−
| &nbsp;
 
−
| style="text-align:left;"|
 
−
* Resource location where the media file may be downloaded.
 
−
* Only required if the file is to be downloaded remotely and a url was not set above with Client.Media.Default or Client.Media.Load.
 
−
|-
 
−
| style="text-align:center;"| No
 
−
| "type"
 
−
| "sound" or "music"
 
−
| "sound"
 
−
| style="text-align:left;"|
 
−
* Identifies the type of media.
 
−
|-
 
−
| style="text-align:center;"| No
 
−
| "tag"
 
−
| <tag>
 
−
| &nbsp;
 
−
| style="text-align:left;"|
 
−
* Helps categorize media.
 
−
|-
 
−
| style="text-align:center;"| No
 
−
| "volume"
 
−
| 1 to 100
 
−
| 50
 
−
| style="text-align:left;"|
 
−
* Relative to the volume set on the player's client.
 
−
|-
 
−
| style="text-align:center;"| No
 
−
| "fadein"
 
−
|<msec>
 
−
|
 
−
|
 
−
*Volume increases, or fades in, ranged across a linear pattern from one to the volume set with the "volume" key.
 
−
*Start position:  Start of media.
 
−
*End position:  Start of media plus the number of milliseconds (msec) specified.
 
−
*1000 milliseconds = 1 second.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
|"fadeout"
 
−
|<msec>
 
−
|
 
−
|
 
−
*Volume decreases, or fades out, ranged across a linear pattern from the volume set with the "volume" key to one.
 
−
*Start position:  End of the media minus the number of milliseconds (msec) specified.
 
−
*End position:  End of the media.
 
−
*1000 milliseconds = 1 second.
 
−
|-
 
−
| style="text-align:center;"| No
 
−
| "start"
 
−
| <msec>
 
−
| 0
 
−
| style="text-align:left;"|
 
−
* Begin play at the specified position in milliseconds.
 
−
* 1000 milliseconds = 1 second.
 
−
|-
 
−
| style="text-align:center;"| No
 
−
| "finish"
 
−
| <msec>
 
−
| 0
 
−
| style="text-align:left;"|
 
−
* End play at the specified position in milliseconds.
 
−
* 1000 milliseconds = 1 second.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
|"loops"
 
−
| -1, or >= 1
 
−
|1
 
−
| style="text-align:left;"|
 
−
* Number of iterations that the media plays.
 
−
* A value of -1 allows the sound or music to loop indefinitely.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
|"priority"
 
−
|1 to 100
 
−
|&nbsp;
 
−
| style="text-align:left;" |
 
−
*Halts the play of current or future played media files with a lower priority while this media plays.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
|"continue"
 
−
| true or false
 
−
|true
 
−
| style="text-align:left;" |
 
−
*Only valid for media files with a "type" of "music".
 
−
*Continues playing matching new music files when true.
 
−
*Restarts matching new music files when false.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
|"key"
 
−
|<key>
 
−
|&nbsp;
 
−
| style="text-align:left;" |
 
−
*Uniquely identifies media files with a "key" that is bound to their "name" or "url".
 
−
*Halts the play of current media files with the same "key" that have a different "name" or "url" while this media plays.
 
−
|-
 
−
|}
 
  
−
==== name====
+
{{note}} pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/6615
−
 
 
−
For example, to simply play the sound of a cow mooing already stored in the "media" folder:
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "cow.wav"
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
Or some lightning stored in a "weather" sub-folder under the "media" folder.
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "weather/lightning.wav"
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
The "name" parameter may be used for stopping media with the Client.Media.Stop GMCP event.
 
−
 
 
−
====url====
 
−
 
 
−
If you maintain your sound files on the Internet and don't set a default URL with Client.Media.Default, or preload them with Client.Media.Load, include the "url" parameter:
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "cow.wav",
 
−
  "url": "https://www.example.com/sounds/"
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
====type: sound====
 
−
 
 
−
Media files default to a "type" of "sound" when the "type" parameter is not specified, such as in the example above. It is good practice to specify the "type" parameter to best keep media organized within your implementation:
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "cow.wav",
 
−
  "type": "sound"
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
The "type" parameter may be used for stopping matching media with the Client.Media.Stop GMCP event.
 
−
 
 
−
====tag====
 
−
 
 
−
To play the sound of a sword swooshing and categorized as "combat":
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "sword1.wav",
 
−
  "type": "sound",
 
−
  "tag": "combat"
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
The "tag" parameter may be used for stopping matching media with the Client.Media.Stop GMCP event.
 
−
 
 
−
====type: music====
 
−
 
 
−
Add background music to your environment through use of the "music" value set upon the "type" parameter:
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "river.wav",
 
−
  "type": "music",
 
−
  "tag": "environment"
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
The "type" parameter may be used for stopping matching media with the Client.Media.Stop GMCP event.
 
−
 
 
−
====volume: 1 to 100====
 
−
 
 
−
As the character draws nearer to or farther from the environmental feature, consider adjusting the "volume" parameter.  Example values, followed by syntax examples:
 
−
 
 
−
*Maximum: 100 (recommended to use rarely)
 
−
*High: 75
 
−
*Default: 50
 
−
* Low: 25
 
−
* Minimum: 1 (recommended to use rarely)
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "river.wav",
 
−
  "type": "music",
 
−
  "tag": "environment",
 
−
  "volume": 75
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
Although using the integer type is recommended, Mudlet parses "volume" values of type string ("75") into integers (75) as needed.
 
−
 
 
−
====fadein====
 
−
 
 
−
Increase volume from the start of the media [start position, volume one] to the number in milliseconds specified with the "fadein" parameter [position start + milliseconds, volume specified with the "volume" parameter].  Example values, followed by syntax examples:
 
−
 
 
−
*1000 milliseconds (1 second)
 
−
*60000 milliseconds (1 minute)
 
−
*0 milliseconds (no fade in)
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "monty_python.mp3",
 
−
  "type": "music",
 
−
  "volume": 100,
 
−
  "fadein": 1000
 
−
}
 
−
</syntaxhighlight>
 
−
        +---------------------------+-----------------------+
 
−
        | Fade in 1000 milliseconds |        Normal        |
 
−
        +---------------------------+-----------------------+
 
−
Volume 1|........::::::::::iiiiiiiii%%%%%%%%%%%%%%%%%%%%%%%%|Volume 100
 
−
        +---------------------------+-----------------------+
 
−
Although using the integer type is recommended, Mudlet parses "fadein" values of type string ("1000") into integers (1000) as needed.
 
−
 
 
−
==== fadeout====
 
−
 
 
−
Decrease volume from a position in milliseconds subtracted from the duration of the media [position duration - milliseconds, volume specified with the "volume" parameter] to the end of the media [position duration, volume one].  Example values, followed by syntax examples:
 
−
 
 
−
*1000 milliseconds (1 second)
 
−
*60000 milliseconds (1 minute)
 
−
*0 milliseconds (no fade out)
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "the_matrix.mp3",
 
−
  "type": "music",
 
−
  "volume": 50,
 
−
  "fadeout": 333
 
−
}
 
−
</syntaxhighlight>
 
−
          +-----------------------+---------------------------+
 
−
          |        Normal        | Fade out 333 milliseconds |
 
−
          +-----------------------+---------------------------+
 
−
Volume 50|%%%%%%%%%%%%%%%%%%%%%%%%iiiiiiiii::::::::::........|Volume 1
 
−
          +-----------------------+---------------------------+
 
−
Although using the integer type is recommended, Mudlet parses "fadeout" values of type string ("333") into integers (333) as needed.
 
−
 
 
−
==== start ====
 
−
 
 
−
Start playing a media track at the number of milliseconds specified.  Example values, followed by syntax examples:
 
−
 
 
−
*1000 milliseconds (1 second)
 
−
*60000 milliseconds (1 minute)
 
−
*0 milliseconds (start from beginning)
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "mudlet_beatboxing.mp3",
 
−
  "type": "music",
 
−
  "volume": 75,
 
−
  "start": 1000
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
Although using the integer type is recommended, Mudlet parses "start" values of type string ("100") into integers (100) as needed.
 
−
 
 
−
==== finish ====
 
−
 
 
−
Finish playing a media track at the number of milliseconds specified.  Example values, followed by syntax examples:
 
−
 
 
−
*1000 milliseconds (1 second)
 
−
*60000 milliseconds (1 minute)
 
−
*0 milliseconds (start from beginning)
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "mudlet_beatboxing.mp3",
 
−
  "type": "music",
 
−
  "volume": 75,
 
−
  "finish": 35000
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
Although using the integer type is recommended, Mudlet parses "finish" values of type string ("100") into integers (100) as needed.
 
−
 
 
−
==== loops: -1, 1 or more ====
 
−
 
 
−
The "loops" parameter controls how many times the sound repeats and defaults to 1 if not specified. A value of -1 will loop the file indefinitely.
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "clock/hour_bell.wav",
 
−
  "type": "sound",
 
−
  "loops": 3
 
−
}
 
−
 
 
−
Client.Media.Play {
 
−
  "name": "underdark.mp3",
 
−
  "type": "music",
 
−
  "tag": "environment",
 
−
  "loops": -1
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
Although using the integer type is recommended, Mudlet parses "loops" values of type string ("-1") into integers (-1) as needed.
 
−
 
 
−
==== priority: 1 to 100 ====
 
−
 
 
−
The "priority" parameter sets precedence for Client.Media.Play GMCP events that include a "priority" setting. The values for the "priority" parameter range between 1 and 100. Given that two Client.Media.Play GMCP events have the same priority, the media already playing will continue playing. In Mudlet, media without priority set is not included comparisons based on priority.
 
−
 
 
−
A common place to find priority implemented is with combat. In the following example, imagine a combat scenario where some sounds of sword thrusts were interrupted by a successful blocking maneuver.
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "sword1.wav",
 
−
  "type": "sound",
 
−
  "tag": "combat",
 
−
  "loops": 3,
 
−
  "priority": 60
 
−
}
 
−
 
 
−
Client.Media.Play {
 
−
  "name": "block1.wav",
 
−
  "type": "sound",
 
−
  "tag": "combat",
 
−
  "priority": 70
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
Although using the integer type is recommended, Mudlet parses "priority" values of type string ("25") into integers (25) as needed.
 
−
 
 
−
The "priority" parameter may be used for stopping matching media with the Client.Media.Stop GMCP event.
 
−
 
 
−
====continue: true or false (for music)====
 
−
 
 
−
Typically sent with the "type" of "music" is the parameter "continue", which presents the following values:
 
−
 
 
−
*true: continues music that is already playing if it is requested again through a new Client.Media.Play GMCP event
 
−
*false: restarts music that is already playing if it is requested again through a new Client.Media.Play GMCP event
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "city.mp3",
 
−
  "type": "music",
 
−
  "tag": "environment",
 
−
  "continue": true
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
If the "continue" parameter is not specified, behavior will default to ''true'' for music.
 
−
 
 
−
Although using the boolean type is recommended, Mudlet parses "continue" values of type string ("true" and "false") into boolean (''true'' and ''false'') as needed, as not all game drivers support a boolean type.
 
−
 
 
−
==== key====
 
−
 
 
−
The "key" parameter enables media categorization, similar to the "tag" parameter, however it adds a feature of uniqueness that halts media currently playing with the same key, replacing it with the media that arrived from a new Client.Media.Play GMCP event. This update will only occur if the "name" or "url" associated with the currently playing media does not match the new media, while the key is identical.
 
−
 
 
−
In the example below, consider that a player moves from a sewer area to a village.  The "key" parameter is used to stop the previously playing ''sewer.mp3'' and start playing ''village.mp3'' within the second Client.Media.Play GMCP event.
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "sewer.mp3",
 
−
  "type": "music",
 
−
  "tag": "environment",
 
−
  "loops": -1,
 
−
  "continue": true,
 
−
  "key": "area-music"
 
−
}
 
−
 
 
−
Client.Media.Play {
 
−
  "name": "village.mp3",
 
−
  "type": "music",
 
−
  "tag": "environment",
 
−
  "loops": -1,
 
−
  "continue": true,
 
−
  "key": "area-music"
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
The "key" parameter may be used for stopping matching media with the Client.Media.Stop GMCP event.
 
−
 
 
−
{{note}} Where music is bound to change, continue or stop as a player enters a new room, consider allowing for a slight pause of 1 heart beat or tick to send the Client.Media.Play or Client.Media.Stop GMCP events. This practice reduces the number of Client.Media.Play GMCP events sent when the player travels through several rooms quickly.
 
−
 
 
−
==== randomization====
 
−
 
 
−
Wildcards ''*'' (asterisk) and ''?'' (question mark) may be used within the name to randomize media file(s) selection.
 
−
 
 
−
Given that media files underdark.wav, underdark.mp3 and underdark_dark_elven_moshpit.mp3 were all present in the media/environment directory under the current game profile, the following Client.Media.Play GMCP event would randomly choose one of those files to play using the ''*'' wildcard.
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "underdark*",
 
−
  "type": "music",
 
−
  "tag": "environment",
 
−
  "loops": -1,
 
−
  "continue": false
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
If media files sword1.wav, sword2.wav and sword3.wav were all present in the media/combat directory under the current game profile, the following Client.Media.Play GMCP event would randomly choose one of those files to play per each loop using the ''?'' wildcard.
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Play {
 
−
  "name": "combat/sword?.wav",
 
−
  "type": "sound",
 
−
  "tag": "combat",
 
−
  "loops": 3
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
==Stopping Media, PR #7026==
 
−
 
 
−
=== Stopping Media ===
 
−
 
 
−
Send '''Client.Media.Stop''' GMCP events to stop sound or music media.
 
−
 
 
−
{| class="wikitable"
 
−
!Required
 
−
!Key
 
−
!Value
 
−
! style="text-align:left;" |Purpose
 
−
|-
 
−
| style="text-align:center;" | No
 
−
| "name"
 
−
|<file name>
 
−
| style="text-align:left;" |
 
−
*Stops playing media by name matching the value specified.
 
−
|-
 
−
| style="text-align:center;" | No
 
−
|"type"
 
−
|"sound" or "music"
 
−
| style="text-align:left;" |
 
−
*Stops playing media by type matching the value specified.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
| "tag"
 
−
|<tag>
 
−
| style="text-align:left;" |
 
−
*Stops playing media by tag matching the value specified.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
|"priority"
 
−
|1 to 100
 
−
| style="text-align:left;" |
 
−
*Stops playing media with priority less than or equal to the value.
 
−
|-
 
−
| style="text-align:center;" |No
 
−
|"key"
 
−
|<key>
 
−
| style="text-align:left;" |
 
−
*Stops playing media by key matching the value specified.
 
−
|-
 
−
| style="text-align:center;"| No
 
−
| "fadeaway"
 
−
| true or false
 
−
| style="text-align:left;" |
 
−
* Decrease volume from the current position for a given duration, then stops the track.
 
−
* Given duration is the lesser of the remaining track duration or the fadeout specified in Client.Media.Play.
 
−
* If fadeout was not specified in Client.Media.Play, then the optional fadeout parameter from Client.Media.Stop or a default of 5000 milliseconds will be applied.
 
−
|-
 
−
| style="text-align:center;"| No
 
−
| "fadeout"
 
−
|
 
−
| style="text-align:left;" |
 
−
* Default duration in milliseconds to decrease volume to the end of the track.
 
−
* Only used if fadeout was not defined in Client.Media.Play.
 
−
|-
 
−
|}
 
−
 
 
−
====all====
 
−
 
 
−
Send the Client.Media.Stop GMCP event with no parameters to stop all playing media within a given game profile.
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Stop {}
 
−
</syntaxhighlight>
 
−
 
 
−
====parameters====
 
−
 
 
−
Send any combination of the name, type, tag, priority or sound parameters and valid corresponding values to stop playing media that matches ''all'' combinations of the parameters.
 
−
 
 
−
Stop the rain.
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Stop {
 
−
  "name": "rain.wav"
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
Stop all media using the "type" of "sound".
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Stop {
 
−
  "type": "sound"
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
Stop all media categorized with the "tag" of "combat" ''and'' that has a "priority" less than or equal to 50.
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Stop {
 
−
  "tag": "combat",
 
−
  "priority": 50
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
Stop all media categorized with the "key" of "area-music".
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Stop {
 
−
  "key": "area-music"
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
Decrease volume for 5 seconds (or the fadeout parameter defined in Client.Media.Play) and then stop all playing music files for this profile
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Stop {
 
−
  "fadeaway": true
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
Decrease volume for 10 seconds all media categorized with the "key" of "area-music" and then stop the music
 
−
 
 
−
<syntaxhighlight lang="json">
 
−
Client.Media.Stop {
 
−
  "key": "area-music",
 
−
  "fadeaway": true,
 
−
  "fadeout": 10000
 
−
}
 
−
</syntaxhighlight>
 
−
 
 
−
=Supported Protocols, PR #7058=
 
−
 
 
−
Mudlet supports CHARSET, NEW-ENVIRON, MTTS, MNES, GMCP, MSSP, MSP, ATCP, Aardwolfs 102, MSDP, and the MXP Protocol.
 
−
 
 
−
CHARSET, NEW-ENVIRON, MTTS, MXP, MSSP, MSP, GMCP and 102 are enabled by default, MSDP and MNES can be enabled in settings.
 
−
 
 
−
==NEW-ENVIRON, PR #7058==
 
−
To enhance the player experience through sharing more client-supported details, the Telnet New-Environ Option may be used to transfer client environment variables from Mudlet to game servers. Sharing supporting information on information such as encoding, terminal emulation, and accessibility options aims to improve initial player setup and increase the retention rate for new gaming community members.
 
−
 
 
−
===NEW-ENVIRON in Mudlet===
 
−
Mudlet supports two methods of information exchange via NEW-ENVIRON, the first via [https://datatracker.ietf.org/doc/html/rfc1572 RFC 1572]: '''Telnet New-Environ Option''', and the second is [https://tintin.mudhalla.net/protocols/mnes/ MNES]: '''Mud New-Environ Standard''', which shares a standardized set of client information across multiple clients.
 
−
 
 
−
====Client Environment Variable Updates====
 
−
Mudlet provides a user-friendly interface for managing environmental variables through its Settings menu. For certain environmental variables, manual selections made in the Settings menus can dynamically notify servers that have expressed interest in the client's environmental variables through the negotiation of the NEW-ENVIRON option. For instance, when a Mudlet user updates the data encoding for a server profile by navigating to Settings, General, and choosing a specific data encoding from the drop-down menu, this information becomes available for transmission via both the RFC (default) and MNES (requires user enabling) options.  
 
−
 
 
−
==== Available Client Environment Variables [https://datatracker.ietf.org/doc/html/rfc1572 RFC 1572] ====
 
−
Two types of variables are used per RFC 152, well-known variables defines with VAR (0) and for less common variables, USERVAR (3). Some client variables updates may be reported ad-hoc with an INFO message. If there is no value for a defined variable, a VAL (1) will be sent without a value following it.
 
−
{| class="wikitable"
 
−
! Type
 
−
! Variable
 
−
! Example Values
 
−
!Mudlet Default
 
−
!INFO
 
−
! Purpose
 
−
|-
 
−
| VAR
 
−
| SYSTEMTYPE
 
−
| MACOS, WIN64, WIN32, BSD4, CYGWIN, FREEBSD, HURD, NETBSD, OPENBSD, LINUX, UNIX
 
−
|
 
−
|
 
−
| Client runs within the listed operating system.
 
−
|-
 
−
| VAR
 
−
| USER
 
−
| tamarindo
 
−
|
 
−
|
 
−
| Character name defined in logon dialogue. Do not use to authenticate a user to your game.
 
−
|-
 
−
| USERVAR
 
−
| 256_COLORS
 
−
| 1
 
−
|1
 
−
|
 
−
| Client supports all 256 color codes. 1 = Yes/True/ACK.
 
−
|-
 
−
| USERVAR
 
−
| ANSI
 
−
| 1
 
−
|1
 
−
|
 
−
| Client supports all common ANSI color codes. 1 = Yes/True/ACK.
 
−
|-
 
−
| USERVAR
 
−
| CHARSET
 
−
| UTF-8, ASCII
 
−
|
 
−
|Yes
 
−
| Encoding set in the client
 
−
|-
 
−
| USERVAR
 
−
| CLIENT_NAME
 
−
| MUDLET
 
−
|MUDLET
 
−
|
 
−
| Name of the client.
 
−
|-
 
−
| USERVAR
 
−
| CLIENT_VERSION
 
−
| 4/18, 4/17/2-DEV
 
−
|
 
−
|
 
−
| Version of the client.
 
−
|-
 
−
| USERVAR
 
−
| FONT
 
−
| Bitstream Vera Sans Mono
 
−
|
 
−
|Yes
 
−
| Font used in the client.
 
−
|-
 
−
| USERVAR
 
−
| FONT_SIZE
 
−
| 14
 
−
|
 
−
|Yes
 
−
| Font size used in the client.
 
−
|-
 
−
| USERVAR
 
−
| IPADDRESS
 
−
| 127.0.0.1
 
−
|<empty>
 
−
|
 
−
| Client's IP address. Proxies may report the client's real IP address. This allows a MUD to ban specific users without having to ban an entire proxy. This is not applicable for Mudlet and while defined, is not used.
 
−
|-
 
−
| USERVAR
 
−
| LANGUAGE
 
−
| en_US
 
−
|
 
−
|Yes
 
−
| Client is using this language code and country variant.
 
−
|-
 
−
| USERVAR
 
−
| MOUSE_TRACKING
 
−
| 1
 
−
|<empty>
 
−
|
 
−
| Client supports xterm mouse tracking. 1 = Yes/True/ACK. This is not applicable for Mudlet and while defined, is not used.
 
−
|-
 
−
| USERVAR
 
−
| MTTS
 
−
| 2349
 
−
|
 
−
|Yes
 
−
| Bitvector defined in the Mud Terminal Type Standard ([https://tintin.mudhalla.net/protocols/mtts/ MTTS]).
 
−
|-
 
−
| USERVAR
 
−
| OSC_COLOR_PALETTE
 
−
| 1
 
−
|
 
−
|
 
−
| Client supports OSC and the OSC color palette. 1 = Yes/True/ACK.
 
−
|-
 
−
| USERVAR
 
−
| PROXY
 
−
| 1
 
−
|<empty>
 
−
|
 
−
| Client is a proxy allowing different users to connect from the same IP address. 1 = Yes/True/ACK. This is not applicable for Mudlet and while defined, is not used.
 
−
|-
 
−
| USERVAR
 
−
| SCREEN_READER
 
−
| 1
 
−
|<empty>
 
−
|Yes
 
−
| Client is using a screen reader. 1 = Yes/True/ACK.
 
−
|-
 
−
| USERVAR
 
−
| TERMINAL_TYPE
 
−
| ANSI-TRUECOLOR, ANSI-256COLOR, ANSI, XTERM, VT100, DUMB
 
−
|ANSI-TRUECOLOR
 
−
|
 
−
| Terminal type of the client
 
−
|-
 
−
| USERVAR
 
−
| TLS
 
−
| 1
 
−
|
 
−
|
 
−
| Client supports Transport Layer Security for data encryption. 1 = Yes/True/ACK.
 
−
|-
 
−
| USERVAR
 
−
| TRUECOLOR
 
−
| 1
 
−
|
 
−
|
 
−
| Client supports truecolor codes using semicolon notation. 1 = Yes/True/ACK.
 
−
|-
 
−
| USERVAR
 
−
| UTF-8
 
−
| 1
 
−
|
 
−
|Yes
 
−
| Client is using UTF-8 character encoding. 1 = Yes/True/ACK.
 
−
|-
 
−
| USERVAR
 
−
| VT100
 
−
| 1
 
−
|<empty>
 
−
|
 
−
| Client supports all common VT100 codes. 1 = Yes/True/ACK. This is not applicable for Mudlet and while defined, is not used.
 
−
|-
 
−
| USERVAR
 
−
| WORD_WRAP
 
−
| 100
 
−
|
 
−
|Yes
 
−
| Client wraps text at this value
 
−
|-
 
−
|}
 
−
 
 
−
====Negotiating NEW-ENVIRON====
 
−
Negotiating the NEW-ENVIRON Telnet option empowers game servers to request one, multiple, or all client environment variables configured within Mudlet. The process unfolds with the game server sending a Telopt DO NEW-ENVIRON (39), prompting Mudlet to respond with a WILL NEW-ENVIRON (39). Subsequently, the game server can send SB NEW-ENVIRON (39) SEND to receive all available environment variables. Mudlet responds with SB NEW-ENVIRON (39) IS (0) < VAR (0) | USERVAR (3) > "<variable>" [VAL (1)] ["<value>"] [ .. [ VAR (0) | USERVAR (3) ] "<variable>" VAL (1) "<value>"] containing the list of environmental variables.
 
−
 
 
−
Once an environmental variable is transmitted to a server within the ongoing connection, Mudlet replies with SB NEW-ENVIRON (39) INFO (2) < VAR (0) | USERVAR (3) > "<variable>" [VAL (1)] ["<value>"]. Importantly, no reply from the server is required in this context. If there is a need to specify a particular list of requested environmental variables to Mudlet, the format SB NEW-ENVIRON (39) SEND < VAR (0) | USERVAR (3) > "<variable>" [ .. < VAR (0) | USERVAR (3) > "<variable>" ] can be employed.
 
−
 
 
−
Success example #1 (one environmental variable):
 
−
{| class="wikitable"
 
−
! Server
 
−
! Mudlet
 
−
|-
 
−
| IAC DO NEW-ENVIRON (39)
 
−
| IAC WILL NEW-ENVIRON (39)
 
−
|-
 
−
| IAC SB NEW-ENVIRON (39) SEND USERVAR (3) ''CHARSET'' IAC SE
 
−
| IAC SB NEW-ENVIRON (39) IS USERVAR (3) ''CHARSET'' VAL (1) ''UTF-8'' IAC SE
 
−
|-
 
−
|}
 
  
−
Success example #2 (all environmental variables):
+
===sysMapWindowMousePressEvent, PR #6962===
−
{| class="wikitable"
+
Raised when the mouse is left-clicked on the mapper window.
−
! Server
 
−
! Mudlet
 
−
|-
 
−
| IAC DO NEW-ENVIRON (39)
 
−
| IAC WILL NEW-ENVIRON (39)
 
−
|-
 
−
| IAC SB NEW-ENVIRON (39) SEND IAC SE
 
−
| IAC SB NEW-ENVIRON (39) IS  VAR (0) ''SYSTEMTYPE'' VAL (1) ''MACOS'' VAR (0) ''USER'' VAL (1) ''tamarindo'' USERVAR (3) ''256_COLORS'' VAL (1) ''1'' USERVAR (3) ''ANSI'' VAL (1) ''1'' USERVAR (3) ''CHARSET'' VAL (1) ''UTF-8'' USERVAR (3) ''CLIENT_NAME'' VAL (1) ''MUDLET'' USERVAR (3) ''CLIENT_VERSION'' VAL (1) ''4/17/2-DEV'' USERVAR (3) ''FONT'' VAL (1) ''Bitstream Vera Sans Mono'' USERVAR (3) ''FONT_SIZE'' VAL (1) ''14'' USERVAR (3) ''IPADDRESS'' VAL (1) USERVAR (3) ''LANGUAGE'' VAL (1) ''en_US'' USERVAR (3) ''MOUSE_TRACKING'' VAL (1) USERVAR (3) ''MTTS'' VAL (1) ''2349'' USERVAR (3) ''OSC_COLOR_PALETTE'' VAL (1) ''1'' USERVAR (3) ''PROXY'' VAL (1) USERVAR (3) ''SCREEN_READER'' VAL (1) USERVAR (3) ''TERMINAL_TYPE'' VAL (1) ''ANSI-TRUECOLOR'' USERVAR (3) ''TLS'' VAL (1) ''1'' USERVAR (3) ''TRUECOLOR'' VAL (1) ''1'' USERVAR (3) ''UTF-8'' VAL (1) ''1'' USERVAR (3) ''VT100'' VAL (1) USERVAR (3) ''WORD_WRAP'' VAL (1) ''100''
 
−
|-
 
−
|}
 
−
 
 
−
If a Mudlet user does not want to negotiate environmental variables, they may choose the Settings, Special Options menu item in Mudlet and enable "Force NEW_ENVIRON negotiation off". The following is an example of an attempted negotiation where "Force NEW-ENVIRON negotiation off" is enabled.
 
−
{| class="wikitable"
 
−
! Server
 
−
! Mudlet
 
−
|-
 
−
| IAC DO NEW-ENVIRON (39)
 
−
| IAC WONT NEW-ENVIRON (39)
 
−
|-
 
−
|}
 
−
 
 
−
NEW-ENVIRON negotiation is available in Mudlet 4.18+.
 
−
 
 
−
=Events=
 
−
:New or revised events that Mudlet can raise to inform a profile about changes. See [[Manual:Event_Engine#Mudlet-raised_events|Mudlet-raised events]] for the existing ones.
 
−
 
 
−
===sysMapAreaChanged, PR #6615===
 
−
Raised when the area being viewed in the mapper is changed, either by the player-room being set to a new area or the user selecting a different area in the area selection combo-box in the mapper controls area. Returns two additional arguments being the areaID of the area being switched to and then the one for the area that is being left.
 
  
 
{{MudletVersion| ?.??}}
 
{{MudletVersion| ?.??}}
  
−
{{note}} pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/6615
+
{{note}} pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/6962
−
 
 
  
 
===sysWindowOverflowEvent, PR #6872===
 
===sysWindowOverflowEvent, PR #6872===

Latest revision as of 14:58, 3 November 2024

This page is for the development of documentation for Lua API functions that are currently being worked on. Ideally the entries here can be created in the same format as will be eventually used in Lua Functions and its sub-sites.

Please use the Area_51/Template to add new entries in the sections below.

Links to other functions or parts in other sections (i.e. the main Wiki area) need to include the section details before the '#' character in the link identifier on the left side of the '|' divider between the identifier and the display text. e.g.

[[Manual:Mapper_Functions#getCustomLines|getCustomLines()]]

rather than:

[[#getCustomLines|getCustomLines()]]

which would refer to a link within the current (in this case Area 51) section. Note that this ought to be removed once the article is moved to the main wiki area!

The following headings reflect those present in the main Wiki area of the Lua API functions. It is suggested that new entries are added so as to maintain a sorted alphabetical order under the appropriate heading.


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.

Database Functions

A collection of functions for helping deal with the database.

Date/Time Functions

A collection of functions for handling date & time.

File System Functions

A collection of functions for interacting with the file system.

Mapper Functions

A collection of functions that manipulate the mapper and its related features.

addRoom PR #7184 merged

addRoom(roomID, areaID)
Creates a new room with the given room ID and area ID, returns true if the room was successfully created.
Parameters
  • roomID:
Room ID to set the room as, manually assigned or from createRoomID().
  • areaID:
Area ID to set the room in, as returned by getAreaTable() or equivalents.

Note Note: If you're not using incremental room IDs but room IDs stitched together from other factors or in-game hashes for room IDs - and your room IDs are starting off at 250+million numbers, you need to look into incrementally creating Mudlets room IDs with createRoomID() and associating your room IDs with Mudlets via setRoomIDbyHash() and getRoomIDbyHash(). The reason being is that Mudlet's A* pathfinding implementation from boost cannot deal with extremely large room IDs because the resulting matrices it creates for pathfinding are enormously huge. Note Note: Creating your own mapping script? Check out more information here.

See also: createRoomID()
Example
local newroomid = createRoomID()
addRoom(newroomid)

getAreaRooms1, PR #7520 open

getAreaRooms1(area id)
Returns an indexed table with all rooms IDs for a given area ID (room IDs are values), or nil if no such area exists. Indexing starts at 1.

See also: getAreaRooms()

setRoomArea PR #7184 merged==

setRoomArea(roomID, newAreaID or newAreaName)
Assigns the given room (or set of rooms) to a new or different area. If the area is displayed in the mapper this will have the room be visually moved into the area as well.
roomID can also be a table of rooms for bulk assigning
See also: resetRoomArea()
Example
local newroomid = createRoomID()
setRoomArea(newroomid, "My New Area")
local rooms = { 1234, 4321, 5678 }
setRoomArea(rooms, "My New Area")

updateMap

updateMap()
Updates the mapper display (redraws it). While longer necessary since Mudlet 4.18, you can use this this function to redraw the map after changing it via API.
See also: centerview()
Example
-- delete a some room
deleteRoom(500)
-- now make the map show that it's gone
updateMap()


mapSymbolFontInfo, PR #4038 closed

mapSymbolFontInfo()
See also: setupMapSymbolFont()

Note Note: pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/4038

returns
  • either a table of information about the configuration of the font used for symbols in the (2D) map, the elements are:
  • fontName - a string of the family name of the font specified
  • onlyUseThisFont - a boolean indicating whether glyphs from just the fontName font are to be used or if there is not a glyph for the required grapheme (character) then a glyph from the most suitable different font will be substituted instead. Should this be true and the specified font does not have the required glyph then the replacement character (typically something like �) could be used instead. Note that this may not affect the use of Color Emoji glyphs that are automatically used in some OSes but that behavior does vary across the range of operating systems that Mudlet can be run on.
  • scalingFactor - a floating point number between 0.50 and 2.00 which modifies the size of the symbols somewhat though the extremes are likely to be unsatisfactory because some of the particular symbols may be too small (and be less visible at smaller zoom levels) or too large (and be clipped by the edges of the room rectangle or circle).
  • or nil and an error message on failure.
As the symbol font details are stored in the (binary) map file rather than the profile then this function will not work until a map is loaded (or initialized, by activating a map window).

moveMapLabel, PR #6014 open

moveMapLabel(areaID/Name, labeID/Text, coordX/deltaX, coordY/deltaY[, coordZ/deltaZ][, absoluteNotRelativeMove])

Re-positions a map label within an area in the 2D mapper, in a similar manner as the moveRoom() function does for rooms and their custom exit lines. When moving a label to given coordinates this is the position that the top-left corner of the label will be positioned at; since the space allocated to a particular room on the map is ± 0.5 around the integer value of its x and y coordinates this means for a label which has a size of 1.0 x 1,0 (w x h) to position it centrally in the space for a single room at the coordinates (x, y, z) it should be positioned at (x - 0.5, y + 0.5, z).

See also: getMapLabels(), getMapLabel().
Mudlet VersionAvailable in Mudlet ?.??+

Note Note: pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/6014

Parameters
  • areaID/Name:
Area ID as number or AreaName as string containing the map label.
  • labelID/Text:
Label ID as number (which will be 0 or greater) or the LabelText on a text label. All labels will have a unique ID number but there may be more than one text labels with a non-empty text string; only the first matching one will be moved by this function and image labels also have no text and will match the empty string. with mo or AreaName as string containing the map label.
  • coordX/deltaX:
A floating point number for the absolute coordinate to use or the relative amount to move the label in "room coordinates" along the X-axis.
  • coordY/deltaY:
A floating point number for the absolute coordinate to use or the relative amount to move the label in "room coordinates" along the Y-axis.
  • coordZ/deltaZ:
(Optional) A floating point number for the absolute coordinate to use or the relative amount to move the label in "room coordinates" along the Z-axis, if omitted the label is not moved in the z-axis at all.
  • absoluteNotRelativeMove:
(Optional) a boolean value (defaults to false if omitted) as to whether to move the label to the absolute coordinates (true) or to move it the relative amount from its current location (false).
Returns
true on success or nil and an error message on failure, if successful it will also refresh the map display to show the result.
Example
-- move the first label in the area with the ID number of 2, three spaces to the east and four spaces to the north
moveMapLabel(0, 2, 3.0, 4.0)

-- move the first label in the area with the ID number of 2, one space to the west, note the final boolean argument is unneeded
moveMapLabel(0, 2, -1.0, 0.0, false)

-- move the second label in the area with the ID number of 2, three and a half spaces to the west, and two south **of the center of the current level it is on in the map**:
moveRoom(1, 2, -3.5, -2.0, true)

-- move the second label in the area with the ID number of 2, up three levels
moveRoom(1, 2, 0.0, 0.0, 3.0)

-- move the second label in the "Test 1" area one space to the west, note the last two arguments are unneeded
moveRoom("Test 1", 1, -1.0, 0.0, 0.0, false)

-- move the (top-left corner of the first) label with the text "Home" in the area with ID number 5 to the **center of the whole map**, note the last two arguments are required in this case:
moveRoom(5, "Home", 0.0, 0.0, 0.0, true)

-- all of the above will return the 'true'  boolean value assuming there are the indicated labels and areas

moveRoom, PR #6010 open

moveRoom(roomID, coordX/deltaX, coordY/deltaY[, coordZ/deltaZ][, absoluteNotRelativeMove])

Re-positions a room within an area, in the same manner as the "move to" context menu item for one or more rooms in the 2D mapper. Like that method this will also shift the entirety of any custom exit lines defined for the room concerned. This contrasts with the behavior of the setRoomCoordinates() which only moves the starting point of such custom exit lines so that they still emerge from the room to which they belong but otherwise remain pointing to the original place.

See also: setRoomCoordinates()
Mudlet VersionAvailable in Mudlet ?.??+

Note Note: pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/6010

Parameters
  • roomID:
Room ID number to move.
  • coordX/deltaX:
The absolute coordinate or the relative amount as a number to move the room in "room coordinates" along the X-axis.
  • coordY/deltaY:
The absolute coordinate or the relative amount as a number to move the room in "room coordinates" along the Y-axis.
  • coordZ/deltaZ:
(Optional) the absolute coordinate or the relative amount as a number to move the room in "room coordinates" along the Z-axis, if omitted the room is not moved in the z-axis at all.
  • absoluteNotRelativeMove:
(Optional) a boolean value (defaults to false if omitted) as to whether to move the room to the absolute coordinates (true) or the relative amount from its current location (false).
Returns
true on success or nil and an error message on failure, if successful it will also refresh the map display to show the result.
Example
-- move the first room one space to the east and two spaces to the north
moveRoom(1, 1, 2)

-- move the first room one space to the west, note the final boolean argument is unneeded
moveRoom(1, -1, 0, false)

-- move the first room three spaces to the west, and two south **of the center of the current level it is on in the map**:
moveRoom(1, -3, -2, true)

-- move the second room up three levels
moveRoom(2, 0, 0, 3)

-- move the second room one space to the west, note the last two arguments are unneeded
moveRoom(2, -1, 0, 0, false)

-- move the second room to the **center of the whole map**, note the last two arguments are required in this case:
moveRoom(2, 0, 0, 0, true)

-- all of the above will return the 'true'  boolean value assuming there are rooms with 1 and 2 as ID numbers

setupMapSymbolFont, PR #4038 closed

setupMapSymbolFont(fontName[, onlyUseThisFont[, scalingFactor]])
configures the font used for symbols in the (2D) map.
See also: mapSymbolFontInfo()

Note Note: pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/4038

Parameters
  • fontName one of:
  • - a string that is the family name of the font to use;
  • - the empty string "" to reset to the default {which is "Bitstream Vera Sans Mono"};
  • - a Lua nil as a placeholder to not change this parameter but still allow a following one to be modified.
  • onlyUseThisFont (optional) one of:
  • - a Lua boolean true to require Mudlet to use graphemes (character) only from the selected font. Should a requested grapheme not be included in the selected font then the font replacement character (�) might be used instead; note that under some circumstances it is possible that the OS (or Mudlet) provided color Emoji Font may still be used but that cannot be guaranteed across all OS platforms that Mudlet might be run on;
  • - a Lua boolean false to allow Mudlet to get a different glyph for a particular grapheme from the most suitable other font found in the system should there not be a glyph for it in the requested font. This is the default unless previously changed by this function or by the corresponding checkbox in the Profile Preferences dialogue for the profile concerned;
  • - a Lua nil as a placeholder to not change this parameter but still allow the following one to be modified.
  • scalingFactor (optional): a floating point value in the range 0.5 to 2.0 (default 1.0) that can be used to tweak the rectangular space that each different room symbol is scaled to fit inside; this might be useful should the range of characters used to make the room symbols be consistently under- or over-sized.
Returns
  • true on success
  • nil and an error message on failure. As the symbol font details are stored in the (binary) map file rather than the profile then this function will not work until a map is loaded (or initialised, by activating a map window).

Miscellaneous Functions

Miscellaneous functions.

compare, PR#7122 open

sameValue = compare(a, b)
This function takes two items, and compares their values. It will compare numbers, strings, but most importantly it will compare two tables by value, not reference. For instance, {} == {} is false, but compare({}, {}) is true
See also
table.complement(), table.n_union()
Mudlet VersionAvailable in Mudlet4.18+
Parameters
  • a:
The first item to compare
  • b:
The second item to compare
Returns
  • Boolean true if the items have the same value, otherwise boolean false
Example
local tblA = { 255, 0, 0 }
local tblB = color_table.red
local same = compare(tblA, tblB)
display(same)
-- this will return true
display(tblA == tblB)
-- this will display false, as they are different tables
-- even though they have the same value
Additional development notes

This is just exposing the existing _comp function, which is currently the best way to compare two tables by value. --Demonnic (talk) 18:51, 7 February 2024 (UTC)

createVideoPlayer, PR #6439

createVideoPlayer([name of userwindow], x, y, width, height)
Creates a miniconsole window for the video player to render in, the with the given dimensions. One can only create one video player at a time (currently), and it is not currently possible to have a label on or under the video player - otherwise, clicks won't register.

Note Note: A video player may also be created through use of the Mud Client Media Protocol, the playVideoFile() API command, or adding a Geyser.VideoPlayer object to ones user interface such as the example below.

Note Note: The Main Toolbar will show a Video button to hide/show the video player, which is located in a userwindow generated through createVideoPlayer, embedded in a user interface, or a dock-able widget (that can be floated free to anywhere on the Desktop, it can be resized and does not have to even reside on the same monitor should there be multiple screens in your system). Further clicks on the Video button will toggle between showing and hiding the map whether it was created using the createVideo function or as a dock-able widget.

See also: loadSoundFile(), loadMusicFile(), loadVideoFile(), playSoundFile(), playMusicFile(), playVideoFile(), stopSounds(), stopMusic(), stopVideos(), purgeMediaCache(), Mud Client Media Protocol

Mudlet VersionAvailable in Mudlet4.??+
Example
-- Create a 300x300 video player in the top-left corner of Mudlet
createVideoPlayer(0,0,300,300)

-- Alternative examples using Geyser.VideoPlayer
GUI.VideoPlayer = GUI.VideoPlayer or Geyser.VideoPlayer:new({name="GUI.VideoPlayer", x = 0, y = 0, width = "25%", height = "25%"})
 
GUI.VideoPlayer = GUI.VideoPlayer or Geyser.VideoPlayer:new({
  name = "GUI.VideoPlayer",
  x = "70%", y = 0, -- edit here if you want to move it
  width = "30%", height = "50%"
}, GUI.Right)

loadVideoFile, PR #6439

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 playVideoFile() and stopVideos(). Although files could be loaded or streamed directly at playing time from playVideoFile(), loadVideoFile() provides the advantage of loading files in advance.

Note Note: Video files consume drive space on your device. Consider using the streaming feature of playVideoFile() for large files.

Required Key Value Purpose
Yes name <file name>
  • 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")
Maybe url <url>
  • 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: loadSoundFile(), loadMusicFile(), playSoundFile(), playMusicFile(), playVideoFile(), stopSounds(), stopMusic(), stopVideos(), createVideoPlayer(), purgeMediaCache(), Mud Client Media Protocol

Mudlet VersionAvailable in Mudlet4.??+
Example
---- 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"})
---- Ordered Parameter Syntax of loadVideoFile(name[, url]) ----

-- Download from the Internet
loadVideoFile(
    "TextInMotion-VideoSample-1080p.mp4"
    , "https://d2qguwbxlx1sbt.cloudfront.net/"
)

-- OR download from the profile
loadVideoFile(getMudletHomeDir().. "/TextInMotion-VideoSample-1080p.mp4")

-- OR download from the local file system
loadVideoFile("C:/Users/Tamarindo/Movies/TextInMotion-VideoSample-1080p.mp4")

playVideoFile, PR #6439

playVideoFile(settings table)
Plays video files from the Internet or the local file system for later use with stopMusic(). Video files may be downloaded to the device and played, or streamed from the Internet when the value of the stream parameter is true.
Required Key Value Default Purpose
Yes name <file name>  
  • Name of the media file.
  • May contain directory information (i.e. weather/maelstrom.mp4).
  • May be part of the profile (i.e. getMudletHomeDir().. "/cow.mp4")
  • May be on the local device (i.e. "C:/Users/YourNameHere/Documents/nevergoingtogiveyouup.mp4")
  • Wildcards * and ? may be used within the name to randomize media files selection.
No volume 1 to 100 50
  • Relative to the volume set on the player's client.
No fadein <msec>
  • Volume increases, or fades in, ranged across a linear pattern from one to the volume set with the "volume" key.
  • Start position: Start of media.
  • End position: Start of media plus the number of milliseconds (msec) specified.
  • 1000 milliseconds = 1 second.
No fadeout <msec>
  • Volume decreases, or fades out, ranged across a linear pattern from the volume set with the "volume" key to one.
  • Start position: End of the media minus the number of milliseconds (msec) specified.
  • End position: End of the media.
  • 1000 milliseconds = 1 second.
No start <msec> 0
  • Begin play at the specified position in milliseconds.
No loops -1, or >= 1 1
  • Number of iterations that the media plays.
  • A value of -1 allows the media to loop indefinitely.
No key <key>  
  • Uniquely identifies media files with a "key" that is bound to their "name" or "url".
  • Halts the play of current media files with the same "key" that have a different "name" or "url" while this media plays.
No tag <tag>  
  • Helps categorize media.
No continue true or false true
  • Continues playing matching new video files when true.
  • Restarts matching new video files when false.
Maybe url <url>  
  • Resource location where the media file may be downloaded.
  • Only required if the file is to be downloaded remotely or for streaming from the Internet.
Maybe stream true or false false
  • Streams files from the Internet when true.
  • Download files when false (default).
  • Used in combination with the `url` key.

See also: loadSoundFile(), loadMusicFile(), loadVideoFile(), playSoundFile(), playMusicFile(), stopSounds(), stopMusic(), stopVideos(), createVideoPlayer(), purgeMediaCache(), Mud Client Media Protocol

Mudlet VersionAvailable in Mudlet4.??+
Example
---- Table Parameter Syntax ----

-- Stream a video file from the Internet and play it.
playVideoFile({
    name = "TextInMotion-VideoSample-1080p.mp4"
    , url = "https://d2qguwbxlx1sbt.cloudfront.net/"
    , stream = true
})

-- Play a video file from the Internet, storing it in the profile's media directory (i.e. /Users/Tamarindo/mudlet-data/profiles/StickMUD/media) so you don't need to download it over and over.  You could add ", stream = false" below, but that is the default and is not needed.

playVideoFile({
    name = "TextInMotion-VideoSample-1080p.mp4"
    , url = "https://d2qguwbxlx1sbt.cloudfront.net/"
})

-- Play a video file stored in the profile's media directory (i.e. /Users/Tamarindo/mudlet-data/profiles/StickMUD/media)
playVideoFile({
    name = "TextInMotion-VideoSample-1080p.mp4"
})

-- OR copy once from the game's profile, and play a video file stored in the profile's media directory
---- [volume] of 75 (1 to 100)
playVideoFile({
    name = getMudletHomeDir().. "/TextInMotion-VideoSample-1080p.mp4"
    , volume = 75
})

-- OR copy once from the local file system, and play a video file stored in the profile's media directory
---- [volume] of 75 (1 to 100)
playVideoFile({
    name = "C:/Users/Tamarindo/Movies/TextInMotion-VideoSample-1080p.mp4"
    , volume = 75
})

-- OR download once from the Internet, and play a video stored in the profile's media directory
---- [fadein] and increase the volume from 1 at the start position to default volume up until the position of 10 seconds
---- [fadeout] and decrease the volume from default volume to one, 15 seconds from the end of the video
---- [start] 5 seconds after position 0 (fadein scales its volume increase over a shorter duration, too)
---- [key] reference of "text" for stopping this unique video later
---- [tag] reference of "ambience" to stop any video later with the same tag
---- [continue] playing this video if another request for the same video comes in (false restarts it) 
---- [url] resource location where the file may be accessed on the Internet
---- [stream] download once from the Internet if the video does not exist in the profile's media directory when false (true streams from the Internet and will not download to the device) 
playVideoFile({
    name = "TextInMotion-VideoSample-1080p.mp4"
    , volume = nil -- nil lines are optional, no need to use
    , fadein = 10000
    , fadeout = 15000
    , start = 5000
    , loops = nil -- nil lines are optional, no need to use
    , key = "text"
    , tag = "ambience"
    , continue = true
    , url = "https://d2qguwbxlx1sbt.cloudfront.net/"
    , stream = false
})
---- Ordered Parameter Syntax of playVideoFile(name[,volume][,fadein][,fadeout][,loops][,key][,tag][,continue][,url][,stream]) ----

-- Stream a video file from the Internet and play it.
playVideoFile(
    "TextInMotion-VideoSample-1080p.mp4"
    , nil -- volume
    , nil -- fadein
    , nil -- fadeout
    , nil -- start
    , nil -- loops
    , nil -- key
    , nil -- tag
    , true -- continue
    , "https://d2qguwbxlx1sbt.cloudfront.net/" -- url
    , false -- stream
)

-- Play a video file from the Internet, storing it in the profile's media directory (i.e. /Users/Tamarindo/mudlet-data/profiles/StickMUD/media) so you don't need to download it over and over.
playVideoFile(
    "TextInMotion-VideoSample-1080p.mp4"
    , nil -- volume
    , nil -- fadein
    , nil -- fadeout
    , nil -- start
    , nil -- loops
    , nil -- key
    , nil -- tag
    , true -- continue
    , "https://d2qguwbxlx1sbt.cloudfront.net/" -- url
    , false -- stream
)

-- Play a video file stored in the profile's media directory (i.e. /Users/Tamarindo/mudlet-data/profiles/StickMUD/media)
playVideoFile(
    "TextInMotion-VideoSample-1080p.mp4"  -- name
)

-- OR copy once from the game's profile, and play a video file stored in the profile's media directory
---- [volume] of 75 (1 to 100)
playVideoFile(
    getMudletHomeDir().. "/TextInMotion-VideoSample-1080p.mp4" -- name
    , 75 -- volume
)

-- OR copy once from the local file system, and play a video file stored in the profile's media directory
---- [volume] of 75 (1 to 100)
playVideoFile(
    "C:/Users/Tamarindo/Documents/TextInMotion-VideoSample-1080p.mp4" -- name
    , 75 -- volume
)

-- OR download once from the Internet, and play a video stored in the profile's media directory
---- [fadein] and increase the volume from 1 at the start position to default volume up until the position of 10 seconds
---- [fadeout] and decrease the volume from default volume to one, 15 seconds from the end of the video
---- [start] 5 seconds after position 0 (fadein scales its volume increase over a shorter duration, too)
---- [key] reference of "text" for stopping this unique video later
---- [tag] reference of "ambience" to stop any video later with the same tag
---- [continue] playing this video if another request for the same video comes in (false restarts it) 
---- [url] resource location where the file may be accessed on the Internet
---- [stream] download once from the Internet if the video does not exist in the profile's media directory when false (true streams from the Internet and will not download to the device) 
playVideoFile(
    "TextInMotion-VideoSample-1080p.mp4" -- name
    , nil -- volume
    , 10000 -- fadein
    , 15000 -- fadeout
    , 5000 -- start
    , nil -- loops
    , "text" -- key
    , "ambience" -- tag
    , true -- continue
    , "https://d2qguwbxlx1sbt.cloudfront.net/" -- url
    , false -- stream
)


stopVideos, PR #6439

stopVideos(settings table)
Stop all videos (no filter), or videos that meet a combination of filters (name, key, and tag) intended to be paired with playVideoFile().
Required Key Value Purpose
No name <file name>
  • Name of the media file.
No key <key>
  • Uniquely identifies media files with a "key" that is bound to their "name" or "url".
  • Halts the play of current media files with the same "key" that have a different "name" or "url" while this media plays.
No tag <tag>
  • Helps categorize media.

See also: loadSoundFile(), loadMusicFile(), loadVideoFile(), playSoundFile(), playMusicFile(), playVideoFile(), stopSounds(), stopMusic(), createVideoPlayer(), purgeMediaCache(), Mud Client Media Protocol

Mudlet VersionAvailable in Mudlet4.??+
Example
---- Table Parameter Syntax ----

-- Stop all playing video files for this profile associated with the API
stopVideos()

-- Stop playing the text mp4 by name
stopVideos({name = "TextInMotion-VideoSample-1080p.mp4"})

-- Stop playing the unique sound identified as "text"
stopVideos({
    name = nil  -- nil lines are optional, no need to use
    , key = "text" -- key
    , tag = nil  -- nil lines are optional, no need to use
})
---- Ordered Parameter Syntax of stopVideos([name][,key][,tag]) ----

-- Stop all playing video files for this profile associated with the API
stopVideos()

-- Stop playing the text mp4 by name
stopVideos("TextInMotion-VideoSample-1080p.mp4")

-- Stop playing the unique sound identified as "text"
stopVideos(
    nil -- name
    , "text" -- key
    , nil -- tag
)


getCustomLoginTextId, PR #3952 open

getCustomLoginTextId()

Returns the Id number of the custom login text setting from the profile's preferences. Returns 0 if the option is disabled or a number greater than that for the item in the table; note it is possible if using an old saved profile in the future that the number might be higher than expected. As a design policy decision it is not permitted for a script to change the setting, this function is intended to allow a script or package to check that the setting is what it expects.

Introduced along with four other functions to enable game server log-in to be scripted with the simultaneous movement of that functionality from the Mudlet application core code to a predefined doLogin() function, a replacement for which is shown below.

See also: getCharacterName(), sendCharacterName(), sendCustomLoginText(), sendPassword().

Note Note: Not available yet. See https://github.com/Mudlet/Mudlet/pull/3952

Only one custom login text has been defined initially:

Predefined custom login texts
Id Custom text Introduced in Mudlet version
1 "connect {character name} {password}" TBD

The addition of further texts would be subject to negotiation with the Mudlet Makers.

Example
-- A replacement for the default function placed into LuaGlobal.lua to reproduce the previous behavior of the Mudlet application:
function doLogin()
  if getCustomLoginTextId() ~= 1 then
    -- We need this particular option but it is not permitted for a script to change the setting, it can only check what it is
    echo("\nUnable to login - please select the 'connect {character name} {password}` custom login option in the profile preferences.\n")
  else
    tempTime(2.0, [[sendCustomLoginText()]], 1)
  end
end

sendCharacterName, PR #3952 open

sendCharacterName()

Sends the name entered into the "Character name" field on the Connection Preferences form directly to the game server. Returns true unless there is nothing set in that entry in which case a nil and an error message will be returned instead.

Introduced along with four other functions to enable game server log-in to be scripted with the simultaneous movement of that functionality from the Mudlet application core code to a predefined doLogin() function that may be replaced for more sophisticated requirements.

See also: getCharacterName(), sendCharacterPassword(), sendCustomLoginText(), getCustomLoginTextId().

Note Note: Not available yet. See https://github.com/Mudlet/Mudlet/pull/3952

sendCharacterPassword, PR #3952 open

sendCharacterPassword()

Sends the password entered into the "Password" field on the Connection Preferences form directly to the game server. Returns true unless there is nothing set in that entry or it is too long after (or before) a connection was successfully made in which case a nil and an error message will be returned instead.

Introduced along with four other functions to enable game server log-in to be scripted with the simultaneous movement of that functionality from the Mudlet application core code to a predefined doLogin() function, reproduced below, that may be replaced for more sophisticated requirements.

See also: getCharacterName(), sendCustomLoginText(), getCustomLoginTextId(), sendCharacterName().

Note Note: Not available yet. See https://github.com/Mudlet/Mudlet/pull/3952

Example
-- The default function placed into LuaGlobal.lua to reproduce the previous behavior of the Mudlet application:
function doLogin()
  if getCharacterName() ~= "" then
    tempTime(2.0, [[sendCharacterName()]], 1)
    tempTime(3.0, [[sendCharacterPassword()]], 1)
  end
end

sendCustomLoginText, PR #3952 open

sendCustomLoginText()

Sends the custom login text (which does NOT depend on the user's choice of GUI language) selected in the preferences for this profile. The {password} (and {character name} if present) fields will be replaced with the values entered into the "Password" and "Character name" fields on the Connection Preferences form and then sent directly to the game server. Returns true unless there is nothing set in either of those entries (though only if required for the character name) or it is too long after (or before) a connection was successfully made or if the custom login feature is disabled, in which case a nil and an error message will be returned instead.

Introduced along with four other functions to enable game server log-in to be scripted with the simultaneous movement of that functionality from the Mudlet application core code to a predefined doLogin() function, a replacement for which is shown below.

See also: getCharacterName(), sendCharacterName(), sendPassword(), getCustomLoginTextId().

Note Note: Not available yet. See https://github.com/Mudlet/Mudlet/pull/3952

Only one custom login text has been defined initially:

Predefined custom login texts
Id Custom text Introduced in Mudlet version
1 "connect {character name} {password}" TBD

The addition of further texts would be subject to negotiation with the Mudlet Makers.

Example
-- A replacement for the default function placed into LuaGlobal.lua to reproduce the previous behavior of the Mudlet application:
function doLogin()
  if getCustomLoginTextId() ~= 1 then
    -- We need this particular option but it is not permitted for a script to change the setting, it can only check what it is
    echo("\nUnable to login - please select the 'connect {character name} {password}` custom login option in the profile preferences.\n")
  else
    tempTime(2.0, [[sendCustomLoginText()]], 1)
  end
end

Mudlet Object Functions

A collection of functions that manipulate Mudlet's scripting objects - triggers, aliases, and so forth.

ancestors, new in PR #6726

ancestors(IDnumber, type)
You can use this function to find out about all the ancestors of something.
Returns a list as a table with the details of each successively distance ancestor (if any) of the given item; the details are in the form of a sub-table, within each containing specifically:
  • its IDnumber as a number
  • its name as a string
  • whether it is active as a boolean
  • its "node" (type) as a string, one of "item", "group" (folder) or "package" (module)
Returns nil and an error message if either parameter is not valid
Parameters
  • IDnumber:
The ID number of a single item, (which will be that returned by a temp* or perm* function to create such an item to identify the item).
  • type:
The type can be 'alias', 'button', 'trigger', 'timer', 'keybind', or 'script'.
See also: isAncestorsActive(...), isActive(...)
Example
-- To do

findItems, new in PR #6742

findItems("name", "type"[, exact[, case sensitive]])
You can use this function to determine the ID number or numbers of items of a particular type with a given name.
Returns a list as a table with ids of each Mudlet item that matched or nil and an error message should an incorrect type string be given.
Parameters
  • name:
The name (as a string) of the item, (which will be that returned by a temp* or perm* function to create such an item to identify the item).
  • type:
The type (as a string) can be 'alias', 'button', 'trigger', 'timer', 'keybind' , or 'script'.
  • exact:
(Optional) a boolean which if omitted or true specifies to match the given name against the whole of the names for items or only as a sub-string of them. As a side effect, if this is provided and is false and an empty string (i.e. "") is given as the first argument then the function will return the ID numbers of all items (both temporary and permanent) of the given type in existence at the time.
  • case sensitive:
(Optional) a boolean which if omitted or true specifies to match in a case-sensitive manner the given name against the names for items.
Example

Given a profile with just the default packages installed (automatically) - including the echo one:

View of standard aliases with focus on echo package.png
-- Should find just the package with the name:
lua findItems("echo", "alias")
{ 3 }

-- Should find both the package and the alias - as the latter contains "echo" with another character
lua findItems("echo", "alias", false)
{ 3, 4 }

-- Finds the ID numbers of all the aliases:
lua findItems("", "alias", false)
{ 1, 2, 3, 4, 5, 6, 7 }

-- Will still find the package with the name "echo" as we are not concerned with the casing now:
lua findItems("Echo", "alias", true, false)
{ 3 }

-- Won't find the package with the name "echo" now as we are concerned with the casing:
lua findItems("Echo", "alias", true, true)
{}

getExitStubsNames, new in PR #7519

table = getExitStubsNames(roomid)
Returns a table of directions that have an exit stub marked in them. Returns nil plus error message of called on a non-existent room.
See also: setExitStub(), connectExitStub(), getExitStubs(), getExitStubs1()
Example
-- show the exit stubs in room 6 as direction names
local directions = getExitStubsNames(6)
for i = 1, #directions do print(directions[i]) end
-- will return a table such as 
{ "north", "south", "up", "in" }

getProfiles, new in PR #7423

getProfiles()
Return a table containing some basic information about the game profiles available to Mudlet. The key is the profile name and values can be host, port, loaded, and connected.
  • host is the hostname or IP of the server
  • port is the port of the server
  • loaded means the profile is open and can be edited, true if loaded, false otherwise
  • connected means the profile is connected to the game server (ie. playing), true if connected, false or nil otherwise
Example
local profiles = getProfiles()
display(profiles)

--output
{
  ["Abandoned Realms"] = {
    host = "abandonedrealms.com",
    loaded = false,
    port = "9000"
  },
  FieryMUD = {
    connected = true,
    host = "fierymud.org",
    loaded = true,
    port = "4000"
  }
 }

isActive, modified by PR #6726

isActive(name/IDnumber, type[, checkAncestors])
You can use this function to check if something, or somethings, are active.
Returns the number of active things - and 0 if none are active. Beware that all numbers are true in Lua, including zero.
Parameters
  • name:
The name (as a string) or, from Mudlet 4.17.0, the ID number of a single item, (which will be that returned by a temp* or perm* function to create such an item to identify the item).
  • type:
The type can be 'alias', 'button' (from Mudlet 4.10), 'trigger', 'timer', 'keybind' (from Mudlet 3.2), or 'script' (from Mudlet 3.17).
  • checkAncestors:
(Optional) If provided AND true (considered false if absent to reproduce behavior of previous versions of Mudlet) then this function will only count an item as active if it and all its parents (ancestors) are active (from Mudlet tbd).
See also: exists(...), isAncestorsActive(...), ancestors(...)
Example
echo("I have " .. isActive("my trigger", "trigger") .. " currently active trigger(s) called 'my trigger'!")

-- Can also be used to check if a specific item is enabled or not.
if isActive("spellname", "trigger") > 0 then
  -- the spellname trigger is active
else
  -- it is not active
end

Note Note: A positive ID number that does not exist will still return a 0 value, this is for constancy with the way the function behaves for a name that does not refer to any item either. If necessary the existence of an item should be confirmed with exists(...) first.

isAncestorsActive, new in PR #6726

isAncestorsActive(IDnumber, "type")
You can use this function to check if all the ancestors of something are active independent of whether it itself is, (for that use the two argument form of isActive(...)).
Returns true if all (if any) of the ancestors of the item with the specified ID number and type are active, if there are no such parents then it will also returns true; otherwise returns false. In the event that an invalid type string or item number is provided returns nil and an error message.
Parameters
  • IDnumber:
The ID number of a single item, (which will be that returned by a temp* or perm* function to create such an item to identify the item).
  • type:
The type can be 'alias', 'button', 'trigger', 'timer', 'keybind' or 'script' to define which item type is to be checked.
See also: exists(...)
Example
-- To do

loadProfile, new in PR #7423

loadProfile(name, offline)
Load a profile, same as clicking the profile icon in the Profile Manager.
Returns nil and an error message if either parameter is not valid.
Parameters
  • name:
The profile name to open, as identified in the Profile Manager.
  • offline:
true - load the profile but do not connect to the game, false - load the profile and connect to the game
Example
-- load and connect to the Archaea profile
loadProfile("Archaea", false)

clearProfileInformation(), new in PR #7511

clearProfileInformation(text)
Clears the information text as displayed in the Profile Connection Window. If this is a prepackaged game the text is reverted to the default text.
See also: getProfileInformation(), setProfileInformation()
Example
clearProfileInformation()

getProfileInformation(), new in PR #7511

getProfileInformation()
Return a string containing the information text as displayed in the Profile Connection Window.
See also: clearProfileInformation(), setProfileInformation()
Example
echo(getProfileInformation())

setProfileInformation(), new in PR #7511

setProfileInformation(text)
Set the information text as displayed in the Profile Connection Window. Returns nil and an error messages if no string is supplied.
See also: clearProfileInformation(), getProfileInformation()
Example
setProfileInformation("Elf warrior, lvl 15")

Networking Functions

A collection of functions for managing networking.

sendSocket revised in PR #7066 (Open)

sendSocket(data)
Sends given binary data as-is (or with some predefined special tokens converted to byte values) to the game. You can use this to implement support for a new telnet protocol, simultronics login etc.
success = sendSocket("data")
See also
feedTelnet(), feedTriggers()

Note Note: Modified in Mudlet tbd to accept some tokens like "<NUL>" to include byte values that are not possible to insert with the standard Lua string escape "\###" form where ### is a three digit number between 000 and 255 inclusive or where the value is more easily provided via a mnemonic. For the table of the tokens that are known about, see the one in feedTelnet().

Note Note: The data (as bytes) once the tokens have been converted to their byte values is sent as is to the Game Server; any encoding to, say, a UTF-8 representation or to duplicate 0xff byte values so they are not considered to be Telnet <IAC> (Interpret As Command) bytes must be done to the data prior to calling this function.

Parameters
  • data:
String containing the bytes to send to the Game Server possibly containing some tokens that are to be converted to bytes as well.
Returns
  • (Only since Mudlet tbd) Boolean true if the whole data string (after token replacement) was sent to the Server, false if that failed for any reason (including if the Server has not been connected or is now disconnected). nil and an error message for any other defect.
Example
-- Tell the Server that we are now willing and able to process  to process Ask the Server to a comment explaining what is going on, if there is multiple functionalities (or optional parameters) the examples should start simple and progress in complexity if needed!
-- the examples should be small, but self-contained so new users can copy & paste immediately without going diving in lots other function examples first.
-- comments up top should introduce / explain what it does

local something = function(exampleValue)
if something then
  -- do something with something (assuming there is a meaningful return value)
end

-- maybe another example for the optional second case
local somethingElse = function(exampleValue, anotherValue)

-- lastly, include an example with error handling to give an idea of good practice
local ok, err = function()
if not ok then
  debugc(f"Error: unable to do <particular thing> because {err}\n")
  return
end
Additional development notes

-- This function is still being written up.

feedTelnet added in PR #7066 (Open)==

feedTelnet(data)
Sends given binary data with some predefined special tokens converted to byte values, to the internal telnet engine, as if it had been received from the game. This is primarily to enable testing when new Telnet sub-options/protocols are being developed. The data has to be injected into the system nearer to the point where the Game Server's data starts out than feedTriggers() and unlike the latter the data is not subject to any encoding so as to match the current profile's setting (which normally happens with feedTriggers()). Furthermore - to prevent this function from putting the telnet engine into a state which could damage the processing of real game data it will refuse to work unless the Profile is completely disconnected from the game server.
See also
feedTriggers(), sendSocket()
Mudlet VersionAvailable in Mudlettbd+

Note Note: This is not really intended for end-user's but might be useful in some circumstances.

Parameters
  • data
String containing the bytes to send to the internal telnet engine as if it had come from the Game Server, it can containing some tokens listed below that are to be converted to bytes as well.
Returns
  • Boolean true if the data string was sent to the internal telnet engine. nil and an error message otherwise, specifically the case when there is some traces of a connection or a complete connection to the socket that passes the data to and from the game server. Additionally, if the data is an empty string "" a second return value will be provided as an integer number representing a version for the table of tokens - which will be incremented each time a change is made to that table so that which tokens are valid can be determined. Note that unrecognised tokens should be passed through as is and not get replaced.
Token value table
Token Byte Version Notes
<00> \0x00 1 0 dec.
<O_BINARY> \0x00 1 Telnet option: Binary
<NUL> \0x00 1 ASCII control character: NULL
<01> \x01 1 1 dec.
<O_ECHO> \x01 1 Telnet option: Echo
<SOH> \x01 1 ASCII control character: Start of Heading
<02> \x02 1 2 dec. Telnet option: Reconnect
<STX> \x02 1 ASCII control character: Start of Text
<03> \x03 1 3 dec.
<O_SGA> \x03 1 Telnet option: Suppress Go Ahead
<ETX> \x03 1 ASCII control character: End of Text
<04> \x04 1 Telnet option: Approx Message Size Negotiation
<EOT> \x04 1 ASCII control character: End of Transmission
<05> \x05 1
<O_STATUS> \x05 1
<ENQ> \x05 1 ASCII control character: Enquiry
<06> \x06 1 Telnet option: Timing Mark
<ACK> \x06 1 ASCII control character: Acknowledge
<07> \x07 1 Telnet option: Remote Controlled Trans and Echo
<BELL> \x07 1 ASCII control character: Bell
<08> \x08 1 Telnet option: Output Line Width
<BS> \x08 1
<09> \x09 1 Telnet option: Output Page Size
<HTAB> \x09 1 ASCII control character: Horizontal Tab
<0A> \x0a 1 Telnet option: Output Carriage-Return Disposition
<LF> \x0a 1 ASCII control character: Line-Feed
<0B> \x0b 1 Telnet option: Output Horizontal Tab Stops
<VTAB> \x0b 1 ASCII control character: Vertical Tab
<0C> \x0c 1 Telnet option: Output Horizontal Tab Disposition
<FF> \x0c 1 ASCII control character: Form-Feed
<0D> \x0d 1 Telnet option: Output Form-feed Disposition
<CR> \x0d 1 ASCII control character: Carriage-Return
<0E> \x0e 1 Telnet option: Output Vertical Tab Stops
<SO> \x0e 1 ASCII control character: Shift-Out
<0F> \x0f 1 Telnet option: Output Vertical Tab Disposition
<SI> \x0f 1 ASCII control character: Shift-In
<10> \x10 1 Telnet option: Output Linefeed Disposition
<DLE> \x10 1 ASCII control character: Data Link Escape
<11> \x11 1 Telnet option: Extended ASCII
<DC1> \x11 1 ASCII control character: Device Control 1
<12> \x12 1 Telnet option: Logout
<DC2" \x12 1 ASCII control character: Device Control 2
<13> \x13 1 Telnet option: Byte Macro
<DC3> \x13 1 ASCII control character: Device Control 3
<14> \x14 1 Telnet option: Data Entry Terminal
<DC4> \x14 1 ASCII control character: Device Control 4
<15> \x15 1 Telnet option: SUPDUP
<NAK> \x15 1 ASCII control character: Negative Acknowledge
<16> \x16 1 Telnet option: SUPDUP Output
<SYN> \x16 1 ASCII control character: Synchronous Idle
<17> \x17 1 Telnet option: Send location
<ETB> \x17 1 ASCII control character: End of Transmission Block
<18> \x18 1
<O_TERM> \x18 1 Telnet option: Terminal Type
<CAN> \x18 1 ASCII control character: Cancel
<19> \x19 1
<O_EOR> \x19 1 Telnet option: End-of-Record
<EM> \x19 1 ASCII control character: End of Medium
<1A> \x1a 1 Telnet option: TACACS User Identification
<SUB> \x1a 1 ASCII control character: Substitute
<1B> \x1b 1 Telnet option: Output Marking
<ESC> \x1b 1 ASCII control character: Escape
<1C> \x1c 1 Telnet option: Terminal Location Number
<FS> \x1c 1 ASCII control character: File Separator
<1D> \x1d 1 Telnet option: Telnet 3270 Regime
<GS> \x1d 1 ASCII control character: Group Separator
<1E> \x1e 1 Telnet option: X.3 PAD
<RS> \x1e 1 ASCII control character: Record Separator
<1F> \x1f 1
<O_NAWS> \x1f 1 Telnet option: Negotiate About Window Size
<US> \x1f 1 ASCII control character: Unit Separator
<SP> \x20 1 32 dec. ASCII character: Space
<O_NENV> \x27 1 39 dec. Telnet option: New Environment (also MNES)
<O_CHARS> \x2a 1 42 dec. Telnet option: Character Set
<O_KERMIT> \x2f 1 47 dec. Telnet option: Kermit
<O_MSDP> \x45 1 69 dec. Telnet option: Mud Server Data Protocol
<O_MSSP> \x46 1 70 dec. Telnet option: Mud Server Status Protocol
<O_MCCP> \x55 1 85 dec
<O_MCCP2> \x56 1 86 dec
<O_MSP> \x5a 1 90 dec. Telnet option: Mud Sound Protocol
<O_MXP> \x5b 1 91 dec. Telnet option: Mud eXtension Protocol
<O_ZENITH> \x5d 1 93 dec. Telnet option: Zenith Mud Protocol
<O_AARDWULF> \x66 1 102 dec. Telnet option: Aardwuld Data Protocol
<DEL> \x7f 1 127 dec. ASCII control character: Delete
<O_ATCP> \xc8 1 200 dec
<O_GMCP> \xc9 1 201 dec
<T_EOR> \xef 1 239 dec
<F0> \xf0 1
<T_SE> \xf0 1
<F1> \xf1 1
<T_NOP> \xf1 1
<F2> \xf2 1
<T_DM> \xf2 1
<F3> \xf3 1
<T_BRK> \xf3 1
<F4> \xf4 1
<T_IP> \xf4 1
<F5> \xf5 1
<T_ABOP> \xf5 1
<F6> \xf6 1
<T_AYT> \xf6 1
<F7> \xf7 1
<T_EC> \xf7 1
<F8> \xf8 1
<T_EL> \xf8 1
<F9> \xf9 1
<T_GA> \xf9 1
<FA> \xfa 1
<T_SB> \xfa 1
<FB> \xfb 1
<T_WILL> \xfb 1
<FC> \xfc 1
<T_WONT> \xfc 1
<FD> \xfd 1
<T_DO> \xfd 1
<FE> \xfe 1
<T_DONT> \xfe 1
<FF> \xff 1
<T_IAC> \xff'
Example
-- a comment explaining what is going on, if there is multiple functionalities (or optional parameters) the examples should start simple and progress in complexity if needed!
-- the examples should be small, but self-contained so new users can copy & paste immediately without going diving in lots other function examples first.
-- comments up top should introduce / explain what it does

local something = feedTelnet(exampleValue)
if something then
  -- do something with something (assuming there is a meaningful return value)
end

-- maybe another example for the optional second case
local somethingElse = function(exampleValue, anotherValue)

-- lastly, include an example with error handling to give an idea of good practice
local ok, err = function()
if not ok then
  debugc(f"Error: unable to do <particular thing> because {err}\n")
  return
end
Additional development notes

-- This function is still being written up.

String Functions

These functions are used to manipulate strings.

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.

Text to Speech Functions

These functions are used to create sound from written words. Check out our Text-To-Speech Manual for more detail on how this all works together.

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.

cecho2decho PR#6849 merged

convertedString = cecho2decho(str)
Converts a cecho formatted string to a decho formatted one.
See also
decho2cecho(), cecho2html()
Mudlet VersionAvailable in Mudlet4.18+
Parameters
  • str
string you wish to convert from cecho to decho
Returns
  • a string formatted for decho
Example
-- convert to a decho string and use decho to display it
local cechoString = "<red><b>!!ALERT!!:</b><orange> Something has gone wrong!\n"
decho(cecho2decho(cechoString))

cecho2hecho PR#6849 merged

convertedString = cecho2hecho(str)
Converts a cecho formatted string to an hecho formatted one.
See also
hecho2cecho(), cecho2html()
Mudlet VersionAvailable in Mudlet4.18+
Parameters
  • str
string you wish to convert from cecho to decho
Returns
  • a string formatted for hecho
Example
-- convert to an hecho string and use hecho to display it
local cechoString = "<red><b>!!ALERT!!:</b><orange> Something has gone wrong!\n"
hecho(cecho2hecho(cechoString))

cecho2html PR#6849 merged

convertedString = cecho2html(str[, resetFormat])
Converts a cecho formatted string to an html formatted one.
See also
decho2cecho(), cecho2html()
Mudlet VersionAvailable in Mudlet4.18+
Parameters
  • str
string you wish to convert from cecho to decho
  • resetFormat
optional table of default formatting options. As returned by getLabelFormat()
Returns
  • a string formatted for html
Example
-- create the base string
local cechoString = "<red><b>!!ALERT!!:</b><orange> Something has gone wrong!\n"

-- create a label to display the result onto
testLabel = Geyser.Label:new({name = "testLabel"})

-- convert the cecho string to an html one, using the default formatting of testLabel created above
local htmlString = cecho2html(cechoString, testLabel:getFormat())

-- and finally echo it to the label to see
-- I use rawEcho as that displays the html exactly as given.
testLabel:rawEcho(htmlString)

decho2cecho PR#6849 merged

convertedString = decho2cecho(str)
Converts a decho formatted string to a cecho formatted one.
See also
cecho2decho(), decho2html()
Mudlet VersionAvailable in Mudlet4.18+
Parameters
  • str
string you wish to convert from decho to cecho
Returns
  • a string formatted for cecho
Example
-- convert to a decho string and use cecho to display it
local dechoString = "#ff0000#b!!ALERT!!:#/b#ffa500 Something has gone wrong!\n"
cecho(decho2cecho(dechoString))

decho2hecho PR#6849 merged

convertedString = decho2hecho(str)
Converts a decho formatted string to an hecho formatted one.
See also
hecho2decho(), decho2html()
Mudlet VersionAvailable in Mudlet4.18+
Parameters
  • str
string you wish to convert from decho to decho
Returns
  • a string formatted for hecho
Example
-- convert to an hecho string and use hecho to display it
local dechoString = "#ff0000#b!!ALERT!!:#/b#ffa500 Something has gone wrong!\n"
hecho(decho2hecho(dechoString))

decho2html PR#6849 merged

convertedString = decho2html(str[, resetFormat])
Converts a decho formatted string to an html formatted one.
See also
cecho2decho(), decho2html()
Mudlet VersionAvailable in Mudlet4.18+
Parameters
  • str
string you wish to convert from decho to decho
  • resetFormat
optional table of default formatting options. As returned by getLabelFormat()
Returns
  • a string formatted for html
Example
-- create the base string
local dechoString = "#ff0000#b!!ALERT!!:#/b#ffa500 Something has gone wrong!\n"

-- create a label to display the result onto
testLabel = Geyser.Label:new({name = "testLabel"})

-- convert the decho string to an html one, using the default formatting of testLabel created above
local htmlString = decho2html(dechoString, testLabel:getFormat())

-- and finally echo it to the label to see
-- I use rawEcho as that displays the html exactly as given.
testLabel:rawEcho(htmlString)

deleteMultiline PR #6779 merged

ok,err = deleteMultiline([triggerDelta])
Deletes all lines between when the multiline trigger fires and when the first trigger matched. Put another way, it deletes everything since the pattern in slot 1 matched.
See also
deleteLine(), replaceLine()
Mudlet VersionAvailable in Mudlet4.18+

Note Note: This deletes all the lines since the first match of the multiline trigger matched. Do not use this if you do not want to delete ALL of those lines.

Parameters
  • [optional]triggerDelta:
The line delta from the multiline trigger it is being called from. It is best to pass this in to ensure all lines are caught. If not given it will try to guess based on the number of patterns how many lines at most it might have to delete.
Returns
  • true if the function was able to run successfully, nil+error if something went wrong.
Example
-- if this trigger has a line delta of 3, you would call
deleteMultiline(3)

-- same thing, but with error handling
local ok,err = deleteMultiline(3)
if not ok then
  cecho("\n<firebrick>I could not delete the lines because: " .. err)
end
Additional development notes

echoPopup, revised in PR #6946

echoPopup([windowName,] text, {commands}, {hints}[, useCurrentFormatElseDefault])
Creates text with a left-clickable link, and a right-click menu for more options at the end of the current line, like echo. The added text, upon being left-clicked, will do the first command in the list. Upon being right-clicked, it'll display a menu with all possible commands. The menu will be populated with hints, one for each line; if there is one extra hint then the first one will be used as a (maybe containing Qt rich-text markup) tool-tip for the text otherwise the remaining hints will be concatenated, one-per-line, as a tool-tip when the text is hovered over by the pointer.
Parameters
  • windowName:
(optional) name of the window as a string to echo to. Use either main or omit for the main window, or the miniconsole's or user-window's name otherwise.
  • text:
the text string to display.
  • {commands}:
a table of lua code to do, in text strings or as functions (since Mudlet 4.11), i.e. {[[send("hello")]], function() echo("hi!") end}.
  • {hints}:
a table of strings which will be shown on the right-click menu and as a tool-tip for the text. If the number is the same as that of the commands table then they all will be used for the right-click menu and listed (one per line) as a plain text tooltip; alternatively if there is one extra in number than the commands table the first will be used purely for the tool tip and the remainder will be used for the right-click menu. This additional entry may be formatted as Qt style "rich-text" (in the same manner as labels elsewhere in the GUI).
  • If a particular position in the commands table is an empty string "" but there is something in the hints table then it will be listed in the right-click menu but as it does not do anything it will be shown greyed-out i.e. disabled and will not be clickable.
  • If a particular position in both the commands and the hints table are empty strings "" then this item will show as a separator (usually as a horizontal-line) in the right-click menu and it will not be clickable/do anything.
  • useCurrentFormatElseDefault:
(optional) a boolean value for using either the current formatting options (color, underline, italic and other effects) if true or the link default (blue underline) if false, if omitted the default format is used.
Example
-- Create some text as a clickable with a popup menu, a left click will ''send "sleep"'':
echoPopup("activities to do", {function() send "sleep" end, function() send "sit" end, function() send "stand" end}, {"sleep", "sit", "stand"})

-- alternatively, put commands as text (in [[ and ]] to use quotation marks inside)
echoPopup("activities to do", {[[send "sleep"]], [[send "sit"]], [[send "stand"]]}, {"sleep", "sit", "stand"})

-- one can also provide helpful information

-- todo: an example with rich-text in the tool-tips(s) - not complete yet!
echoPopup("Fancy popup", {[[echo("Doing command 1 (default one)")]], "", "", [[echo("Doing command 3")]], [[echo("Doing another command (number 4)"]], [[echo("Doing another command (number 5)"]])}, {"<p>This tooltip has HTML type tags in/around it, and it will get word-wrapped automatically to fit into a reasonable rectangle.</p><p><b>Plus</b> it can have those HTML like <i>effects</i> and be easily formatted into more than one paragraph and with <span style=\"color:cyan\">bits</span> in <span style=\"color:lime\">different</span> colors!</p><p>This example also demonstrates how to produce disabled menu (right-click) items, how to insert separators and how it now will handle multiple items with the same hint (prior to PR 6945 such duplicates will all run the command associated with the last one!) If the first command/function is an empty string then clicking on the text will have no effect, but hovering the mouse over the text will still produce the tooltip, this could be useful to display extra information about the text without doing anything by default.</p>", "Command 1 (default)", "", "Command 2 (disabled)", "Command 3", "Another command", "Another command"}, true)
echo(" remaining text.\n")

hecho2cecho PR#6849 merged

convertedString = hecho2cecho(str)
Converts a hecho formatted string to a cecho formatted one.
See also
cecho2decho(), hecho2html()
Mudlet VersionAvailable in Mudlet4.18+
Parameters
  • str
string you wish to convert from hecho to cecho
Returns
  • a string formatted for cecho
Example
-- convert to a hecho string and use cecho to display it
local hechoString = "#ff0000#b!!ALERT!!:#/b#ffa500 Something has gone wrong!\n""
cecho(hecho2cecho(hechoString))

hecho2decho PR#6849 merged

convertedString = hecho2decho(str)
Converts a hecho formatted string to a decho formatted one.
See also
decho2hecho(), hecho2html()
Mudlet VersionAvailable in Mudlet4.18+
Parameters
  • str
string you wish to convert from hecho to decho
Returns
  • a string formatted for decho
Example
-- convert to a decho string and use decho to display it
local hechoString = "#ff0000#b!!ALERT!!:#/b#ffa500 Something has gone wrong!\n""
decho(hecho2decho(hechoString))

hecho2html PR#6849 merged

convertedString = hecho2html(str[, resetFormat])
Converts a hecho formatted string to an html formatted one.
See also
cecho2hecho(), hecho2html()
Mudlet VersionAvailable in Mudlet4.18+
Parameters
  • str
string you wish to convert from hecho to hecho
  • resetFormat
optional table of default formatting options. As returned by getLabelFormat()
Returns
  • a string formatted for html
Example
-- create the base string
local hechoString = "#ff0000#b!!ALERT!!:#/b#ffa500 Something has gone wrong!\n""

-- create a label to display the result onto
testLabel = Geyser.Label:new({name = "testLabel"})

-- convert the hecho string to an html one, using the default formatting of testLabel created above
local htmlString = hecho2html(hechoString, testLabel:getFormat())

-- and finally echo it to the label to see
-- I use rawEcho as that displays the html exactly as given.
testLabel:rawEcho(htmlString)

insertPopup, revised in PR #6925

insertPopup([windowName], text, {commands}, {hints}[{, tool-tips}][, useCurrentFormatElseDefault])
Creates text with a left-clickable link, and a right-click menu for more options at the end of the current line, like echo. The added text, upon being left-clicked, will do the first command in the list. Upon being right-clicked, it'll display a menu with all possible commands. The menu will be populated with hints, one for each line; if a tool-tips table is not provided the same hints will also be listed one-per-line as a tool-tip but if a matching number of tool-tips are provided they will be concatenated to provide a tool-tip when the text is hovered over by the pointer - these tool-tips can be rich-text to produce information formatted with additional content in the same manner as labels.
Parameters
  • windowName:
(optional) name of the window as a string to echo to. Use either main or omit for the main window, or the miniconsole's or user-window's name otherwise.
  • text:
the text string to display.
  • {commands}:
a table of lua code to do, in text strings or as functions (since Mudlet 4.11), i.e. {[[send("hello")]], function() echo("hi!") end}.
  • {hints}:
a table of strings which will be shown on the right-click menu (and popup if no {tool-tips} table is provided). If a particular position in both the commands and hints table are both the empty string "" but there is something in the tool-tips table, no entry for that position will be made in the context menu but the tool-tip can still display something which can include images or text.
  • {tool-tips}:
(optional) a table of possibly rich-text strings which will be shown on the popup if provided.
  • useCurrentFormatElseDefault:
(optional) a boolean value for using either the current formatting options (color, underline, italic and other effects) if true or the link default (blue underline) if false, if omitted the default format is used.

Note Note: Mudlet will distinguish between the optional tool-tips and the flag to switch between the standard link and the current text format by examining the type of the argument, as such this pair of arguments can be in either order.

Example
-- Create some text as a clickable with a popup menu, a left click will ''send "sleep"'':
insertPopup("activities to do", {function() send "sleep" end, function() send "sit" end, function() send "stand" end}, {"sleep", "sit", "stand"})

-- alternatively, put commands as text (in [[ and ]] to use quotation marks inside)
insertPopup("activities to do", {[[send "sleep"]], [[send "sit"]], [[send "stand"]]}, {"sleep", "sit", "stand"})

-- one can also provide helpful information

-- todo: an example with rich-text in the tool-tips(s)

Discord Functions

All functions 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 Discord scripting overview.

Mud Client Media Protocol

All GMCP functions to send sound and music events. For an overview on how all of these functions tie in together, see our MUD Client Media Protocol scripting overview.

Supported Protocols

Events

New or revised events that Mudlet can raise to inform a profile about changes. See Mudlet-raised events for the existing ones.

sysSettingChanged, PR #7476

This event is raised when a Preferences or Mudlet setting has changed. The first argument contains the setting that was changed, further arguments detail the change.

Currently implemented sysSettingChanged events are;

  • "main window font" - raised when the main window/console font has changed via API or Preferences window. Returns two additional arguments, the font family and the font size. e.g. {"main window font", "Times New Roman", 12 }
Mudlet VersionAvailable in Mudlet ?.??+

Note Note: pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/7476

sysMapAreaChanged, PR #6615

Raised when the area being viewed in the mapper is changed, either by the player-room being set to a new area or the user selecting a different area in the area selection combo-box in the mapper controls area. Returns two additional arguments being the areaID of the area being switched to and then the one for the area that is being left.

Mudlet VersionAvailable in Mudlet ?.??+

Note Note: pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/6615

sysMapWindowMousePressEvent, PR #6962

Raised when the mouse is left-clicked on the mapper window.

Mudlet VersionAvailable in Mudlet ?.??+

Note Note: pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/6962

sysWindowOverflowEvent, PR #6872

Raised when the content in a mini-console/user window that has been set to be non-scrolling (see: enableScrolling(...) and 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.

Mudlet VersionAvailable in Mudlet ?.??+

Note Note: pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/6872 and https://github.com/Mudlet/Mudlet/pull/6848 for the Lua API functions (that also need documenting).

Retrieved from "https://wiki.mudlet.org/index.php?title=Area_51&oldid=22127"