Call as
UI.checkbox.constructor()
Record the dependency UI.checkbox.constructor, then call it by that name. A namespaced call does not pass self: use a colon call or pass the object yourself.
What it does
Constructs a new RM-CheckBox condition widget: a 180 by 24 frame holding a workbench check box, with SetLabel, SetValue, GetValue and SetDisabled, firing OnValueChanged when clicked. It returns the registered but not yet acquired widget; addon:CreateConditionCheckBox passes it to addon:AcquireConditionWidget, which reuses pooled instances.
Arguments
None.
Returns
| 1 | RMConditionWidget | The new check box widget, registered with the condition widget system. |
|---|
Editions
Built In helpers are registered on every edition. What differs is the game API they read; where one is missing the helper falls back or returns nil with a reason.
- Not available on that edition (the reason is in the tooltip)
- Only while Blizzard's deprecation fallbacks are on
| Game API |  |  |  |  |  |
|---|---|---|---|---|---|
CreateFrame | | | | | |
UIParent | | | | | |
Example
-- needs the dependency UI.checkbox.constructor
local box = addon:AcquireConditionWidget("RM-CheckBox", UI.checkbox.constructor)
box:SetLabel(L["Only in combat"])
box:SetValue(value.combat == true)
box:SetCallback("OnValueChanged", function(_, _, checked) value.combat = checked end)
parent:AddChild(box)Source
UI/checkbox.lua, line 24. Read only in game; Duplicate makes an editable copy.
UI.checkbox.constructor()
local w={type='RM-CheckBox',alive=false,disabled=false}
local frame=CreateFrame('Frame',nil,UIParent);w.frame=frame;frame:SetSize(180,24)
local button=addon:CreateWorkbenchCheckBox(frame,'',180);w.button=button;button:SetAllPoints(frame)
function w:OnAcquire() self.alive=true;button.tooltip=nil;self:SetLabel('');self:SetValue(false);self:SetDisabled(false);self:SetWidth(180);self:SetHeight(24) end
function w:OnRelease() self.alive=false;self:SetValue(false) end
function w:SetLabel(text) button:SetText(text or '') end
function w:SetValue(value) button:SetChecked(value==true) end
function w:GetValue() return button:GetChecked() end
function w:SetDisabled(value) self.disabled=value==true;if self.disabled then button:Disable();button:SetAlpha(.45) else button:Enable();button:SetAlpha(1) end end
function w:OnWidthSet(width) button:GetFontString():SetWidth(math.max(1,width-22)) end
addon:SetUIScript(button,'OnClick',function()
if not w.alive or w.disabled then return end
w:SetValue(not w:GetValue());w:Fire('OnValueChanged',w:GetValue())
end)
---@cast w RMConditionWidget
return addon:RegisterConditionWidget(w)