Class Map
A container for Mudlet's built-in Map display.
-
self:Draw ()
-
The map magically appears! Best used internally only.
-
self:Resize ([width[, height]])
-
Adjusts the Map's size.
Parameters:
- width
number
Map's new width.
(optional)
- height
number
Map's new height.
(optional)
-
self:Move (x, y)
-
Moves the Map.
Parameters:
- x
number
Map's new relative X coordinate.
- y
number
Map's new relative Y coordinate.
-
self:Hide ()
-
Hides the Map.
Technically, it makes the Map very, very tiny.
-
self:Show ()
-
Returns the Map to its original size.
-
Map:Map ([initialX=0[, initialY=0[, initialWidth=1.0[, initialHeight=1.0]]]])
-
Map constructor.
Parameters:
- initialX
number
The Map's initial X coordinate.
(default 0)
- initialY
number
The Map's initial Y coordinate.
(default 0)
- initialWidth
number
The Map's initial Width.
(default 1.0)
- initialHeight
number
The Map's initial Height.
(default 1.0)
Returns:
Map
-
self.Container.get ()
-
Returns the Map's parent Frame.
Returns:
Frame
-
self.Container.set (value)
-
Sets the Map's parent Frame.
Parameters:
-
self.X.get ()
-
Returns the Map's user-defined X coordinate.
Returns:
number
-
self.X.set (value)
-
Sets the Map's user-defined X coordinate.
Parameters:
-
self.AbsoluteX.get ()
-
Returns the Map's actual X coordinate.
Returns:
number
-
self.Y.get ()
-
Returns the Map's user-defined Y coordinate.
Returns:
number
-
self.Y.set (value)
-
Sets the Map's user-defined Y coordinate.
Parameters:
-
self.AbsoluteY.get ()
-
Returns the Map's actual Y coordinate.
Returns:
number
-
self.Width.get ()
-
Returns the Map's user-defined width.
Returns:
number
-
self.Width.set (value)
-
Sets the Map's user-defined width.
Parameters:
-
self.AbsoluteWidth.get ()
-
Returns the Map's actual width.
Returns:
number
-
self.Height.get ()
-
Returns the Map's user-defined height.
Returns:
number
-
self.Height.set (value)
-
Sets the Map's user-defined height.
Parameters:
-
self.AbsoluteHeight.get ()
-
Returns the Map's actual height.
Returns:
number