UNLOZE/sourcemod
10
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Allow void return type in timer callbacks (#1916)

Browse Source
This commit is contained in:
Alienmario 2023-03-03 06:28:42 +01:00 committed by GitHub
parent 693e584dcd
commit 850f96b986
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
plugins/include/timers.inc
View File

@ -54,17 +54,36 @@ typeset Timer
* @param data Handle or value passed to CreateTimer() when timer was created. * @param data Handle or value passed to CreateTimer() when timer was created.
* @return Plugin_Stop to stop a repeating timer, any other value for * @return Plugin_Stop to stop a repeating timer, any other value for
* default behavior. * default behavior.
* Ignored for non-repeating timers (use void return type).
*/ */
function Action(Handle timer, any data); 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. * Called when the timer interval has elapsed.
* *
* @param timer Handle to the timer object. * @param timer Handle to the timer object.
* @return Plugin_Stop to stop a repeating timer, any other value for * @return Plugin_Stop to stop a repeating timer, any other value for
* default behavior. * default behavior.
* Ignored for non-repeating timers (use void return type).
*/ */
function Action(Handle timer); 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);
}; };
/** /**