Manual:Mapper Functions - Revision history

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

Tamarindo: /* createMapLabel */

2026-02-04T03:18:57Z

createMapLabel

Tamarindo: /* exportAreaImage */

2026-02-04T03:16:20Z

exportAreaImage

@@ 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==

@@ Line 501: / Line 501: @@
 -- (from 4.17.0) true to not save the label's image in the map file afterwards
 createMapImageLabel(138, [[/home/vadi/Pictures/You only see what shown.png]], 0,0,0, 482/100, 555/100, 100, false, true)
 </syntaxhighlight>

← Older revision		Revision as of 03:16, 4 February 2026
Line 625:		Line 625:

	{{MudletVersion\|4.11}}		{{MudletVersion\|4.11}}
		+
		+	==exportAreaImage==
		+	; exportAreaImage(areaID, filePath[, zLevel])
		+
		+	:Exports an area from the mapper as an image file. This function allows you to save a visual representation of a specific area (or a specific Z level within that area) to disk as an image. The exported image will show rooms, exits, and other map elements as they appear in the 2D mapper.
		+
		+	:The image is rendered at a fixed 2.0x zoom level to provide good quality output while maintaining reasonable file sizes.
		+
		+	;See also: [[Manual:Mapper_Functions#createMapImageLabel\|createMapImageLabel()]], [[Manual:Mapper_Functions#createMapLabel\|createMapLabel()]]
		+
		+	{{MudletVersion\|4.20}}
		+
		+	{{note}} This function requires the mapper to be open and a valid map to be loaded. It will return an error if no map is present or if the specified area ID doesn't exist.
		+
		+	;Parameters
		+	* ''areaID:''
		+	: Area ID number of the area to export as an image.
		+	* ''filePath:''
		+	: File path where the image should be saved. Should include the desired file extension (e.g., ".png", ".jpg"). When exporting all Z levels, this will be used as a template for generating individual filenames.
		+	* ''zLevel:''
		+	: (optional) Can be one of the following:
		+	:: ''integer'' - exports only the specific Z level within the area
		+	:: ''true'' - exports all Z levels in the area as separate image files
		+	:: ''nil/omitted'' - exports the current player's Z level
		+
		+	;Returns
		+	* ''success:'' boolean - true if the export was successful, false if it failed
		+	* ''errorMessage:'' string - only returned when success is false, contains the error message describing what went wrong
		+
		+	;Example
		+
		+	<syntaxhighlight lang="lua">
		+	-- Export the current player's Z level of area 1 to a PNG file
		+	exportAreaImage(1, "/home/user/mymap.png")
		+
		+	-- Export only Z level 0 of area 5 to a JPG file
		+	exportAreaImage(5, "/home/user/level0.jpg", 0)
		+
		+	-- Export area 10, Z level -1 (basement level)
		+	exportAreaImage(10, "basement_map.png", -1)
		+
		+	-- Export ALL Z levels in area 12 as separate images
		+	-- This will create files like: mymap_level_0.png, mymap_level_1.png, mymap_level_-1.png, etc.
		+	local success, error = exportAreaImage(12, "mymap.png", true)
		+	if success then
		+	echo("All Z levels exported successfully!")
		+	else
		+	echo("Export failed: " .. error)
		+	end
		+
		+	-- Export all Z levels in multiple areas
		+	for areaID, areaName in pairs(getAreaTable()) do
		+	local filename = string.format("%s_area_%d.png", areaName, areaID)
		+	local success, error = exportAreaImage(areaID, filename, true)
		+	if success then
		+	echo("Exported all Z levels for area: " .. areaName)
		+	else
		+	echo("Failed to export area " .. areaName .. ": " .. error)
		+	end
		+	end
		+
		+	-- Get a list of all Z levels in an area and export them individually
		+	local areaID = 5
		+	local area = getAreaTable()[areaID]
		+	if area then
		+	-- Get all Z levels by examining rooms in the area
		+	local zLevels = {}
		+	for roomID in pairs(getAreaRooms(areaID)) do
		+	local x, y, z = getRoomCoordinates(roomID)
		+	if z and not zLevels[z] then
		+	zLevels[z] = true
		+	end
		+	end
		+
		+	-- Export each Z level individually with custom naming
		+	for zLevel in pairs(zLevels) do
		+	local filename = string.format("area_%s_floor_%d.png", area, zLevel)
		+	exportAreaImage(areaID, filename, zLevel)
		+	echo("Exported Z level " .. zLevel .. " to " .. filename)
		+	end
		+	end
		+	</syntaxhighlight>

	==getAllAreaUserData==		==getAllAreaUserData==