User:Molideus - Revision history

Vadi at 22:31, 24 December 2024

2024-12-24T22:31:10Z

Show changes

Molideus at 07:18, 21 July 2024

2024-07-21T07:18:50Z

Show changes

Molideus at 07:16, 21 July 2024

2024-07-21T07:16:50Z

Show changes

Molideus at 07:07, 21 July 2024

2024-07-21T07:07:47Z

Molideus at 07:07, 21 July 2024

2024-07-21T07:07:45Z

Molideus at 07:07, 21 July 2024

2024-07-21T07:07:40Z

Show changes

Molideus at 07:05, 21 July 2024

2024-07-21T07:05:51Z

Show changes

Molideus at 11:42, 11 July 2024

2024-07-11T11:42:45Z

Show changes

Molideus at 21:18, 7 July 2024

2024-07-07T21:18:12Z

Molideus at 21:18, 7 July 2024

2024-07-07T21:18:07Z

@@ Line 166: / Line 166: @@
 -- all of the above will return the 'true'  boolean value assuming there are rooms with 1 and 2 as ID numbers
 </syntaxhighlight>
 =Miscellaneous Functions=

@@ Line 191: / Line 191: @@
 =Miscellaneous Functions=
 : Miscellaneous functions.
 ==loadVideoFile, PR #6439==

← Older revision		Revision as of 21:18, 7 July 2024
Line 59:		Line 59:

	::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).		::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\|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: [[Manual:Mapper_Functions#getMapLabels\|getMapLabels()]], [[Manual:Mapper_Functions#getMapLabel\|getMapLabel()]].~~
−
−	~~{{MudletVersion\| ?.??}}~~
−
−	~~{{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~~
−	~~<syntaxhighlight lang="lua">~~
−	~~-- move the first label in the area with the ID number of 2, three spaces to the east and four spaces to the north~~
−	~~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~~
−	~~</syntaxhighlight>~~
−
−	~~==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 [[Manual:Mapper_Functions#setRoomCoordinates\|setRoomCoordinates()]] which only moves the starting point of such custom exit lines so that they still emerge from the room to which they belong but otherwise remain pointing to the original place.
−
−	~~:See also: [[Manual:Mapper_Functions#setRoomCoordinates\|setRoomCoordinates()]]~~
−
−	~~{{MudletVersion\| ?.??}}~~
−
−	~~{{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~~
−	~~<syntaxhighlight lang="lua">~~
−	~~-- 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~~
−	~~</syntaxhighlight>~~
−
−	~~==setupMapSymbolFont, PR #4038 closed==~~
−	~~;setupMapSymbolFont(fontName[, onlyUseThisFont[, scalingFactor]])~~
−	~~:configures the font used for symbols in the (2D) map.~~
−	~~: See also: [[#mapSymbolFontInfo\|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=

← Older revision		Revision as of 21:18, 7 July 2024
Line 59:		Line 59:

	::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).		::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\|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: [[Manual:Mapper_Functions#getMapLabels\|getMapLabels()]], [[Manual:Mapper_Functions#getMapLabel\|getMapLabel()]].
		+
		+	{{MudletVersion\| ?.??}}
		+
		+	{{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
		+	<syntaxhighlight lang="lua">
		+	-- move the first label in the area with the ID number of 2, three spaces to the east and four spaces to the north
		+	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
		+	</syntaxhighlight>
		+
		+	==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 [[Manual:Mapper_Functions#setRoomCoordinates\|setRoomCoordinates()]] which only moves the starting point of such custom exit lines so that they still emerge from the room to which they belong but otherwise remain pointing to the original place.
		+
		+	:See also: [[Manual:Mapper_Functions#setRoomCoordinates\|setRoomCoordinates()]]
		+
		+	{{MudletVersion\| ?.??}}
		+
		+	{{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
		+	<syntaxhighlight lang="lua">
		+	-- 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
		+	</syntaxhighlight>

	==setupMapSymbolFont, PR #4038 closed==		==setupMapSymbolFont, PR #4038 closed==