Block functions from running at program start

[dnaldoog]

Usually if panel:getBootStrapState() then return end will stop lua code from running at startup when declared in Called when the modulator value changes.

Problem

I have found that sometimes adding this code at the beginning of a function sometimes doesn't work properly in restricted instances i.e. static versions of a panel. https://ctrlr.org/forums/topic/standalone-images-not-loading/#post-98147

Solution

1. Create a class initialisation in a constructor function Called before any modulators are created

   myPanel = Panel -- stop functions from loading when the panel is loaded
   myPanel:_init(true)

This code sets myPanel:setBootstrapState() -- to true

2. Create a non visible uiButton with a callback function in Called when the modulator value changes.

unBlock = function(--[[ CtrlrModulator --]] mod, --[[ number --]] value, --[[ number --]] source)
-- will be fired off on panel load; stops functions from firing off on boot
timer:setCallback(111, TimerCallback) -- TimerId 0
timer:startTimer(111, 500) -- Timer Id 0 500ms
end

3. When the panel is loaded the above function fires off a timer after 500ms.

TimerCallback = function(timerId)
if timerId == 111 then
        myPanel:setBootstrapState() -- to false on load
        timer:stopTimer(timerId)
    end
end

This timer sets myPanel:setBootstrapState() -- to false

4. Place the following code at the beginning of each callback function Called when the modulator value changes.
   if myPanel:getBootStrapState() then return end

5. Functions are now cleared to run.

6. NOTE: When opening the same panel twice into Ctrlr , popup windows in protected functions will still fire: Block them by checking if source==4.

if source==4 then
utils.warnWindow("","")
end

Class code

Panel = {} -- blocks functions from firing when panel is loaded
Panel.__index = Panel

setmetatable(
    Panel,
    {
        __call = function(cls, ...)
            local self = setmetatable({}, cls)
            self:_init(...)
            return self
        end
    }
)

function Panel:_init(init)
    self.block = init
end

function Panel:getBootstrapState()
    return self.block
end

function Panel:setBootstrapState()
    self.block = false
end

---

myPanel Script Blocker_1_0.zip