Module guih

The Main module

Functions

new (terminal[, event_offset_x[, event_offset_y]]) Make a new Gui object with the given terminal/window and optionaly event offset
create_gui () Alias for guih.new
load_texture (path) Used for loading basic textures similiar to the nimg format
convert_event (event) Processes an event into a more usable format

Tables

apis All of the additional GuiH apis loaded
presets All of the additional GuiH presets loaded


Functions

new (terminal[, event_offset_x[, event_offset_y]])
Make a new Gui object with the given terminal/window and optionaly event offset

Parameters:

  • terminal table term/window object
  • event_offset_x number sets the horizontal offset of all events (optional)
  • event_offset_y number sets the vertical offset of all events (optional)

Returns:

    table guih.main_ui

Usage:

    local GuiH = require("GuiH")
    local gui = guih.new(term.current())
    print(gui)
create_gui ()
Alias for guih.new

See also:

load_texture (path)
Used for loading basic textures similiar to the nimg format

Parameters:

  • path string/table Path to the texture or the texture data in a table

Returns:

    table guih.texture

Usage:

    local GuiH = require("GuiH")
    local texture = guih.load_texture({})
    print(texture)
convert_event (event)
Processes an event into a more usable format

Parameters:

  • event all of the events results unpacked

Returns:

    table guih.event

Tables

apis
All of the additional GuiH apis loaded

See also:

presets
All of the additional GuiH presets loaded

See also:

generated by LDoc 1.4.6 Last updated 2022-06-23 16:51:50