Skip to content

Commit 3c20033

Browse files
committed
Update docstring for TimerEvent
I think the TimerEvent lifecycle could use some clarification so I updated the docstring to explain what happens when they are finished firing.
1 parent 9f28d06 commit 3c20033

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

src/time/TimerEvent.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99
*
1010
* It consists of a delay, which is a value in milliseconds after which the event will fire.
1111
* When the event fires it calls a specific callback with the specified arguments.
12-
*
12+
*
13+
* TimerEvents are removed by their parent timer once finished firing or repeating.
14+
*
1315
* Use {@link Phaser.Timer#add}, {@link Phaser.Timer#repeat}, or {@link Phaser.Timer#loop} methods to create a new event.
1416
*
1517
* @class Phaser.TimerEvent

0 commit comments

Comments
 (0)