diff --git a/plugins/include/timers.inc b/plugins/include/timers.inc index c5fbf9d7..e74d9beb 100644 --- a/plugins/include/timers.inc +++ b/plugins/include/timers.inc @@ -54,17 +54,36 @@ typeset Timer * @param data Handle or value passed to CreateTimer() when timer was created. * @return Plugin_Stop to stop a repeating timer, any other value for * default behavior. + * Ignored for non-repeating timers (use void return type). */ function Action(Handle timer, any data); + /** + * Called when the timer interval has elapsed. + * For repeating timers, use the callback with return value. + * + * @param timer Handle to the timer object. + * @param data Handle or value passed to CreateTimer() when timer was created. + */ + function void(Handle timer, any data); + /** * Called when the timer interval has elapsed. * * @param timer Handle to the timer object. * @return Plugin_Stop to stop a repeating timer, any other value for * default behavior. + * Ignored for non-repeating timers (use void return type). */ function Action(Handle timer); + + /** + * Called when the timer interval has elapsed. + * For repeating timers, use the callback with return value. + * + * @param timer Handle to the timer object. + */ + function void(Handle timer); }; /**