From 1edee7f64b9b3660f56a72e40c28d56416400e02 Mon Sep 17 00:00:00 2001 From: Mikayla Fischler Date: Sun, 9 Jul 2023 23:42:44 -0400 Subject: [PATCH] updated graphics comments --- graphics/elements/animations/waiting.lua | 2 +- graphics/elements/colormap.lua | 2 +- graphics/elements/controls/checkbox.lua | 2 +- graphics/elements/controls/hazard_button.lua | 2 +- graphics/elements/controls/multi_button.lua | 2 +- graphics/elements/controls/push_button.lua | 2 +- graphics/elements/controls/radio_button.lua | 2 +- graphics/elements/controls/sidebar.lua | 2 +- graphics/elements/controls/spinbox_numeric.lua | 2 +- graphics/elements/controls/switch_button.lua | 2 +- graphics/elements/controls/tabbar.lua | 2 +- graphics/elements/div.lua | 2 +- graphics/elements/indicators/alight.lua | 2 +- graphics/elements/indicators/coremap.lua | 2 +- graphics/elements/indicators/data.lua | 2 +- graphics/elements/indicators/hbar.lua | 2 +- graphics/elements/indicators/icon.lua | 2 +- graphics/elements/indicators/led.lua | 2 +- graphics/elements/indicators/ledpair.lua | 2 +- graphics/elements/indicators/ledrgb.lua | 2 +- graphics/elements/indicators/light.lua | 2 +- graphics/elements/indicators/power.lua | 2 +- graphics/elements/indicators/rad.lua | 2 +- graphics/elements/indicators/state.lua | 2 +- graphics/elements/indicators/trilight.lua | 2 +- graphics/elements/indicators/vbar.lua | 2 +- graphics/elements/listbox.lua | 2 +- graphics/elements/multipane.lua | 2 +- graphics/elements/pipenet.lua | 2 +- graphics/elements/rectangle.lua | 2 +- graphics/elements/textbox.lua | 2 +- graphics/elements/tiling.lua | 2 +- 32 files changed, 32 insertions(+), 32 deletions(-) diff --git a/graphics/elements/animations/waiting.lua b/graphics/elements/animations/waiting.lua index 286c82e..77aacdb 100644 --- a/graphics/elements/animations/waiting.lua +++ b/graphics/elements/animations/waiting.lua @@ -8,7 +8,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/colormap.lua b/graphics/elements/colormap.lua index be92d83..4d84e8b 100644 --- a/graphics/elements/colormap.lua +++ b/graphics/elements/colormap.lua @@ -8,7 +8,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field hidden? boolean true to hide on initial draw -- new color map diff --git a/graphics/elements/controls/checkbox.lua b/graphics/elements/controls/checkbox.lua index 2867d8b..b8557ae 100644 --- a/graphics/elements/controls/checkbox.lua +++ b/graphics/elements/controls/checkbox.lua @@ -10,7 +10,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/controls/hazard_button.lua b/graphics/elements/controls/hazard_button.lua index 4745f4f..fcec4bd 100644 --- a/graphics/elements/controls/hazard_button.lua +++ b/graphics/elements/controls/hazard_button.lua @@ -14,7 +14,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/controls/multi_button.lua b/graphics/elements/controls/multi_button.lua index 279c9a7..020c68d 100644 --- a/graphics/elements/controls/multi_button.lua +++ b/graphics/elements/controls/multi_button.lua @@ -20,7 +20,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field height? integer parent height if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/controls/push_button.lua b/graphics/elements/controls/push_button.lua index e6f4920..5644e59 100644 --- a/graphics/elements/controls/push_button.lua +++ b/graphics/elements/controls/push_button.lua @@ -16,7 +16,7 @@ local CLICK_TYPE = core.events.CLICK_TYPE ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field height? integer parent height if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/controls/radio_button.lua b/graphics/elements/controls/radio_button.lua index e3edf24..0063bee 100644 --- a/graphics/elements/controls/radio_button.lua +++ b/graphics/elements/controls/radio_button.lua @@ -13,7 +13,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/controls/sidebar.lua b/graphics/elements/controls/sidebar.lua index d43317a..977481c 100644 --- a/graphics/elements/controls/sidebar.lua +++ b/graphics/elements/controls/sidebar.lua @@ -17,7 +17,7 @@ local CLICK_TYPE = core.events.CLICK_TYPE ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field height? integer parent height if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/controls/spinbox_numeric.lua b/graphics/elements/controls/spinbox_numeric.lua index 767d97b..1cdfa26 100644 --- a/graphics/elements/controls/spinbox_numeric.lua +++ b/graphics/elements/controls/spinbox_numeric.lua @@ -16,7 +16,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/controls/switch_button.lua b/graphics/elements/controls/switch_button.lua index 6d2e09c..92fd9a5 100644 --- a/graphics/elements/controls/switch_button.lua +++ b/graphics/elements/controls/switch_button.lua @@ -12,7 +12,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field height? integer parent height if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/controls/tabbar.lua b/graphics/elements/controls/tabbar.lua index da4738b..0989534 100644 --- a/graphics/elements/controls/tabbar.lua +++ b/graphics/elements/controls/tabbar.lua @@ -18,7 +18,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field width? integer parent width if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/div.lua b/graphics/elements/div.lua index 4b6bd6a..0af3259 100644 --- a/graphics/elements/div.lua +++ b/graphics/elements/div.lua @@ -6,7 +6,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field width? integer parent width if omitted ---@field height? integer parent height if omitted ---@field gframe? graphics_frame frame instead of x/y/width/height diff --git a/graphics/elements/indicators/alight.lua b/graphics/elements/indicators/alight.lua index ff9b1ad..b3e9ab8 100644 --- a/graphics/elements/indicators/alight.lua +++ b/graphics/elements/indicators/alight.lua @@ -16,7 +16,7 @@ local flasher = require("graphics.flasher") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/indicators/coremap.lua b/graphics/elements/indicators/coremap.lua index 127a8a3..997bec8 100644 --- a/graphics/elements/indicators/coremap.lua +++ b/graphics/elements/indicators/coremap.lua @@ -11,7 +11,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted -- new core map box ---@nodiscard diff --git a/graphics/elements/indicators/data.lua b/graphics/elements/indicators/data.lua index 9282a03..5717d2c 100644 --- a/graphics/elements/indicators/data.lua +++ b/graphics/elements/indicators/data.lua @@ -14,7 +14,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field width integer length ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/indicators/hbar.lua b/graphics/elements/indicators/hbar.lua index 9bee59f..0d61374 100644 --- a/graphics/elements/indicators/hbar.lua +++ b/graphics/elements/indicators/hbar.lua @@ -10,7 +10,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field width? integer parent width if omitted ---@field height? integer parent height if omitted ---@field gframe? graphics_frame frame instead of x/y/width/height diff --git a/graphics/elements/indicators/icon.lua b/graphics/elements/indicators/icon.lua index 03c88fb..710fa5b 100644 --- a/graphics/elements/indicators/icon.lua +++ b/graphics/elements/indicators/icon.lua @@ -16,7 +16,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/indicators/led.lua b/graphics/elements/indicators/led.lua index 077cab3..f81d7e9 100644 --- a/graphics/elements/indicators/led.lua +++ b/graphics/elements/indicators/led.lua @@ -14,7 +14,7 @@ local flasher = require("graphics.flasher") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/indicators/ledpair.lua b/graphics/elements/indicators/ledpair.lua index 47c9a0a..97099d2 100644 --- a/graphics/elements/indicators/ledpair.lua +++ b/graphics/elements/indicators/ledpair.lua @@ -16,7 +16,7 @@ local flasher = require("graphics.flasher") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/indicators/ledrgb.lua b/graphics/elements/indicators/ledrgb.lua index dbcb947..8c9802f 100644 --- a/graphics/elements/indicators/ledrgb.lua +++ b/graphics/elements/indicators/ledrgb.lua @@ -9,7 +9,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/indicators/light.lua b/graphics/elements/indicators/light.lua index d4e8b09..2f68e9b 100644 --- a/graphics/elements/indicators/light.lua +++ b/graphics/elements/indicators/light.lua @@ -14,7 +14,7 @@ local flasher = require("graphics.flasher") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/indicators/power.lua b/graphics/elements/indicators/power.lua index 323fe58..5f1641e 100644 --- a/graphics/elements/indicators/power.lua +++ b/graphics/elements/indicators/power.lua @@ -13,7 +13,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field width integer length ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/indicators/rad.lua b/graphics/elements/indicators/rad.lua index fc89044..83c9619 100644 --- a/graphics/elements/indicators/rad.lua +++ b/graphics/elements/indicators/rad.lua @@ -14,7 +14,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field width integer length ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/indicators/state.lua b/graphics/elements/indicators/state.lua index d0e57b5..cff1798 100644 --- a/graphics/elements/indicators/state.lua +++ b/graphics/elements/indicators/state.lua @@ -15,7 +15,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field height? integer 1 if omitted, must be an odd number ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/indicators/trilight.lua b/graphics/elements/indicators/trilight.lua index ef8a8b6..151463f 100644 --- a/graphics/elements/indicators/trilight.lua +++ b/graphics/elements/indicators/trilight.lua @@ -16,7 +16,7 @@ local flasher = require("graphics.flasher") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field fg_bg? cpair foreground/background colors ---@field hidden? boolean true to hide on initial draw diff --git a/graphics/elements/indicators/vbar.lua b/graphics/elements/indicators/vbar.lua index 4cfb6e7..36cc74d 100644 --- a/graphics/elements/indicators/vbar.lua +++ b/graphics/elements/indicators/vbar.lua @@ -8,7 +8,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field width? integer parent width if omitted ---@field height? integer parent height if omitted ---@field gframe? graphics_frame frame instead of x/y/width/height diff --git a/graphics/elements/listbox.lua b/graphics/elements/listbox.lua index e37a772..7be8e77 100644 --- a/graphics/elements/listbox.lua +++ b/graphics/elements/listbox.lua @@ -15,7 +15,7 @@ local CLICK_TYPE = core.events.CLICK_TYPE ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field width? integer parent width if omitted ---@field height? integer parent height if omitted ---@field gframe? graphics_frame frame instead of x/y/width/height diff --git a/graphics/elements/multipane.lua b/graphics/elements/multipane.lua index 790b595..fff8fb3 100644 --- a/graphics/elements/multipane.lua +++ b/graphics/elements/multipane.lua @@ -7,7 +7,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field width? integer parent width if omitted ---@field height? integer parent height if omitted ---@field gframe? graphics_frame frame instead of x/y/width/height diff --git a/graphics/elements/pipenet.lua b/graphics/elements/pipenet.lua index 5ca4745..efe6179 100644 --- a/graphics/elements/pipenet.lua +++ b/graphics/elements/pipenet.lua @@ -11,7 +11,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field hidden? boolean true to hide on initial draw -- new pipe network diff --git a/graphics/elements/rectangle.lua b/graphics/elements/rectangle.lua index c3cff14..1d8afae 100644 --- a/graphics/elements/rectangle.lua +++ b/graphics/elements/rectangle.lua @@ -11,7 +11,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field width? integer parent width if omitted ---@field height? integer parent height if omitted ---@field gframe? graphics_frame frame instead of x/y/width/height diff --git a/graphics/elements/textbox.lua b/graphics/elements/textbox.lua index e72571b..521c499 100644 --- a/graphics/elements/textbox.lua +++ b/graphics/elements/textbox.lua @@ -13,7 +13,7 @@ local TEXT_ALIGN = core.TEXT_ALIGN ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field width? integer parent width if omitted ---@field height? integer parent height if omitted ---@field gframe? graphics_frame frame instead of x/y/width/height diff --git a/graphics/elements/tiling.lua b/graphics/elements/tiling.lua index 536ed45..4c0d0ba 100644 --- a/graphics/elements/tiling.lua +++ b/graphics/elements/tiling.lua @@ -11,7 +11,7 @@ local element = require("graphics.element") ---@field parent graphics_element ---@field id? string element id ---@field x? integer 1 if omitted ----@field y? integer 1 if omitted +---@field y? integer auto incremented if omitted ---@field width? integer parent width if omitted ---@field height? integer parent height if omitted ---@field gframe? graphics_frame frame instead of x/y/width/height