Manual:Mapper Functions - Revision history

Vadi: Correct getMapEvents return shape description

2026-07-18T20:01:44Z

Correct getMapEvents return shape description

Vadi: Update setCustomEnvColor (4.20 preference sync), document addRoom bad-areaID behaviour (4.19), fix getMapEvents example to use pairs

2026-07-18T19:34:40Z

Update setCustomEnvColor (4.20 preference sync), document addRoom bad-areaID behaviour (4.19), fix getMapEvents example to use pairs

Vadi: fix version: hidden rooms will be in 4.21, not 4.20

2026-04-10T13:10:46Z

fix version: hidden rooms will be in 4.21, not 4.20

Vadi: fix version: hidden rooms will be in 4.21, not 4.20

2026-04-10T13:10:30Z

fix version: hidden rooms will be in 4.21, not 4.20

Vadi: fix version: hidden rooms will be in 4.21, not 4.20

2026-04-10T13:10:11Z

fix version: hidden rooms will be in 4.21, not 4.20

Morquin: /* enableMapInfo */

2026-02-17T06:42:14Z

enableMapInfo

Morquin: /* disableMapInfo */

2026-02-17T06:41:50Z

disableMapInfo

Morquin: /* enableMapInfo */

2026-02-17T06:28:44Z

enableMapInfo

Dt192 at 08:48, 16 February 2026

2026-02-16T08:48:28Z

Tamarindo: /* getRoomsByPosition1 */

2026-02-04T03:23:36Z

getRoomsByPosition1

@@ Line 1,284: / Line 1,284: @@
 ; mapevents = getMapEvents()
-: Returns a list of map events currently registered. Each event is a dictionary with the keys ''uniquename'', ''parent'', ''event name'', ''display name'', and ''arguments'', which correspond to the arguments of ''addMapEvent()''.
+: Returns the map events currently registered as a table keyed by each map event's unique name. Each entry is a table with the keys ''event name'', ''parent'', ''display name'', and ''arguments'', which correspond to the arguments of ''addMapEvent()''. Returns an empty table if no map events are registered.
 : See also: [[#addMapMenu|addMapMenu()]], [[#removeMapEvent|removeMapEvent()]], [[#addMapEvent|addMapEvent()]]

@@ Line 144: / Line 144: @@
 ;addRoom(roomID, areaID)
-:Creates a new room with the given room ID and area ID, returns true if the room was successfully created.
+:Creates a new room with the given room ID and area ID, returns true if the room was successfully created. If the given areaID does not exist, the room is still created but placed in the default area (-1), and nil plus an error message are returned instead (since Mudlet 4.19).
 ;Parameters
@@ Line 1,294: / Line 1,294: @@
 local mapEvents = getMapEvents()
-for _, event in ipairs(mapEvents) do
+for uniquename, event in pairs(mapEvents) do
-   echo(string.format("MapEvent '%s' is bound to event '%s' with these args: '%s'", event["uniquename"], event["event name"], table.concat(event["arguments"], ",")))
+   echo(string.format("MapEvent '%s' is bound to event '%s' with these args: '%s'", uniquename, event["event name"], table.concat(event["arguments"], ",")))
 end
 </syntaxhighlight>
@@ Line 2,531: / Line 2,531: @@
 ;setCustomEnvColor(environmentID, r,g,b,a)
-:Creates, or overrides an already created custom color definition for a given environment ID. Note that this will not work on the default environment colors - those are adjustable by the user in the preferences. You can however create your own environment and use a custom color definition for it.
+:Creates, or overrides an already created custom color definition for a given environment ID. You can create your own environment and use a custom color definition for it.
 : See also: [[#getCustomEnvColorTable|getCustomEnvColorTable()]], [[#setRoomEnv|setRoomEnv()]]
-{{note}} Numbers 1-16 and 257-272 are reserved by Mudlet. 257-272 are the default colors the user can adjust in mapper settings, so feel free to use them if you'd like - but don't overwrite them with this function.
+{{note}} Numbers 1-16 and 257-272 are reserved by Mudlet. IDs 257-272 are the 16 default environment colors the user can adjust in the mapper settings. Since Mudlet 4.20, setting one of these IDs also updates the matching color in the profile's mapper preferences - the change is persistent and saved with the profile, as they are the same 16 colors.
 [[File:Screenshot 20240305 115555.png|thumb|center|Default colour table for Mudlet mapper.]]

@@ Line 1,254: / Line 1,254: @@
 :Returns a table of all hidden room IDs in the map.
-{{MudletVersion|4.20}}
+{{MudletVersion|4.21}}
 :See also: [[#setRoomHidden|setRoomHidden()]], [[#getRoomHidden|getRoomHidden()]]

@@ Line 1,697: / Line 1,697: @@
 :Returns whether a room is hidden on the 2D map.
-{{MudletVersion|4.20}}
+{{MudletVersion|4.21}}
 :See also: [[#setRoomHidden|setRoomHidden()]], [[#getHiddenRooms|getHiddenRooms()]]

@@ Line 2,865: / Line 2,865: @@
 :Sets whether a room should be hidden on the 2D map. Hidden rooms are not drawn but still exist in the map data and can be used for pathfinding.
-{{MudletVersion|4.20}}
+{{MudletVersion|4.21}}
 :See also: [[#getRoomHidden|getRoomHidden()]], [[#getHiddenRooms|getHiddenRooms()]]

@@ Line 688: / Line 688: @@
 ;Parameters
 * ''label:''
-: Name under which map info to be enabled was registered. Available are "Short" and "Full". They have to be enabled/disabled individually.
+: Name under which map info to be enabled was registered. Default available are "Short" and "Full". They have to be enabled/disabled individually.
 : See also: [[#registerMapInfo|registerMapInfo()]], [[#disableMapInfo|disableMapInfo()]], [[#killMapInfo|killMapInfo()]]

@@ Line 675: / Line 675: @@
 ;Parameters
 * ''label:''
-: Name under which map info to be disabled was registered.
+: Name under which map info to be disabled was registered. Default available are "Short" and "Full". They have to be enabled/disabled individually.
 : See also: [[#registerMapInfo|registerMapInfo()]], [[#enableMapInfo|enableMapInfo()]], [[#killMapInfo|killMapInfo()]]

@@ Line 1,599: / Line 1,599: @@
 -- gets the color of the room character set on room 12345. If no room character is set the default 'color' is 0,0,0
 local r,g,b = getRoomCharColor(12345)
-decho(f"Room Character for room 12345 is <{r},{g},{b}>this color.<r> It is made up of <{r},0,0>{r} red<r>, <0,{g},0>{g} green<r>, <0,0,{b}> {b} blue<r>.\")
+decho(f"Room Character for room 12345 is <{r},{g},{b}>this color.<r> It is made up of <{r},0,0>{r} red<r>, <0,{g},0>{g} green<r>, <0,0,{b}> {b} blue<r>.")
 </syntaxhighlight>

@@ Line 1,819: / Line 1,819: @@
    end
 </syntaxhighlight>
 ==getRoomUserData==