Add usage note to unschedule

10 years ago · ca75b7a030
parent c4f1687c22
commit ca75b7a030
1 changed files with 6 additions and 0 deletions
--- a/frontend/ui/uimanager.lua
+++ b/frontend/ui/uimanager.lua
@ -232,6 +232,12 @@ function UIManager:scheduleIn(seconds, action)
    self:schedule(when, action)
 end

+-- unschedule an execution task
+-- in order to unschedule anonymous functions, store a reference
+-- for example:
+-- self.anonymousFunction = function() self:regularFunction() end
+-- UIManager:scheduleIn(10, self.anonymousFunction)
+-- UIManager:unschedule(self.anonymousFunction)
 function UIManager:unschedule(action)
    for i = #self._execution_stack, 1, -1 do
        local task = self._execution_stack[i]