C_TimerAugment.lua

Compare Download

C_TimerAugment.lua (8.3.7.35284; unchanged since 7.3.5.25864)
  1. local TickerPrototype = {};
  2. local TickerMetatable = {
  3. __index = TickerPrototype,
  4. __metatable = true, --Probably not needed, but if I don't put this here someone is going to mess with this metatable and end up tainting everything...
  5. };
  7. --Creates and starts a ticker that calls callback every duration seconds for N iterations.
  8. --If iterations is nil, the ticker will loop until cancelled.
  9. --
  10. --If callback throws a Lua error, the ticker will stop firing.
  11. function C_Timer.NewTicker(duration, callback, iterations)
  12. local ticker = setmetatable({}, TickerMetatable);
  13. ticker._remainingIterations = iterations;
  14. ticker._callback = function()
  15. if ( not ticker._cancelled ) then
  16. callback(ticker);
  18. --Make sure we weren't cancelled during the callback
  19. if ( not ticker._cancelled ) then
  20. if ( ticker._remainingIterations ) then
  21. ticker._remainingIterations = ticker._remainingIterations - 1;
  22. end
  23. if ( not ticker._remainingIterations or ticker._remainingIterations > 0 ) then
  24. C_Timer.After(duration, ticker._callback);
  25. end
  26. end
  27. end
  28. end;
  30. C_Timer.After(duration, ticker._callback);
  31. return ticker;
  32. end
  34. --Creates and starts a cancellable timer that calls callback after duration seconds.
  35. --Note that C_Timer.NewTimer is significantly more expensive than C_Timer.After and should
  36. --only be used if you actually need any of its additional functionality.
  37. --
  38. --While timers are currently just tickers with an iteration count of 1, this is likely
  39. --to change in the future and shouldn't be relied on.
  40. function C_Timer.NewTimer(duration, callback)
  41. return C_Timer.NewTicker(duration, callback, 1);
  42. end
  44. --Cancels a ticker or timer. May be safely called within the ticker's callback in which
  45. --case the ticker simply won't be started again.
  46. --Cancel is guaranteed to be idempotent.
  47. function TickerPrototype:Cancel()
  48. self._cancelled = true;
  49. end
  51. function TickerPrototype:IsCancelled()
  52. return self._cancelled;
  53. end