Module Options

Maintains option state for all of Vyzor.

Functions

Reset () Resets all option to their default values.
DrawOrder.get () Returns the z-layer ordering for Border Frames.
DrawOrder.set (value) Sets the z-layer ordering for Border Frames.
Borders.get () Returns the options for Border Frame resizing.
Borders.set (value) Sets the options for Border Frame resizing.
ConsoleHeight.get () Returns the console height as managed by Vyzor.
ConsoleHeight.set (value) Sets the console height to be managed by Vyzor.
HandleBorders.get () Returns the method Vyzor is using to handle resizing Border Frames.
HandleBorders.set (value) Determines how Vyzor handles the resizing of Border Frames.


Functions

Reset ()
Resets all option to their default values.
DrawOrder.get ()
Returns the z-layer ordering for Border Frames.

Returns:

    table
DrawOrder.set (value)
Sets the z-layer ordering for Border Frames.

Parameters:

  • value table A table containing VyzorBorder enums.
Borders.get ()
Returns the options for Border Frame resizing.

Returns:

    table
Borders.set (value)
Sets the options for Border Frame resizing.

Parameters:

  • value table A table containing VyzorBorder keys.
ConsoleHeight.get ()
Returns the console height as managed by Vyzor.

Returns:

    number
ConsoleHeight.set (value)
Sets the console height to be managed by Vyzor.

Parameters:

  • value number The height of the main console.
HandleBorders.get ()
Returns the method Vyzor is using to handle resizing Border Frames.

Returns:

    string or bool
HandleBorders.set (value)
Determines how Vyzor handles the resizing of Border Frames.

Parameters:

  • value string or bool 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.
generated by LDoc 1.4.6 Last updated 2017-11-15 22:27:55