Difference between revisions of "Area 51"
(29 intermediate revisions by 4 users not shown) | |||
Line 28: | Line 28: | ||
=Mapper Functions= | =Mapper Functions= | ||
: 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== | ==mapSymbolFontInfo, PR #4038 closed== | ||
Line 192: | Line 176: | ||
: Miscellaneous functions. | : Miscellaneous functions. | ||
− | == | + | ==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}} 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. | |
− | + | {{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: [[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]] | |
− | |||
− | |||
− | |||
− | : | ||
− | |||
− | : | ||
− | + | {{MudletVersion|4.??}} | |
− | |||
;Example | ;Example | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
− | + | -- 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", | |
− | </syntaxhighlight> | + | 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" | ||
− | ! Required | + | !Required |
− | ! Key | + | !Key |
− | ! Value | + | !Value |
− | + | ! style="text-align:left;" |Purpose | |
− | ! style="text-align:left;"| Purpose | + | |- style="color: green;" |
− | |- | + | | style="text-align:center;" |Yes |
− | | style="text-align:center;"| | + | |name |
− | | name | + | |<file name> |
− | | <file name> | + | | style="text-align:left;" | |
− | + | *Name of the media file. | |
− | | style="text-align:left;"| | + | *May contain directory information (i.e. weather/maelstrom.mp4). |
− | * Name of the media file. | + | *May be part of the profile (i.e. getMudletHomeDir().. "/congratulations.mp4") |
− | |- | + | *May be on the local device (i.e. "C:/Users/YourNameHere/Movies/nevergoingtogiveyouup.mp4") |
− | | style="text-align:center;" | | + | |- style="color: blue;" |
− | | | + | | style="text-align:center;" |Maybe |
− | |< | + | |url |
− | + | |<url> | |
| style="text-align:left;" | | | style="text-align:left;" | | ||
− | * | + | *Resource location where the media file may be downloaded. |
− | + | *Only required if file to load is not part of the profile or on the local file system. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | * | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
|} | |} | ||
− | See also: [[Manual:Miscellaneous_Functions#loadMusicFile|loadMusicFile()]], [[Manual: | + | 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]] |
− | {{MudletVersion|4. | + | {{MudletVersion|4.??}} |
;Example | ;Example | ||
Line 276: | Line 243: | ||
---- Table Parameter Syntax ---- | ---- Table Parameter Syntax ---- | ||
− | -- | + | -- Download from the Internet |
− | + | loadVideoFile({ | |
+ | name = "TextInMotion-VideoSample-1080p.mp4" | ||
+ | , url = "https://d2qguwbxlx1sbt.cloudfront.net/" | ||
+ | }) | ||
− | -- | + | -- OR download from the profile |
− | + | loadVideoFile({name = getMudletHomeDir().. "/TextInMotion-VideoSample-1080p.mp4"}) | |
− | -- | + | -- OR download from the local file system |
− | + | loadVideoFile({name = "C:/Users/Tamarindo/Movies/TextInMotion-VideoSample-1080p.mp4"}) | |
− | |||
− | |||
− | |||
− | }) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
− | ---- Ordered Parameter Syntax of | + | ---- 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") | |
− | |||
− | |||
− | |||
− | |||
− | ) | ||
</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>. |
{| 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;"| | + | | style="text-align:center;" |Yes |
− | | 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().. "/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 | ||
− | | | + | | volume |
− | | | + | |1 to 100 |
− | | | + | |50 |
| style="text-align:left;" | | | style="text-align:left;" | | ||
− | * | + | *Relative to the volume set on the player's client. |
− | |||
|- | |- | ||
− | | style="text-align:center;"| No | + | | 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 | + | | 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;" | | | style="text-align:left;" | | ||
− | * | + | *Begin play at the specified position in milliseconds. |
− | |||
− | |||
|- | |- | ||
− | | style="text-align:center;"| No | + | | 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. |
− | * | + | *A value of -1 allows the media to loop indefinitely. |
|- | |- | ||
− | | | + | | 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. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |- | ||
− | | style="text-align:center;"| No | ||
− | | | ||
− | | < | ||
− | | | ||
− | | style="text-align:left;"| | ||
− | * | ||
|- | |- | ||
| style="text-align:center;" |No | | style="text-align:center;" |No | ||
− | | | + | |continue |
− | | | + | |true or false |
− | | | + | |true |
| style="text-align:left;" | | | 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> | |
− | + | | | |
− | |||
− | |||
− | |||
− | | style="text-align:center;" | | ||
− | | | ||
− | | | ||
− | | | ||
| style="text-align:left;" | | | 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="text-align:center;"| | + | |- style="color: blue;" |
− | | | + | | style="text-align:center;" |Maybe |
− | | true or false | + | |stream |
+ | |true or false | ||
|false | |false | ||
| style="text-align:left;" | | | style="text-align:left;" | | ||
− | * | + | *Streams files from the Internet when true. |
− | * | + | *Download files when false (default). |
− | * | + | *Used in combination with the `url` key. |
|- | |- | ||
− | + | |} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |} | ||
− | See also: [[Manual: | + | 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]] |
− | {{MudletVersion|4. | + | {{MudletVersion|4.??}} |
;Example | ;Example | ||
Line 492: | Line 386: | ||
---- Table Parameter Syntax ---- | ---- 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/" | |
− | name = | ||
− | , | ||
− | |||
− | |||
}) | }) | ||
− | -- | + | -- 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) | |
− | tag = " | + | 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 | ||
}) | }) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
− | ---- Ordered Parameter Syntax of | + | ---- 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 -- | ||
, nil -- key | , 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( | |
− | nil -- | + | "TextInMotion-VideoSample-1080p.mp4" |
+ | , nil -- volume | ||
+ | , nil -- fadein | ||
+ | , nil -- fadeout | ||
+ | , nil -- start | ||
+ | , nil -- loops | ||
, nil -- key | , nil -- key | ||
, nil -- tag | , 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 | ||
+ | ) | ||
+ | </syntaxhighlight> | ||
− | |||
− | |||
− | |||
− | |||
− | + | ==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 [[Manual:Miscellaneous_Functions#playVideoFile|playVideoFile()]]. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | ; | ||
− | |||
− | |||
− | |||
{| class="wikitable" | {| class="wikitable" | ||
Line 593: | Line 528: | ||
!Value | !Value | ||
! style="text-align:left;" |Purpose | ! style="text-align:left;" |Purpose | ||
− | |- | + | |- |
− | | style="text-align:center;" | | + | | 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. |
− | * | + | |- |
− | * | + | | style="text-align:center;" |No |
− | + | |key | |
− | |- | + | |<key> |
− | | style="text-align:center;" | | + | | 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;" | | | style="text-align:left;" | | ||
− | * | + | *Helps categorize media. |
− | |||
|- | |- | ||
|} | |} | ||
− | See also: [[Manual:Miscellaneous_Functions# | + | 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. | + | {{MudletVersion|4.??}} |
;Example | ;Example | ||
Line 621: | Line 559: | ||
---- Table Parameter Syntax ---- | ---- 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 | ||
}) | }) | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</syntaxhighlight> | </syntaxhighlight> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
− | ---- Ordered Parameter Syntax of | + | ---- 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 | ||
+ | ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
− | |||
− | |||
− | |||
+ | ==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" | ||
− | + | |+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 | |
− | + | <syntaxhighlight lang="lua"> | |
− | + | -- 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> | |
− | + | ||
− | + | ==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|getCharacterName()]], [[#sendCharacterPassword|sendCharacterPassword()]], [[#sendCustomLoginText|sendCustomLoginText()]], [[#getCustomLoginTextId|getCustomLoginTextId()]]. | |
− | + | ||
− | + | {{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|getCharacterName()]], [[#sendCustomLoginText|sendCustomLoginText()]], [[#getCustomLoginTextId|getCustomLoginTextId()]], [[#sendCharacterName|sendCharacterName()]]. | |
− | | | + | |
− | | | + | {{note}} Not available yet. See https://github.com/Mudlet/Mudlet/pull/3952 |
− | + | ||
− | + | ;Example | |
− | + | <syntaxhighlight lang="lua"> | |
− | + | -- 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 | |
− | + | </syntaxhighlight> | |
− | + | ||
+ | ==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 | ||
|- | |- | ||
− | + | !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 |
+ | <syntaxhighlight lang="lua"> | ||
+ | -- 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> | ||
− | + | =Mudlet Object Functions= | |
+ | :A collection of functions that manipulate Mudlet's scripting objects - triggers, aliases, and so forth. | ||
− | + | =Networking Functions= | |
− | + | :A collection of functions for managing networking. | |
− | + | ==sendAll PR #7536 (merged)== | |
− | + | ; sendAll([time delay], list of things to send, [echo back or not]) | |
− | + | : sends multiple things to the game with an optional delay between sends. If you'd like the commands not to be shown, include ''false'' at the end. | |
− | |||
− | |||
− | |||
− | + | :See also: [[Manual:Basic_Essentials#send|send()]] | |
− | + | ;Example | |
− | + | <syntaxhighlight lang="lua"> | |
− | + | -- instead of using many send() calls, you can use one sendAll | |
− | + | sendAll("outr paint", "outr canvas", "paint canvas") | |
+ | -- can also have the commands not be echoed | ||
+ | sendAll("hi", "bye", false) | ||
+ | -- add an optional delay (in seconds, accepts decimals) which slows down the sent commands | ||
+ | -- 2 second delay, then sends "hi", 2 second delay then sends "bye", 2 second delay then sends "wave") | ||
+ | sendAll(2, "hi", "bye", "wave") | ||
+ | </syntaxhighlight> | ||
− | + | ==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") | |
− | + | ||
− | + | ;See also: [[Manual:Lua_Functions#feedTelnet|feedTelnet()]], [[Manual:Lua_Functions#feedTriggers|feedTriggers()]] | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | {{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()]]. | |
− | + | ||
− | + | {{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 | |
− | + | <syntaxhighlight lang="lua"> | |
− | + | -- 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 | ||
+ | </syntaxhighlight> | ||
+ | |||
+ | ; 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: [[Manual:Lua_Functions#feedTriggers|feedTriggers()]], [[Manual:Lua_Functions#sendSocket|sendSocket()]] | ||
− | + | {{MudletVersion|tbd}} | |
− | |||
− | |||
− | {| class="wikitable" | + | {{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. | ||
+ | |||
+ | {| class="wikitable sortable" | ||
+ | |+ 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 |
− | + | |- | |
− | + | || <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' |
− | | | + | |} |
− | + | ||
− | + | ;Example | |
− | + | <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 | |
− | + | ||
− | + | 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 | |
− | + | </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 | |
− | + | ;Returns | |
− | + | * a string formatted for decho | |
− | + | ||
− | + | ;Example | |
− | + | <syntaxhighlight lang="lua"> | |
− | + | -- 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)) | |
− | + | </syntaxhighlight> | |
− | + | ||
− | + | ==cecho2hecho PR#6849 merged== | |
− | + | ; convertedString = cecho2hecho(str) | |
− | + | ||
− | + | :Converts a cecho formatted string to an hecho formatted one. | |
− | + | ;See also: [[Manual:Lua_Functions#hecho2cecho|hecho2cecho()]], [[Manual:Lua_Functions#cecho2html|cecho2html()]] | |
− | + | ||
− | + | {{MudletVersion|4.18}} | |
− | + | ||
− | + | ;Parameters | |
− | + | * ''str'' | |
− | + | : string you wish to convert from cecho to decho | |
− | + | ;Returns | |
− | + | * a string formatted for hecho | |
− | + | ||
− | | | + | ;Example |
− | + | <syntaxhighlight lang="lua"> | |
− | | | + | -- 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)) |
− | + | </syntaxhighlight> | |
− | + | ||
− | + | ==cecho2html PR#6849 merged== | |
− | + | ; convertedString = cecho2html(str[, resetFormat]) | |
− | + | ||
− | + | :Converts a cecho formatted string to an html formatted one. | |
− | + | ;See also: [[Manual:Lua_Functions#decho2cecho|decho2cecho()]], [[Manual:Lua_Functions#decho2html|cecho2html()]] | |
− | + | ||
− | + | {{MudletVersion|4.18}} | |
− | + | ||
− | + | ;Parameters | |
− | + | * ''str'' | |
− | + | : string you wish to convert from cecho to decho | |
− | + | * ''resetFormat'' | |
− | + | : optional table of default formatting options. As returned by [[Manual:Lua_Functions#getLabelFormat|getLabelFormat()]] | |
− | + | ;Returns | |
− | + | * a string formatted for html | |
− | + | ||
− | + | ;Example | |
− | | | + | <syntaxhighlight lang="lua"> |
− | | | + | -- 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) | |
− | + | </syntaxhighlight> | |
− | + | ||
− | + | ==decho2cecho PR#6849 merged== | |
− | + | ; convertedString = decho2cecho(str) | |
− | + | ||
− | + | :Converts a decho formatted string to a cecho formatted one. | |
− | + | ;See also: [[Manual:Lua_Functions#cecho2decho|cecho2decho()]], [[Manual:Lua_Functions#decho2html|decho2html()]] | |
− | + | ||
− | + | {{MudletVersion|4.18}} | |
− | + | ||
− | + | ;Parameters | |
− | + | * ''str'' | |
− | + | : string you wish to convert from decho to cecho | |
− | + | ;Returns | |
− | + | * a string formatted for cecho | |
− | + | ||
− | + | ;Example | |
− | + | <syntaxhighlight lang="lua"> | |
− | + | -- 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)) |
− | + | </syntaxhighlight> | |
− | | | + | |
− | + | ==decho2hecho PR#6849 merged== | |
− | + | ; convertedString = decho2hecho(str) | |
− | + | ||
− | + | :Converts a decho formatted string to an hecho formatted one. | |
− | + | ;See also: [[Manual:Lua_Functions#hecho2decho|hecho2decho()]], [[Manual:Lua_Functions#decho2html|decho2html()]] | |
− | + | ||
− | + | {{MudletVersion|4.18}} | |
− | + | ||
− | + | ;Parameters | |
− | + | * ''str'' | |
− | + | : string you wish to convert from decho to decho | |
− | + | ;Returns | |
− | + | * a string formatted for hecho | |
− | + | ||
− | + | ;Example | |
− | + | <syntaxhighlight lang="lua"> | |
− | + | -- 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)) | |
− | + | </syntaxhighlight> | |
− | + | ||
− | + | ==decho2html PR#6849 merged== | |
− | + | ; convertedString = decho2html(str[, resetFormat]) | |
− | + | ||
− | + | :Converts a decho formatted string to an html formatted one. | |
− | || | + | ;See also: [[Manual:Lua_Functions#cecho2decho|cecho2decho()]], [[Manual:Lua_Functions#decho2html|decho2html()]] |
− | | | + | |
− | + | {{MudletVersion|4.18}} | |
− | + | ||
− | + | ;Parameters | |
− | + | * ''str'' | |
− | + | : string you wish to convert from decho to decho | |
− | | | + | * ''resetFormat'' |
− | + | : optional table of default formatting options. As returned by [[Manual:Lua_Functions#getLabelFormat|getLabelFormat()]] | |
− | + | ;Returns | |
− | + | * a string formatted for html | |
− | + | ||
− | + | ;Example | |
− | + | <syntaxhighlight lang="lua"> | |
− | + | -- 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) | |
− | + | </syntaxhighlight> | |
− | + | ||
− | + | ==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: [[Manual:Lua_Functions#deleteLine|deleteLine()]], [[Manual:Lua_Functions#replaceLine|replaceLine()]] | |
− | + | ||
− | + | {{MudletVersion|4.18}} | |
− | + | ||
− | + | {{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 | |
− | + | <syntaxhighlight lang="lua"> | |
− | + | -- 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 | ||
+ | </syntaxhighlight> | ||
+ | |||
+ | ; Additional development notes | ||
− | ; | + | ==hecho2cecho PR#6849 merged== |
− | + | ; convertedString = hecho2cecho(str) | |
− | |||
− | |||
− | |||
− | + | :Converts a hecho formatted string to a cecho formatted one. | |
− | + | ;See also: [[Manual:Lua_Functions#cecho2decho|cecho2decho()]], [[Manual:Lua_Functions#hecho2html|hecho2html()]] | |
− | |||
− | |||
− | + | {{MudletVersion|4.18}} | |
− | |||
− | + | ;Parameters | |
− | + | * ''str'' | |
− | + | : string you wish to convert from hecho to cecho | |
− | + | ;Returns | |
− | + | * a string formatted for cecho | |
− | |||
− | |||
− | ; | + | ;Example |
− | -- | + | <syntaxhighlight lang="lua"> |
+ | -- 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)) | ||
+ | </syntaxhighlight> | ||
− | = | + | ==hecho2decho PR#6849 merged== |
− | + | ; convertedString = hecho2decho(str) | |
− | + | :Converts a hecho formatted string to a decho formatted one. | |
− | : | + | ;See also: [[Manual:Lua_Functions#decho2hecho|decho2hecho()]], [[Manual:Lua_Functions#hecho2html|hecho2html()]] |
− | + | {{MudletVersion|4.18}} | |
− | |||
− | + | ;Parameters | |
− | : | + | * ''str'' |
+ | : string you wish to convert from hecho to decho | ||
+ | ;Returns | ||
+ | * a string formatted for decho | ||
− | == | + | ;Example |
− | ; convertedString = | + | <syntaxhighlight lang="lua"> |
+ | -- 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)) | ||
+ | </syntaxhighlight> | ||
+ | |||
+ | ==hecho2html PR#6849 merged== | ||
+ | ; convertedString = hecho2html(str[, resetFormat]) | ||
− | :Converts a | + | :Converts a hecho formatted string to an html formatted one. |
− | ;See also: [[Manual:Lua_Functions# | + | ;See also: [[Manual:Lua_Functions#cecho2hecho|cecho2hecho()]], [[Manual:Lua_Functions#hecho2html|hecho2html()]] |
{{MudletVersion|4.18}} | {{MudletVersion|4.18}} | ||
Line 1,543: | Line 1,290: | ||
;Parameters | ;Parameters | ||
* ''str'' | * ''str'' | ||
− | : string you wish to convert from | + | : string you wish to convert from hecho to hecho |
+ | * ''resetFormat'' | ||
+ | : optional table of default formatting options. As returned by [[Manual:Lua_Functions#getLabelFormat|getLabelFormat()]] | ||
;Returns | ;Returns | ||
− | * a string formatted for | + | * a string formatted for html |
;Example | ;Example | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
− | -- | + | -- create the base string |
− | local | + | 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) | ||
+ | </syntaxhighlight> | ||
− | ; | + | ==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 |
− | <syntaxhighlight lang="lua"> | + | * ''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. <syntaxhighlight lang="lua" inline="">{[[send("hello")]], function() echo("hi!") end}</syntaxhighlight>. | ||
+ | * ''{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}} 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 |
− | + | <syntaxhighlight lang="lua"> | |
+ | -- 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) | |
− | |||
− | : | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</syntaxhighlight> | </syntaxhighlight> | ||
− | == | + | =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 [[Special:MyLanguage/Manual:Scripting#Discord_Rich_Presence|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 [[Special:MyLanguage/Manual:Scripting#MUD_Client_Media_Protocol|MUD Client Media Protocol 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 [[Special:MyLanguage/Manual:Scripting#MUD_Client_Media_Protocol|MUD Client Media Protocol scripting overview]]. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | == | + | =Supported Protocols= |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | =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. | ||
− | + | ===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 } | |
− | + | {{MudletVersion| ?.??}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | {| | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | {{note}} pending, not yet available. See https://github.com/Mudlet/Mudlet/pull/7476 | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
===sysMapAreaChanged, PR #6615=== | ===sysMapAreaChanged, PR #6615=== |
Latest revision as of 07:25, 25 December 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.
mapSymbolFontInfo, PR #4038 closed
- mapSymbolFontInfo()
- See also: setupMapSymbolFont()
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().
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()
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: 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.
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: 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: 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
- 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: 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> |
|
Maybe | url | <url> |
|
See also: loadSoundFile(), loadMusicFile(), playSoundFile(), playMusicFile(), playVideoFile(), stopSounds(), stopMusic(), stopVideos(), createVideoPlayer(), purgeMediaCache(), Mud Client Media Protocol
- 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 istrue
.
Required | Key | Value | Default | Purpose |
---|---|---|---|---|
Yes | name | <file name> |
| |
No | volume | 1 to 100 | 50 |
|
No | fadein | <msec> |
| |
No | fadeout | <msec> |
| |
No | start | <msec> | 0 |
|
No | loops | -1, or >= 1 | 1 |
|
No | key | <key> |
| |
No | tag | <tag> |
| |
No | continue | true or false | true |
|
Maybe | url | <url> |
| |
Maybe | stream | true or false | false |
|
See also: loadSoundFile(), loadMusicFile(), loadVideoFile(), playSoundFile(), playMusicFile(), stopSounds(), stopMusic(), stopVideos(), createVideoPlayer(), purgeMediaCache(), Mud Client Media Protocol
- 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> |
|
No | key | <key> |
|
No | tag | <tag> |
|
See also: loadSoundFile(), loadMusicFile(), loadVideoFile(), playSoundFile(), playMusicFile(), playVideoFile(), stopSounds(), stopMusic(), createVideoPlayer(), purgeMediaCache(), Mud Client Media Protocol
- 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.
Note: Not available yet. See https://github.com/Mudlet/Mudlet/pull/3952
Only one custom login text has been defined initially:
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: 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.
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.
Note: Not available yet. See https://github.com/Mudlet/Mudlet/pull/3952
Only one custom login text has been defined initially:
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.
Networking Functions
- A collection of functions for managing networking.
sendAll PR #7536 (merged)
- sendAll([time delay], list of things to send, [echo back or not])
- sends multiple things to the game with an optional delay between sends. If you'd like the commands not to be shown, include false at the end.
- See also: send()
- Example
-- instead of using many send() calls, you can use one sendAll
sendAll("outr paint", "outr canvas", "paint canvas")
-- can also have the commands not be echoed
sendAll("hi", "bye", false)
-- add an optional delay (in seconds, accepts decimals) which slows down the sent commands
-- 2 second delay, then sends "hi", 2 second delay then sends "bye", 2 second delay then sends "wave")
sendAll(2, "hi", "bye", "wave")
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: 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: 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()
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 | 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()
- 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()
- 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()
- 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()
- 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()
- 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()
- 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()
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
hecho2cecho PR#6849 merged
- convertedString = hecho2cecho(str)
- Converts a hecho formatted string to a cecho formatted one.
- See also
- cecho2decho(), hecho2html()
- 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()
- 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()
- 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: 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 }
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.
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.
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.
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).