Bluewhale/HealBotBlue
1
1
Fork 0
mirror of https://github.com/Bluewhale1337/HealBotBlue.git synced 2026-09-12 10:10:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add function-level documentation comments across various source files to improve the readability of codebase

Browse Source
This commit is contained in:
Bluewhale1337
2026-08-24 12:42:23 +02:00
parent d09e49d26a
commit 6d977f6963
24 changed files with 335 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
HealBot_Options_CDC.lua
+27
View File
@@ -1,15 +1,19 @@
-- HealBot Options panel file: HealBot_Options_CDC.lua
-- Split from original HealBot_Options.lua
-- HealBot_Options_ShowDebuffWarning_OnLoad: UI handler for OnLoad options panel.
function HealBot_Options_ShowDebuffWarning_OnLoad(this,text)
getglobal(this:GetName().."Text"):SetText(text);
end
-- HealBot_Options_ShowDebuffWarning_OnClick: UI handler for OnClick options panel.
function HealBot_Options_ShowDebuffWarning_OnClick(this)
HealBot_Config.ShowDebuffWarning = this:GetChecked() or 0;
end
-- HealBot_Options_SoundDebuffWarning_OnLoad: UI handler for OnLoad options panel.
function HealBot_Options_SoundDebuffWarning_OnLoad(this,text)
getglobal(this:GetName().."Text"):SetText(text);
end
-- HealBot_Options_SoundDebuffWarning_OnClick: UI handler for OnClick options panel.
function HealBot_Options_SoundDebuffWarning_OnClick(this)
HealBot_Config.SoundDebuffWarning = this:GetChecked() or 0;
if HealBot_Config.SoundDebuffWarning==0 then
@@ -22,9 +26,11 @@ function HealBot_Options_SoundDebuffWarning_OnClick(this)
HealBot_WarningSound3:Enable();
end
end
-- HealBot_WarningSound_OnLoad: Internal utility: HealBot_WarningSound_OnLoad
function HealBot_WarningSound_OnLoad(this,text)
getglobal(this:GetName().."Text"):SetText(text);
end
-- HealBot_WarningSound_OnClick: Click event handler.
function HealBot_WarningSound_OnClick(this,id)
if HealBot_Config.SoundDebuffPlay>0 then
getglobal("HealBot_WarningSound"..HealBot_Config.SoundDebuffPlay):SetChecked(nil);
@@ -37,6 +43,7 @@ function HealBot_WarningSound_OnClick(this,id)
end
end
end
-- HealBot_Options_CDCMonitor_DropDown: UI handler for DropDown options panel.
function HealBot_Options_CDCMonitor_DropDown()
for i=1, getn(HealBot_Options_EmergencyFilter_List), 1 do
local info = {};
@@ -45,23 +52,28 @@ function HealBot_Options_CDCMonitor_DropDown()
UIDropDownMenu_AddButton(info);
end
end
-- HealBot_Options_CDCMonitor_Initialize: UI handler for Initialize options panel.
function HealBot_Options_CDCMonitor_Initialize()
UIDropDownMenu_Initialize(HealBot_Options_CDCMonitor,HealBot_Options_CDCMonitor_DropDown)
end
-- HealBot_Options_CDCMonitor_Refresh: UI handler for Refresh options panel.
function HealBot_Options_CDCMonitor_Refresh(onselect)
if not HealBot_Config.CDCMonitor then return end
if not onselect then HealBot_Options_CDCMonitor_Initialize() end -- or wrong menu may be used !
HealBot_UIDropDownMenu_SetSelectedID(HealBot_Options_CDCMonitor,HealBot_Config.CDCMonitor)
end
-- HealBot_Options_CDCMonitor_OnLoad: UI handler for OnLoad options panel.
function HealBot_Options_CDCMonitor_OnLoad()
UIDropDownMenu_Initialize(this, HealBot_Options_CDCMonitor_DropDown)
UIDropDownMenu_SetWidth(100, this)
end
-- HealBot_Options_CDCMonitor_OnSelect: UI handler for OnSelect options panel.
function HealBot_Options_CDCMonitor_OnSelect()
HealBot_Config.CDCMonitor = this:GetID()
HealBot_Options_CDCMonitor_Refresh(true)
HealBot_Options_CDCMonitor_Reset()
end
-- HealBot_Options_CDCMonitor_Reset: UI handler for Reset options panel.
function HealBot_Options_CDCMonitor_Reset()
HealBot_CDCInc[HEALBOT_DRUID] = 0;
@@ -145,10 +157,12 @@ function HealBot_Options_CDCMonitor_Reset()
HealBot_Action_PartyChanged()
end
-- HealBot_Options_GetDebuffSpells_List: UI handler for List options panel.
function HealBot_Options_GetDebuffSpells_List(class)
local DebuffSpells = HealBot_Debuff_Spells[class];
return DebuffSpells;
end
-- HealBot_Options_CDCButLeft_DropDown: UI handler for DropDown options panel.
function HealBot_Options_CDCButLeft_DropDown()
local classEN=HealBot_UnitClass("player")
if classEN=="PRIEST" or classEN=="DRUID" or classEN=="PALADIN" or classEN=="SHAMAN" then
@@ -169,6 +183,7 @@ function HealBot_Options_CDCButLeft_DropDown()
end
end
end
-- HealBot_Options_CDCButRight_DropDown: UI handler for DropDown options panel.
function HealBot_Options_CDCButRight_DropDown()
local classEN=HealBot_UnitClass("player")
if classEN=="PRIEST" or classEN=="DRUID" or classEN=="PALADIN" or classEN=="SHAMAN" then
@@ -189,12 +204,15 @@ function HealBot_Options_CDCButRight_DropDown()
end
end
end
-- HealBot_Options_CDCButLeft_Initialize: UI handler for Initialize options panel.
function HealBot_Options_CDCButLeft_Initialize()
UIDropDownMenu_Initialize(HealBot_Options_CDCButLeft,HealBot_Options_CDCButLeft_DropDown)
end
-- HealBot_Options_CDCButRight_Initialize: UI handler for Initialize options panel.
function HealBot_Options_CDCButRight_Initialize()
UIDropDownMenu_Initialize(HealBot_Options_CDCButRight,HealBot_Options_CDCButRight_DropDown)
end
-- HealBot_Options_CDCButLeft_Refresh: UI handler for Refresh options panel.
function HealBot_Options_CDCButLeft_Refresh(onselect)
local set_id=1;
local class=UnitClass("Player");
@@ -202,6 +220,7 @@ function HealBot_Options_CDCButLeft_Refresh(onselect)
set_id = HealBot_Config.Debuff_Left[class];
HealBot_UIDropDownMenu_SetSelectedID(HealBot_Options_CDCButLeft,set_id)
end
-- HealBot_Options_CDCButRight_Refresh: UI handler for Refresh options panel.
function HealBot_Options_CDCButRight_Refresh(onselect)
local set_id;
local class=UnitClass("Player");
@@ -209,14 +228,17 @@ function HealBot_Options_CDCButRight_Refresh(onselect)
set_id = HealBot_Config.Debuff_Right[class];
HealBot_UIDropDownMenu_SetSelectedID(HealBot_Options_CDCButRight,set_id)
end
-- HealBot_Options_CDCButLeft_OnLoad: UI handler for OnLoad options panel.
function HealBot_Options_CDCButLeft_OnLoad()
UIDropDownMenu_Initialize(this, HealBot_Options_CDCButLeft_DropDown)
UIDropDownMenu_SetWidth(140, this)
end
-- HealBot_Options_CDCButRight_OnLoad: UI handler for OnLoad options panel.
function HealBot_Options_CDCButRight_OnLoad()
UIDropDownMenu_Initialize(this, HealBot_Options_CDCButRight_DropDown)
UIDropDownMenu_SetWidth(140, this)
end
-- HealBot_Options_CDCButLeft_OnSelect: UI handler for OnSelect options panel.
function HealBot_Options_CDCButLeft_OnSelect()
local class=UnitClass("Player");
HealBot_Config.Debuff_Left[class] = this:GetID();
@@ -228,6 +250,7 @@ function HealBot_Options_CDCButLeft_OnSelect()
HealBot_DebuffPriority = HealBot_Debuff_Types[HealBot_Options_CDCButLeftText:GetText()];
HealBot_Options_Debuff_Reset()
end
-- HealBot_Options_CDCButRight_OnSelect: UI handler for OnSelect options panel.
function HealBot_Options_CDCButRight_OnSelect()
local class=UnitClass("Player");
HealBot_Config.Debuff_Right[class] = this:GetID();
@@ -238,11 +261,13 @@ function HealBot_Options_CDCButRight_OnSelect()
end
HealBot_Options_Debuff_Reset()
end
-- HealBot_Options_CDC_SetCombo: UI handler for SetCombo options panel.
function HealBot_Options_CDC_SetCombo(spell, button, class)
local combo = HealBot_Config.KeyCombo[class]
combo["Alt"..button] = spell
HealBot_Options_KeyCombo_Change()
end
-- HealBot_Options_Debuff_Reset: Restores default debuff tracking options.
function HealBot_Options_Debuff_Reset()
HealBot_DebuffWatch = {
[HEALBOT_DISEASE_en] = true,
@@ -251,10 +276,12 @@ function HealBot_Options_Debuff_Reset()
[HEALBOT_CURSE_en] = true
}
end
-- HealBot_Colorpick_OnClick: Opens color picker for debuff colors.
function HealBot_Colorpick_OnClick(CDCType)
HealBot_ColourObjWaiting=CDCType;
HealBot_UseColourPick(HealBot_Config.CDCBarColour[CDCType].R,HealBot_Config.CDCBarColour[CDCType].G,HealBot_Config.CDCBarColour[CDCType].B, nil)
end
-- HealBot_SetCDCBarColours: Internal utility: HealBot_SetCDCBarColours
function HealBot_SetCDCBarColours()
HealBot_DiseaseColorpick:SetStatusBarColor(HealBot_Config.CDCBarColour[HEALBOT_DISEASE_en].R,
HealBot_Config.CDCBarColour[HEALBOT_DISEASE_en].G,