Options

This object maintains option state for Vyzor.

Summary
OptionsThis object maintains option state for Vyzor.
Variables
default_draw_orderDefault draw order for Border Frames.
draw_orderDetermines layering for Border Frames.
default_bordersDefault state for Border Frames.
bordersDetermines Border Frame size.
default_handle_bordersDefault setting for determing whether or not Vyzor handles Mudlet’s borders.
handle_bordersDetermines whether or not Vyzor handles Mudlet’s borders.
default_console_heightDefault height of main console is window height.
console_heightUser-defined height for main console.
Properties
Option Properties
Functions
ResetResets all Options to default values.

Variables

default_draw_order

local default_draw_order

Default draw order for Border Frames.

draw_order

local draw_order

Determines layering for Border Frames.

default_borders

local default_borders

Default state for Border Frames.

borders

local borders

Determines Border Frame size.

default_handle_borders

local default_handle_borders

Default setting for determing whether or not Vyzor handles Mudlet’s borders.

handle_borders

local handle_borders

Determines whether or not Vyzor handles Mudlet’s borders.

default_console_height

local _,default_console_height

Default height of main console is window height.

console_height

local console_height

User-defined height for main console.

Properties

Option Properties

DrawOrderTODO: Will determine z-layer ordering for Border Frames.
BordersReturns a table containing options.  Sets Border options via a table.
ConsoleHeightSets and gets a user-defined main console height.
HandleBordersGets and sets a value that determines whether or not Vyzor handles Mudlet’s borders.  If true, then Vyzor will always resize Mudlet’s borders.  If auto, it will only assume control after the Vyzor.HUD:Draw() has been called.

Functions

Reset

function Options:Reset ()

Resets all Options to default values.

local default_draw_order
Default draw order for Border Frames.
local draw_order
Determines layering for Border Frames.
local default_borders
Default state for Border Frames.
local borders
Determines Border Frame size.
local default_handle_borders
Default setting for determing whether or not Vyzor handles Mudlet’s borders.
local handle_borders
Determines whether or not Vyzor handles Mudlet’s borders.
local _,default_console_height
Default height of main console is window height.
local console_height
User-defined height for main console.
function Options:Reset ()
Resets all Options to default values.
Close