Map

Defines the Map Component.

Summary
MapDefines the Map Component.
Functions
new
New MapA container for Mudlet’s built-in Map display.
Variables
containerParent Frame.
is_hiddenSpecial handling for special Map hiding.
Properties
Map Properties
Functions
updateAbsolutesSets the actual size and position of the Map using the parent Frame’s Content.
DrawThe map magically appears! 
ResizeAdjusts the Map’s size.
MoveMoves the Map.
HideHides the Map.
ShowReturns the Map to its original size.

Functions

new

local function new (_,
init_x,
init_y,
init_width,
init_height)

Parameters

init_xMapper’s initial X coordinate.
init_yMapper’s initial Y coordinate.
init_widthMapper’s initial Width.
init_heightMapper’s initial Height.

New Map

A container for Mudlet’s built-in Map display.

Summary
Variables
containerParent Frame.
is_hiddenSpecial handling for special Map hiding.
Properties
Map Properties
Functions
updateAbsolutesSets the actual size and position of the Map using the parent Frame’s Content.
DrawThe map magically appears! 
ResizeAdjusts the Map’s size.
MoveMoves the Map.
HideHides the Map.
ShowReturns the Map to its original size.

Variables

container

local container

Parent Frame.

is_hidden

local is_hidden

Special handling for special Map hiding.

Properties

Map Properties

ContainerGets and sets the Map’s parent Frame.
XGets and sets the user-defined X coordinate.
AbsoluteXReturns the actual X coordinate.
YGets and sets the user-defined Y coordinate.
AbsoluteYReturns the actual Y coordinate.
WidthGets and sets the user-defined width.
AbsoluteWidthReturns the actual width.
HeightGets and sets the user-defined height.
AbsoluteHeightReturns the actual height.

Functions

updateAbsolutes

local function updateAbsolutes ()

Sets the actual size and position of the Map using the parent Frame’s Content.

Draw

function new_map:Draw ()

The map magically appears!  Probably best used internally only.

Resize

function new_map:Resize (new_width,
new_height)

Adjusts the Map’s size.

Parameters

new_widthMap’s new width.
new_heightMap’s new height.

Move

function new_map:Move (new_x,
new_y)

Moves the Map.

Parameters

new_xMap’s new relative X coordinate.
new_yMap’s new relative Y coordinate.

Hide

function new_map:Hide ()

Hides the Map.  Sort of.  Makes it very, very tiny.

Show

function new_map:Show ()

Returns the Map to its original size.

local function new (_,
init_x,
init_y,
init_width,
init_height)
local container
Parent Frame.
local is_hidden
Special handling for special Map hiding.
local function updateAbsolutes ()
Sets the actual size and position of the Map using the parent Frame’s Content.
function new_map:Draw ()
The map magically appears! 
function new_map:Resize (new_width,
new_height)
Adjusts the Map’s size.
function new_map:Move (new_x,
new_y)
Moves the Map.
function new_map:Hide ()
Hides the Map.
function new_map:Show ()
Returns the Map to its original size.
Close