Commenting stuff

This commit is contained in:
Unknown 2018-03-08 17:59:46 +03:00
parent 3fc2f0977f
commit a24ef6f4de
3 changed files with 11 additions and 2 deletions

View file

@ -1,3 +1,5 @@
--@TODO: return right after output function call if it's not used in chat and in log
--@TODO: move logging options to developer mode in options menu
local vmf = get_mod("VMF") local vmf = get_mod("VMF")
local _UNSENT_CHAT_MESSAGES = {} local _UNSENT_CHAT_MESSAGES = {}

View file

@ -257,4 +257,8 @@ vmf:hook("UIAtlasHelper.get_atlas_settings_by_texture_name", function(func, text
return func(texture_name) return func(texture_name)
end) end)
-- ####################################################################################################################
-- ##### VMF internal functions and variables #########################################################################
-- ####################################################################################################################
vmf.custom_textures_debug = vmf:get("developer_mode") and vmf:get("log_ui_renderers_info") vmf.custom_textures_debug = vmf:get("developer_mode") and vmf:get("log_ui_renderers_info")

View file

@ -1,15 +1,18 @@
--[[ --[[
* If you're changing settings defined in widget via mod:set don't use values which aren't defined in widget * If you're changing settings defined in widget via mod:set don't use values which aren't defined in widget
* Don't use tables in settings defined in widgets. You can do it, but it will affect performance. The widgets are build to work with * Don't use tables in settings defined in widgets. The widgets are build to work with
basic datatypes (with exception of keybind widgets, but they are working differently) basic datatypes (with exception of keybind widgets, but they are working differently)
* Using tables in mod:get and mod:set for the settings that are not defined in widgets is fine though, * Using tables in mod:get and mod:set for the settings that are not defined in widgets is fine though,
but keep in mind, that every time you do it, this table will be cloned, so don't do it very frequently, but keep in mind, that every time you do it, this table will be cloned, so don't do it very frequently,
especially if the tables are big especially if the tables are big
* No external config files. Everything should be stored via mod:set * No external config files. Everything should be stored via mod:set
* Use mod:set only if you need setting to be saved in the config file
@TODO: [BUG] checkbox is checked at first tick after showing, since local_offset function is called after rect drawing @TODO: [BUG] checkbox is checked at first tick after showing, since local_offset function is called after rect drawing
@TODO: [BUG] searchbar's insput will stop working after using russian character @TODO: [BUG] searchbar's input will stop working after using russian character
@TODO: [IMPROVEMENT] opened widgets are shown even behind the borders
@TODO: [IMPROVEMENT] dropdown widget goes up if there's not enough space at the bottom
]] ]]
local vmf = get_mod("VMF") local vmf = get_mod("VMF")