Difference between revisions of "Manual:Mapper Functions"
Line 869: | Line 869: | ||
;setAreaName(areaID, newName) | ;setAreaName(areaID, newName) | ||
− | : | + | :Names, or renames an existing area to the new name. The area must be created first with [[Manual:Lua_Functions#addAreaName|addAreaName()]]. |
+ | :See also: [[Manual:Lua_Functions#deleteArea|deleteArea()]], [[Manual:Lua_Functions#addAreaName|addAreaName()]] | ||
;Example | ;Example |
Revision as of 21:48, 14 September 2013
Mapper Functions
These are functions that are to be used with the Mudlet Mapper. The mapper is designed to be MUD-generic - it only provides the display and pathway calculations, to be used in Lua scripts that are tailored to the MUD you're playing. For a collection of pre-made scripts and general mapper talk, visit the mapper section of the forums.
To register a script as a mapping one with Mudlet (so Mudlet knows the profile has one and won't bother the user when they open the map), please do this in your script: <lua> mudlet = mudlet or {}; mudlet.mapper_script = true </lua>
addAreaName
- areaID = addAreaName(areaName)
- Adds a new area name and returns the new area ID for the new name. If the name already exists, -1 is returned.
- See also: deleteArea(), addRoom()
- Example
<lua> local newID = addAreaName("My house")
if newID == -1 then echo("That area name is already taken :(\n") else echo("Created new area with the ID of "..newid..".\n") end </lua>
addMapEvent
- addMapEvent(uniquename, event name, parent, display name, arguments)
- Adds a new entry to an existing mapper right-click entry. You can add one with addMapMenu. If there is no display name, it will default to the unique name (which otherwise isn't shown and is just used to differentiate this entry from others). event name is the Mudlet event that will be called when this is clicked on, and arguments will be passed to the handler function.
- See also: addMapMenu(), removeMapEvent(), getMapEvents()
- Example
<lua> addMapEvent("room a", "onFavorite") -- will make a label "room a" on the map menu's right click that calls onFavorite
addMapEvent("room b", "onFavorite", "Favorites", "Special Room!", 12345, "arg1", "arg2", "argn") </lua> The last line will make a label "Special Room!" under the "Favorites" menu that on clicking will send all the arguments.
addMapMenu
- addMapEvent(uniquename, parent, display name)
- Adds a new submenu to the right-click menu that opens when you right-click on the mapper. You can then add more submenus to it, or add entries with addMapEvent().
- See also: addMapEvent(), removeMapEvent(), getMapEvents()
- Example
<lua> addMapMenu("Favorites") -- will create a menu, favorites
addMapMenu("Favorites1234343", "Favorites", "Favorites") </lua> The last line will create a submenu with the unique id Favorites123.. under Favorites with the display name of Favorites.
addRoom
- addRoom(roomID)
- Creates a new room with the given ID, returns true if the room was successfully created.
Note: If you're not using incremental room IDs but room IDs stitched together from other factors or in-game hashes for room IDs - and your room IDs are starting off at 250+million numbers, you need to look into incrementally creating Mudlets room IDs with createRoomID() and associating your room IDs with Mudlets via setRoomIDbyHash() and getRoomIDbyHash(). The reason being is that Mudlet's A* pathfinding implementation from boost cannot deal with extremely large room IDs because the resulting matrices it creates for pathfinding are enormously huge.
- See also: createRoomID()
- Example
<lua> local newroomid = createRoomID() addRoom(newroomid) </lua>
addSpecialExit
- addSpecialExit(roomIDFrom, roomIDTo, command)
- Creates a one-way from one room to another, that will use the given command for going through them.
- See also: clearSpecialExits()
- Example
<lua> -- sample alias pattern: ^spe (\d+) (.*?)$ -- mmp.currentroom is your current room ID in this example addSpecialExit(mmp.currentroom,tonumber(matches[2]), matches[3]) echo("\n SPECIAL EXIT ADDED TO ROOMID:"..matches[2]..", Command:"..matches[3]) centerview(mmp.currentroom) </lua>
centerview
- centerview (roomID)
- Centers the map view onto the given room ID. The map must be open to see this take effect. This function can also be used to see the map of an area if you know the number of a room there and the area and room are mapped.
clearRoomUserData
- clearRoomUserData(roomID)
- Clears all user data from a given room.
- See also: setRoomUserData()
- Example
<lua> clearRoomUserData(341) </lua>
clearSpecialExits
- clearSpecialExits(roomID)
- Removes all special exits from a room.
- See also: addSpecialExit()
- Example
<lua> clearSpecialExits(1337)
if #getSpecialExits(1337) == 0 then -- clearSpecialExits will never fail on a valid room ID, this is an example
echo("All special exits successfully cleared from 1337.\n")
end </lua>
connectExitStub
- connectExitStub(fromID, direction or toID[, optional direction])
- Connects existing rooms with matching exit stubs. If you only give it a roomID and a direction, it'll work out which room should be linked to it that has an appropriate opposite exit stub and is located in the right direction. You can also just specify from and to room IDs, and it'll smartly use the right direction to link in. Lastly, you can specify all three arguments - fromID, toID and the direction (in that order) if you'd like to be explicit, or use setExit() for the same effect.
- Parameters
- fromID:
- Room ID to set the exit stub in.
- direction or toID:
- You can either specify the direction to link the room in, or a specific room ID. Direction is specified as a # that the exit stub points at, or you can also use exitmap["direction"] instead. If you specify the room
- toID:
- Optional - the room ID to link this room to. If you don't specify it, the mapper will work out which room should be logically linked.
- See also: getExitStubs()
- Example
<lua> -- try and connect all stubs that are in a room local stubs = getExitStubs(roomID)
if stubs then for i,v in pairs(stubs) do connectExitStub(roomID, v) end
end </lua>
createMapLabel
- labelID = createMapLabel(areaID, text, posx, posy, posz, fgRed, fgGreen, fgBlue, bgRed, bgGreen, bgBlue, zoom, fontSize, showOnTop, noScaling)
- Creates a text label on the map at given coordinates, with the given background and foreground colors. It can go above or below the rooms, scale with zoom or stay a static size. It returns a label ID that you can use later for deleting it.
- The coordinates 0,0 are in the middle of the map, and are in sync with the room coordinates - so using the x,y values of getRoomCoordinates() will place the label near that room.
- See also: deleteMapLabel
- Example
<lua> -- the first 50 is some area is, the next three 0,0,0 are coordinates - middle of the area -- 255,0,0 would be the foreground in RGB, 23,0,0 would be the background RGB -- zoom is only relevant when when you're using a label of a static size, so we use 0 -- and we use a font size of 20 for our label, which is a small medium compared to the map local labelid = createMapLabel( 50, "my map label", 0,0,0, 255,0,0, 23,0,0, 0,20) </lua>
createMapImageLabel
- labelID = createMapImageLabel(areaID, filePath, posx, posy, posz, width, height, zoom, showOnTop)
- Creates an image label on the map at the given coordinates, with the given dimensions and zoom. You might find the default room and image size correlation to be too big - try reducing the width and height of the image then, while also zooming in the same amount.
- The coordinates 0,0 are in the middle of the map, and are in sync with the room coordinates - so using the x,y values of getRoomCoordinates() will place the label near that room.
- See also: deleteMapLabel
- Example
<lua> -- 138 is our pretend area ID -- next, inside [[]]'s, is the exact location of our image -- 0,0,0 are the x,y,z coordinates - so this will place it in the middle of the map -- 482 is the width of the image - we divide it by 100 to scale it down, and then we'll zoom it by 100 - making the image take up about 4 rooms in width then -- 555 is the original width of the image -- 100 is how much we zoom it by, 1 would be no zoom -- and lastly, false to make it go below our rooms createMapImageLabel(138, /home/vadi/Pictures/You only see what shown.png, 0,0,0, 482/100, 555/100, 100, false) </lua>
createMapper
- createMapper(x, y, width, height)
- Creates a miniconsole window for mapper to render in, the with the given dimensions. You can only create one at a time at the moment.
- Example
<lua> createMapper(0,0,300,300) -- creates a 300x300 mapper top-right of Mudlet setBorderLeft(305) -- adds a border so text doesn't underlap the mapper display </lua>
createRoomID
- usableId = createRoomID()
- Returns the lowest possible room ID you can use for creating a new room. If there are gaps in room IDs your map uses it, this function will go through the gaps first before creating higher IDs.
- See also: addRoom()
deleteArea
- deleteArea(areaID)
- Deletes the given area, permanently. This will also delete all rooms in it!
- See also: addAreaName()
- Example
<lua> deleteArea(23) </lua>
deleteMapLabel
- deleteMapLabel(areaID, labelID)
- Deletes a map label from a specfic area.
- See also: createMapLabel()
- Example
<lua> deleteMapLabel(50, 1) </lua>
deleteRoom
- deleteRoom(roomID)
- Deletes an individual room, and unlinks all exits leading to and from it.
- Example
<lua> deleteRoom(335) </lua>
getAreaRooms
- getAreaRooms(area id)
- Returns an indexed table with all rooms IDs for a given area ID (room IDs are values), or nil if no such area exists.
Note: On Mudlet versions prior to the 2.0 final release, this function would raise an error.
- Example
<lua> -- using the sample findAreaID() function defined in the getAreaTable() example, -- we'll define a function that echo's us a nice list of all rooms in an area with their ID function echoRoomList(areaname)
local id, msg = findAreaID(areaname) if id then local roomlist, endresult = getAreaRooms(id), {} -- obtain a room list for each of the room IDs we got for _, id in ipairs(roomlist) do endresult[id] = getRoomName(id) end -- now display something half-decent looking cecho(string.format( "List of all rooms in %s (%d):\n", msg, table.size(endresult)))
for roomid, roomname in pairs(endresult) do cecho(string.format( "%6s: %s\n", roomid, roomname)) end elseif not id and msg then echo("ID not found; " .. msg) else echo("No areas matched the query.") end
end </lua>
getAreaTable
- getAreaTable()
- Returns a key(area name)-value(area id) table with all known areas and their IDs. There is an area with the name of and an ID of 0 included in it, you should ignore that.
- See also: getAreaTableSwap()
- Example
<lua> -- example function that returns the area ID for a given area
function findAreaID(areaname)
local list = getAreaTable()
-- iterate over the list of areas, matching them with substring match. -- if we get match a single area, then return it's ID, otherwise return -- 'false' and a message that there are than one are matches local returnid, fullareaname for area, id in pairs(list) do if area:find(areaname, 1, true) then if returnid then return false, "more than one area matches" end returnid = id; fullareaname = area end end return returnid, fullareaname
end
-- sample use: local id, msg = findAreaID("blahblah") if id then
echo("Found a matching ID: " .. id")
elseif not id and msg then
echo("ID not found; " .. msg)
else
echo("No areas matched the query.")
end </lua>
getAreaTableSwap
- getAreaTableSwap()
- Returns a key(area id)-value(area name) table with all known areas and their IDs. Unlike getAreaTable which won't show you all areas with the same name by different IDs, this function will. There is an area with the name of and an ID of 0 included in it, you should ignore that.
getCustomEnvColorTable
- envcolors = getCustomEnvColorTable()
- Returns a table with customized environments, where the key is the environment ID and the value is a indexed table of rgb values.
- Example
<lua> {
envid1 = {r,g,b}, envid2 = {r,g,b}
} </lua>
getDoors
- doors = getDoors(roomID)
- Returns a key-value table with the cardinal direction as the key and the door value as a number. If there are no doors in a room, it returns an empty table.
- Parameters
- roomID:
- Room ID to check for doors in.
- See also: setDoor()
- Example
<lua> -- an example that displays possible doors in room 2334 local doors = getDoors(2334)
if not next(doors) then cecho("\nThere aren't any doors in room 2334.") return end
local door_status = {"open", "closed", "locked"}
for direction, door in pairs(doors) do
cecho("\nThere's a door leading in "..direction.." that is "..door_status[door]..".")
end </lua>
getExitStubs
- stubs = getExitStubs(roomid)
- Returns an indexed table of the direction #'s that have an exit stub marked in them. You can use this information to connect earlier-made exit stubs between rooms when mapping.
- Example
<lua> -- show the exit stubs in room 6 as numbers local stubs = getExitStubs(6) for i = 0, #stubs do print(stubs[i]) end
-- show the exit stubs in room 6 as numbers as direction names, using exitmap from http://wiki.mudlet.org/w/Mapping_script#Translating_directions local stubs = getExitStubs(6) for i = 0, #stubs do print(exitmap[stubs[i]]) end </lua>
getExitWeights
- weights = getExitWeights(roomid)
- Returns a key-value table of the exit weights that a room has, with the direction or special exit as a key and the value as the exit weight. If a weight for a direction wasn't yet set, it won't be listed.
- Parameters
- roomid:
- Room ID to view the exit weights in.
- See also: setExitWeight()
getMapLabel
- labelinfo = getMapLabels(areaID, labelID)
- Returns a key-value table describing that particular label in an area. Keys it contains are the X, Y, Z coordinates, Height and Width, and the Text it contains. If the label is an image label, then Text will be set to the no text string.
- Example
<lua> lua getMapLabels(1658987) table {
1: 'no text' 0: 'test'
}
lua getMapLabel(1658987, 0) table {
'Y': -2 'X': -8 'Z': 11 'Height': 3.9669418334961 'Text': 'test' 'Width': 8.6776866912842
}
lua getMapLabel(1658987, 1) table {
'Y': 8 'X': -15 'Z': 11 'Height': 7.2520666122437 'Text': 'no text' 'Width': 11.21900844574
}
</lua>
getMapLabels
- arealabels = getMapLabels(areaID)
- Returns an indexed table (that starts indexing from 0) of all of the labels in the area, plus their label text. You can use the label id to deleteMapLabel() it.
- Example
<lua> display(getMapLabels(43)) table {
0: 1: 'Waterways'
}
deleteMapLabel(43, 0) display(getMapLabels(43)) table {
1: 'Waterways'
} </lua>
getPath
- getPath(roomID from, roomID to)
- Returns a boolean true/false if a path between two room IDs is possible. If it is, the global speedWalkPath table is set to all of the directions that have to be taken to get there, and the global speedWalkDir table is set to all of the roomIDs you'll encounter on the way.
- Example
<lua> -- check if we can go to a room - if yes, go to it if getPath(34,155) then
gotoRoom(155)
else
echo("\nCan't go there!")
end </lua>
getRoomArea
- areaID = getRoomArea(roomID)
- Returns the area ID of a given room ID. To get the area name, you can check the area ID against the data given by getAreaTable() function, or use the getRoomAreaName() function.
Note: If the room ID does not exist, this function will raise an error.
- Example
<lua> display("Area ID of room #100 is: "..getRoomArea(100))
display("Area name for room #100 is: "..getRoomAreaName(getRoomArea(100))) </lua>
getRoomAreaName
- areaname = getRoomAreaName(areaID)
- Returns the area name for a given area id.
- Example
<lua> echo(string.format("room id #455 is in %s.", getRoomAreaName(getRoomArea(455)))) </lua>
getRoomCoordinates
- x,y,z = getRoomCoordinates(room ID)
- Returns the room coordinates of the given room ID.
- Example
<lua> local x,y,z = getRoomCoordinates(roomID) echo("Room Coordinates for "..roomID..":") echo("\n X:"..x) echo("\n Y:"..y) echo("\n Z:"..z) </lua>
getRoomEnv
- envID = getRoomEnv(roomID)
- Returns the environment ID of a room. The mapper does not store environment names, so you'd need to keep track of which ID is what name yourself.
- Example
<lua> funtion checkID(id)
echo(strinf.format("The env ID of room #%d is %d.\n", id, getRoomEnv(id)))
end </lua>
getRoomExits
- getRoomExits (roomID)
- Returns the currently known non-special exits for a room in an key-index form: exit = exitroomid, ie:
- Example
<lua> table {
'northwest': 80 'east': 78
} </lua>
getRoomIDbyHash
- roomID = getRoomIDbyHash(hash)
- Returns a room ID that is associated with a given hash in the mapper. This is primarily for MUDs that make use of hashes instead of room IDs (like Avalon.de MUD). -1 is returned if no room ID matches the hash.
- Example
<lua> -- example taken from http://forums.mudlet.org/viewtopic.php?f=13&t=2177 _id1 = getRoomIDbyHash( "5dfe55b0c8d769e865fd85ba63127fbc" ); if _id1 == -1 then
_id1 = createRoomID() setRoomIDbyHash( _id1, "5dfe55b0c8d769e865fd85ba63127fbc" ) addRoom( _id ) setRoomCoordinates( _id1, 0, 0, -1 )
end </lua>
getRoomName
- roomName = getRoomName(roomID)
- Returns the room name for a given room id.
- Example
<lua> echo(string.format("The name of the room id #455 is %s.", getRoomname(455)) </lua>
getRooms
- rooms = getRooms()
- Returns the list of all rooms in the map in the whole map in roomid - room name format.
- Example
<lua> -- simple, raw viewer for rooms in the world display(getRooms()) </lua>
getRoomsByPosition
- getRoomsByPosition(areaID, x,y,z)
- Returns an indexed table of all rooms at the given coordinates in the given area, or an empty one if there are none. This function can be useful for checking if a room exists at certain coordinates, or whenever you have rooms overlapping.
- Example
<lua> -- sample alias to determine a room nearby, given a relative direction from the current room
local otherroom if matches[2] == "" then
local w = matches[3] local ox, oy, oz, x,y,z = getRoomCoordinates(mmp.currentroom) local has = table.contains if has({"west", "left", "w", "l"}, w) then x = (x or ox) - 1; y = (y or oy); z = (z or oz) elseif has({"east", "right", "e", "r"}, w) then x = (x or ox) + 1; y = (y or oy); z = (z or oz) elseif has({"north", "top", "n", "t"}, w) then x = (x or ox); y = (y or oy) + 1; z = (z or oz) elseif has({"south", "bottom", "s", "b"}, w) then x = (x or ox); y = (y or oy) - 1; z = (z or oz) elseif has({"northwest", "topleft", "nw", "tl"}, w) then x = (x or ox) - 1; y = (y or oy) + 1; z = (z or oz) elseif has({"northeast", "topright", "ne", "tr"}, w) then x = (x or ox) + 1; y = (y or oy) + 1; z = (z or oz) elseif has({"southeast", "bottomright", "se", "br"}, w) then x = (x or ox) + 1; y = (y or oy) - 1; z = (z or oz) elseif has({"southwest", "bottomleft", "sw", "bl"}, w) then x = (x or ox) - 1; y = (y or oy) - 1; z = (z or oz) elseif has({"up", "u"}, w) then x = (x or ox); y = (y or oy); z = (z or oz) + 1 elseif has({"down", "d"}, w) then x = (x or ox); y = (y or oy); z = (z or oz) - 1 end
local carea = getRoomArea(mmp.currentroom) if not carea then mmp.echo("Don't know what area are we in.") return end
otherroom = select(2, next(getRoomsByPosition(carea,x,y,z)))
if not otherroom then mmp.echo("There isn't a room to the "..w.." that I see - try with an exact room id.") return else mmp.echo("The room "..w.." of us has an ID of "..otherroom) end
</lua>
getRoomUserData
- data = getRoomUserData(roomID, key (as a string))
- Returns the user data stored at a given room with a given key, or "" if none is stored. Use setRoomUserData() function for setting the user data.
- Example
<lua> display(getRoomUserData(341, "visitcount")) </lua>
getRoomWeight
- room weight = getRoomWeight(roomID)
- Returns the weight of a room. By default, all new rooms have a weight of 1.
- See also: setRoomWeight()
- Example
<lua> display("Original weight of room 541: "..getRoomWeight(541) setRoomWeight(541, 3) display("New weight of room 541: "..getRoomWeight(541) </lua>
getSpecialExits
- exits = getSpecialExits(roomID)
- Returns a roomid - command table of all special exits in the room. If there are no special exits in the room, the table returned will be empty.
- See also: getRoomExits()
- Example
<lua> getSpecialExits(1337)
-- results in: --[[ table {
12106: 'faiglom nexus'
} ]] </lua>
getSpecialExitsSwap
- exits = getSpecialExitsSwap(roomID)
- Very similar to getSpecialExits() function, but returns the rooms in the command - roomid style.
gotoRoom
- gotoRoom (roomID)
- Speedwalks you to the given room from your current room if it is able and knows the way. You must turn the map on for this to work, else it will return "(mapper): Don't know how to get there from here :(".
hasExitLock
- status = hasExitLock(roomID, direction)
- Returns true or false depending on whenever a given exit leading out from a room is locked. direction right now is a number that corresponds to the direction:
exitmap = {
n = 1,
north = 1,
ne = 2,
northeast = 2,
nw = 3,
northwest = 3,
e = 4,
east = 4,
w = 5,
west = 5,
s = 6,
south = 6,
se = 7,
southeast = 7,
sw = 8,
southwest = 8,
u = 9,
up = 9,
d = 10,
down = 10,
["in"] = 11,
out = 12
}
- Example
<lua> -- check if the east exit of room 1201 is locked display(hasExitLock(1201, 4)) </lua>
- See also: lockExit()
hasSpecialExitLock
- status = hasSpecialExitLock(from roomID, to roomID, command)
- Returns true or false depending on whenever a given exit leading out from a room is locked. command is the action to take to get through the gate.
<lua> -- lock a special exit from 17463 to 7814 that uses the 'enter feather' command lockSpecialExit(17463, 7814, 'enter feather', true)
-- see if it is locked: it will say 'true', it is display(hasSpecialExitLock(17463, 7814, 'enter feather')) </lua>
highlightRoom
- highlightRoom( id, r1,g1,b1,r2,g2,b2, radius, alpha1, alpha2)
- Highlights a room with the given color, which will override it's environment color. If you use two different colors, then there'll be a shading from the center going outwards that changes into the other color. highlightRadius is the radius for the highlight circle - if you don't want rooms beside each other to over lap, use 1 as the radius. alphaColor1 and alphaColor2 are transparency values from 0 (completely transparent) to 255 (not transparent at all).
- See also: unHighlightRoom()
Note: Available since Mudlet 2.0 final release
<lua> -- color room #351 red to blue local r,g,b = unpack(color_table.red) local br,bg,bb = unpack(color_table.blue) highlightRoom(351, r,g,b,br,bg,bb, 1, 255, 255) </lua>
exportAreaImage
- exportAreaImage(areaID)
- Exports the area as an image into your profile's directory.
- Example
<lua> -- save the area with ID 1 as a map exportAreaImage(1) </lua>
loadMap
- boolean = loadMap(file location)
- Loads the map file from a given location. The map file must be in Mudlet's format (not XML or any other) - saved with saveMap().
- Returns a boolean for whenever the loading succeeded. Note that the mapper must be open, or this will fail.
- See also: saveMap()
<lua>
loadMap("/home/user/Desktop/Mudlet Map.dat")
</lua>
lockExit
- lockExit(roomID, direction, lock = true/false)
- Locks a given exit from a room (which means that unless all exits in the incoming room are locked, it'll still be accessible). Direction at the moment is only set as a number, and here's a listing of them:
exitmap = {
n = 1,
north = 1,
ne = 2,
northeast = 2,
nw = 3,
northwest = 3,
e = 4,
east = 4,
w = 5,
west = 5,
s = 6,
south = 6,
se = 7,
southeast = 7,
sw = 8,
southwest = 8,
u = 9,
up = 9,
d = 10,
down = 10,
["in"] = 11,
out = 12
}
- Example
<lua> -- lock the east exit of room 1201 so we never path through it lockExit(1201, 4, true) </lua>
- See also: hasExitLock()
lockRoom
- lockRoom (roomID, lock = true/false)
- Locks a given room id from future speed walks (thus the mapper will never path through that room).
- See also: roomLocked()
- Example
<lua> lockRoom(1, true) -- locks a room if from being walked through when speedwalking. lockRoom(1, false) -- unlocks the room, adding it back to possible rooms that can be walked through. </lua>
lockSpecialExit
- lockSpecialExit (from roomID, to roomID, special exit command, lock = true/false)
- Locks a given special exit, leading from one specific room to another that uses a certain command from future speed walks (thus the mapper will never path through that special exit).
- See also: hasSpecialExitLock(), lockExit(), lockRoom()
- Example
<lua> lockSpecialExit(1,2,'enter gate', true) -- locks the special exit that does 'enter gate' to get from room 1 to room 2 lockSpecialExit(1,2,'enter gate', false) -- unlocks the said exit </lua>
removeMapEvent
- removeMapEvent (event name)
- Removes the given menu entry from a mappers right-click menu. You can add custom ones with addMapEvent().
- See also: addMapEvent(), addMapMenu(), getMapEvents()
- Example
<lua> addMapEvent("room a", "onFavorite") -- add one to the general menu removeMapEvent("room a") -- removes the said menu </lua>
roomExists
- roomExists(roomID)
- Returns a boolean true/false depending if the room with that ID exists (is created) or not.
roomLocked
- locked = roomLocked(roomID)
- Returns true or false whenever a given room is locked.
- See also: lockRoom()
- Example
<lua> echo(string.format("Is room #4545 locked? %s.", roomLocked(4545) and "Yep" or "Nope")) </lua>
saveMap
- saveMap(location)
- Saves the map to a given location, and returns true on success. The location folder needs to be already created for save to work.
- See also: loadMap()
- Example
<lua> local savedok = saveMap(getMudletHomeDir().."/my fancy map.dat") if not savedok then
echo("Couldn't save :(\n")
else
echo("Saved fine!\n")
end </lua>
searchRoom
- searchRoom (room name)
- Searches for rooms that match (by case-insensitive, substring match) the given room name. It returns a key-value table in form of roomid = roomname, like so:
- Example
<lua> display(searchRoom("master"))
--[[ would result in: table {
17463: 'in the branches of the Master Ravenwood' 3652: 'master bedroom' 10361: 'Hall of Cultural Masterpieces' 6324: 'Exhibit of the Techniques of the Master Artisans' 5340: 'office of the Guildmaster' (...) 2004: 'office of the guildmaster' 14457: 'the Master Gear' 1337: 'before the Master Ravenwood Tree'
} ]]</lua>
If no rooms are found, then an empty table is returned.
setAreaName
- setAreaName(areaID, newName)
- Names, or renames an existing area to the new name. The area must be created first with addAreaName().
- See also: deleteArea(), addAreaName()
- Example
<lua> setAreaName(2, "My city") </lua>
setCustomEnvColor
- 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.
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.
- Example
<lua> setRoomEnv(571, 200) -- change the room's environment ID to something arbitrary, like 200 local r,g,b = unpack(color_table.blue) setCustomEnvColor(200, r,g,b, 255) -- set the color of environmentID 200 to blue </lua>
setDoor
- setDoor(roomID, exitCommand, doorStatus)
- Creates or deletes a door in a room. Doors are purely visual - they don't affect pathfinding. You can use the information to change to adjust your speedwalking path based on the door information in a room, though.
- Parameters
- roomID:
- Room ID to to create the door in.
- exitCommand:
- The cardinal direction for the door is in - it can be one of the following: e,s,w,n,ne,se,sw,ne.
- doorStatus:
- The door status as a number - 0 means remove door, 1 means open door (will draw a green square on exit), 2 means closed door (yellow square) and 3 means closed door (red square).
- See also: getDoors()
- Example
<lua> -- make a door on the east exit of room 4234 that is currently open setDoor(4234, 'e', 1)
-- remove a door from room 923 that points north setDoor(923, 'n', 0) </lua>
setExit
- setExit(from roomID, to roomID, direction)
- Creates a one-way exit from one room to another using a standard direction - which can be either one of n, ne, nw, e, w, s, se, sw, u, d, in, out, or a number which represents a direction. If there was an exit stub in that direction already, then it will be automatically deleted for you.
- Returns false if the exit creation didn't work.
- Example
<lua> -- alias pattern: ^exit (\d+) (\d+) (\w+)$ -- so exit 1 2 5 will make an exit from room 1 to room 2 via north
if setExit(tonumber(matches[2]), tonumber(matches[3]), matches[4]) then
echo("\nExit set to room:"..matches[3].." from "..matches[2]..", direction:"..string.upper(matches[3]))
else
echo("Failed to set the exit.\n")
end </lua>
This function can also delete exits from a room if you use it like so:
<lua>setExit(from roomID, -1, direction)</lua>
- which will delete an outgoing exit in the specified direction from a room.
setExitStub
- setExitStub(roomid, direction, set/unset)
Creates or removes an exit stub from a room in a given directions. You can use exit stubs later on to connect rooms that you're sure of are together. Exit stubs are also shown visually on the map, so the mapper can easily tell which rooms need finishing.
- Parameters
- roomid:
- The room to place an exit stub in, as a number.
- direction:
- The direction the exit stub should lead in, as a number (to use a direction name, see exitmap)
- set/unset:
- A boolean to create or delete the exit stub.
- See also: getExitStubs(), connectExitStub()
<lua> -- make an exit stub to the south from room 6 setExitStub(8, 6, true)
-- or using an exitmap (http://wiki.mudlet.org/w/Mapping_script#Translating_directions): setExitStub(8, exitmap.s,true) </lua>
<lua> -- example on how to delete all exit stubs in a room: for i,v in pairs(getExitStubs(roomID)) do
setExitStub(roomID, v,false)
end </lua>
setExitWeight
- setExitWeight(roomID, exitCommand, weight)
- Gives an exit a weight, which makes it less likely to be chosen for pathfinding. All exits have a weight of 0 by default, which you can increase. Exit weights are set one-way on an exit - if you'd like the weight to be applied both ways, set it from the reverse room and direction as well.
- Parameters
- roomID:
- Room ID to to set the weight in.
- exitCommand:
- The the direction for the exit is in - it can be one of the following: e,s,w,n,ne,se,sw,ne,up,down,in,out, or if it's a special exit, the special exit command.
- weight:
- Exit weight - by default, all exits have a weight of 0. Increasing the weight will make the room less likely be chosen for pathfinding.
- See also: getExitWeights()
setGridMode
- setGridMode(area, true/false)
- Enables grid/wilderness view mode for an area - this will cause the rooms to lose their visible exit connections, like you'd see on compressed ASCII maps, both in 2D and 3D view mode.
- Example
<lua> setGridMode(55,true) -- set area with ID 55 to be in grid mode </lua>
setMapZoom
- setMapZoom(zoom)
- Zooms the map in to a given zoom level. 1 is the closest you can get, and anything higher than that zooms the map out. Call centerview() after you set the zoom to refresh the map.
- Example
<lua> setMapZoom(10) -- zoom to a somewhat acceptable level, a bit big but easily visible connections </lua>
setModulePriority
- setModulePriority(module name, priority #)
- Sets the module priority on a given module as a number - the module priority determines the order modules are loaded in, which can be helpful if you have ones dependent on each other. This can also be set from the module manager window.
- See also: getModulePriority()
<lua> setModulePriority("mudlet-mapper", 1) </lua>
setRoomArea
- setRoomArea(roomID, newAreaID)
- Assigns the given room to a new area. This will have the room be visually moved into the area as well.
setRoomChar
- setRoomChar(roomID, character)
- Designed for an area in grid mode, this will set a single character to be on a room. You can use "_" to clear it.
- Example
<lua> setRoomChar(431, "#")
setRoomChar(123. "$") </lua>
setRoomCoordinates
- setRoomCoordinates(roomID, x, y, z)
- Sets the given room ID to be at the following coordinates visually on the map, where z is the up/down level.
Note: 0,0,0 is the center of the map.
- Example
<lua> -- alias pattern: ^set rc (-?\d+) (-?\d+) (-?\d+)$ local x,y,z = getRoomCoordinates(previousRoomID) local dir = matches[2]
if dir == "n" then
y = y+1
elseif dir == "ne" then
y = y+1 x = x+1
elseif dir == "e" then
x = x+1
elseif dir == "se" then
y = y-1 x = x+1
elseif dir == "s" then
y = y-1
elseif dir == "sw" then
y = y-1 x = x-1
elseif dir == "w" then
x = x-1
elseif dir == "nw" then
y = y+1 x = x-1
elseif dir == "u" or dir == "up" then
z = z+1
elseif dir == "down" then
z = z-1
end setRoomCoordinates(roomID,x,y,z) centerview(roomID) </lua>
- You can make them relative as well:
<lua> -- alias pattern: ^src (\w+)$
local x,y,z = getRoomCoordinates(previousRoomID) local dir = matches[2]
if dir == "n" then
y = y+1
elseif dir == "ne" then
y = y+1 x = x+1
elseif dir == "e" then
x = x+1
elseif dir == "se" then
y = y-1 x = x+1
elseif dir == "s" then
y = y-1
elseif dir == "sw" then
y = y-1 x = x-1
elseif dir == "w" then
x = x-1
elseif dir == "nw" then
y = y+1 x = x-1
elseif dir == "u" or dir == "up" then
z = z+1
elseif dir == "down" then
z = z-1
end setRoomCoordinates(roomID,x,y,z) centerview(roomID) </lua>
setRoomEnv
- setRoomEnv(roomID, newEnvID)
- Sets the given room to a new environment ID. You don't have to use any functions to create it - can just set it right away.
- Example
<lua> setRoomEnv(551, 34) -- set room with the ID of 551 to the environment ID 34 </lua>
setRoomIDbyHash
- setRoomIDbyHash(roomID, hash)
- Sets the hash to be associated with the given roomID. See also getRoomIDbyHash().
setRoomName
- setRoomName(roomID, newName)
- Renames an existing room to a new name.
- Example
<lua> setRoomName(534, "That evil room I shouldn't visit again.") lockRoom(534, true) -- and lock it just to be safe </lua>
setRoomUserData
- setRoomUserData(roomID, key (as a string), value (as a string))
- Stores information about a room under a given key. Similar to Lua's key-value tables, except only strings may be used here. One advantage of using userdata is that it's stored within the map file itself - so sharing the map with someone else will pass on the user data. You can have as many keys as you'd like.
- Returns true if successfully set.
- See also: clearRoomUserData()
- Example
<lua> -- can use it to store room descriptions... setRoomUserData(341, "description", "This is a plain-looking room.")
-- or whenever it's outdoors or not... setRoomUserData(341, "ourdoors", "true")
-- how how many times we visited that room local visited = getRoomUserData(341, "visitcount") visited = (tonumber(visited) or 0) + 1 setRoomUserData(341, "visitcount", tostring(visited))
-- can even store tables in it, using the built-in yajl.to_string function setRoomUserData(341, "some table", yajl.to_string({name = "bub", age = 23})) display("The denizens name is: "..yajl.to_value(getRoomUserData(341, "some table")).name) </lua>
setRoomWeight
- setRoomWeight(roomID, weight)
- Sets a weight to the given roomID. By default, all rooms have a weight of 1 - the higher the weight is, the more likely the room is to be avoided for pathfinding. For example, if travelling across water rooms takes more time than land ones - then you'd want to assign a weight to all water rooms, so they'd be avoided if there are possible land pathways.
Note: The minimum allowed room weight is 1.
- To completely avoid a room, make use of lockRoom().
- See also: getRoomWeight()
- Example
<lua> setRoomWeight(1532, 3) -- avoid using this room if possible, but don't completely ignore it </lua>
speedwalk
- speedwalk(dirString, backwards, delay)
- A speedwalking function will work on cardinal+ordinal directions (n, ne, e, etc.) as well as u (for up), d (for down), in and out. It can be called to execute all directions directly after each other, without delay, or with a custom delay, depending on how fast your mud allows you to walk. It can also be called with a switch to make the function reverse the whole path and lead you backwards.
- Call the function by doing:
speedwalk("YourDirectionsString", true/false, delaytime)
- The delaytime parameter will set a delay between each move (set it to 0.5 if you want the script to move every half second, for instance). It is optional: If you don't indicate it, the script will send all direction commands right after each other. (If you want to indicate a delay, you -have- explicitly indicate true or false for the reverse flag.)
- The "YourDirectionsString" contains your list of directions and steps (e.g.: "2n, 3w, u, 5ne"). Numbers indicate the number of steps you want it to walk in the direction specified after it. The directions must be separated by anything other than a letter that can appear in a direction itself. (I.e. you can separate with a comma, spaces, the letter x, etc. and any such combinations, but you cannot separate by the letter "e", or write two directions right next to each other with nothing in-between, such as "wn". If you write a number before every direction, you don't need any further separator. E.g. it's perfectly acceptable to write "3w1ne2e".) The function is not case-sensitive.
- If your Mud only has cardinal directions (n,e,s,w and possibly u,d) and you wish to be able to write directions right next to each other like "enu2s3wdu", you'll have to change the pattern slightly. (See the link at the beginning of my post for something like that.)
- Likewise, if your Mud has any other directions than n, ne, e, se, s, sw, w, nw, u, d, in, out, the function must be adapted to that.
- Example
<lua> speedwalk("16d1se1u") -- Will walk 16 times down, once southeast, once up. All in immediate succession.
speedwalk("2ne,3e,2n,e") -- Will walk twice northeast, thrice east, twice north, once east. All in immediate succession.
speedwalk("IN N 3W 2U W", false, 0.5) -- Will walk in, north, thrice west, twice up, west, with half a second delay between every move.
speedwalk("5sw - 3s - 2n - w", true) -- Will walk backwards: east, twice south, thrice, north, five times northeast. All in immediate succession.
speedwalk("3w, 2ne, w, u", true, 1.25) -- Will walk backwards: down, east, twice southwest, thrice east, with 1.25 seconds delay between every move. </lua>
Note: The probably most logical usage of this would be to put it in an alias. For example, have the pattern ^/(.+)$ execute:
speedwalk(matches[2], false, 0.7)
And have ^//(.+)$ execute: speedwalk(matches[2], true, 0.7)
Or make aliases like: ^banktohome$ to execute <lua>speedwalk("2ne,e,ne,e,3u,in", true, 0.5)</lua>
unHighlightRoom
- unHighlightRoom(roomID)
- Unhighlights a room if it was previously highlighted and restores the rooms original environment color.
- See also: highlightRoom()
Note: Available since Mudlet 2.0 final release
- Example
<lua> unHighlightRoom(4534) </lua>