Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Geokureli committed Feb 24, 2024
1 parent 083462c commit 4f16cf7
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions flixel/util/FlxTimer.hx
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,9 @@ class FlxTimer implements IFlxDestroyable
public var finished:Bool = false;

/**
* Function that gets called when timer completes.
* Callback should be formed "onTimer(Timer:FlxTimer);"
* Called when timer completes. The function header should be `(timer:FlxTimer)`
*/
public var onComplete:FlxTimer->Void;
public var onComplete:(FlxTimer)->Void;

/**
* Read-only: check how much time is left on the timer.
Expand Down Expand Up @@ -144,7 +143,7 @@ class FlxTimer implements IFlxDestroyable
* @param time The duration of the timer, in seconds. If `0` then `onComplete`
* fires on the next game update, and the `loops` argument is ignored.
* @param onComplete Optional, triggered whenever the time runs out, once for each loop.
* Callback should be formed `onTimer(Timer:FlxTimer);`
* The function header should be `(timer:FlxTimer)`
* @param loops How many times the timer should go off. 0 means "looping forever".
* @return A reference to itself (handy for chaining or whatever).
*/
Expand Down

0 comments on commit 4f16cf7

Please sign in to comment.