luadoc/timer.lua

   1 --- awesome timer API
   2 -- @author Julien Danjou &lt;julien@danjou.info&gt;
   3 -- @copyright 2009 Julien Danjou
   4 module("timer")
   5
   6 --- Timer object. This type of object is useful when triggering events in a repeatedly.
   7 -- The timer will emit the "timeout" signal every N seconds, N being the timeout value.
   8 -- @field timeout Interval in seconds to emit the timeout signal.
   9 -- Can be any value, including floating ones (i.e. 1.5 second).
  10 -- @field started Read-only boolean field indicating if the timer has been started.
  11 -- @class table
  12 -- @name timer
  13
  14 --- Start the timer.
  15 -- @param -
  16 -- @name start
  17 -- @class function
  18
  19 --- Stop the timer.
  20 -- @param -
  21 -- @name stop
  22 -- @class function
  23
  24 --- Add a signal.
  25 -- @param name A signal name.
  26 -- @param func A function to call when the signal is emitted.
  27 -- @name add_signal
  28 -- @class function
  29
  30 --- Remove a signal.
  31 -- @param name A signal name.
  32 -- @param func A function to remove.
  33 -- @name remove_signal
  34 -- @class function
  35
  36 --- Emit a signal.
  37 -- @param name A signal name.
  38 -- @param ... Various arguments, optional.
  39 -- @name emit_signal
  40 -- @class function