SceneTreeTimer.xml 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="SceneTreeTimer" inherits="RefCounted" version="4.0">
  3. <brief_description>
  4. One-shot timer.
  5. </brief_description>
  6. <description>
  7. A one-shot timer managed by the scene tree, which emits [signal timeout] on completion. See also [method SceneTree.create_timer].
  8. As opposed to [Timer], it does not require the instantiation of a node. Commonly used to create a one-shot delay timer as in the following example:
  9. [codeblocks]
  10. [gdscript]
  11. func some_function():
  12. print("Timer started.")
  13. await get_tree().create_timer(1.0).timeout
  14. print("Timer ended.")
  15. [/gdscript]
  16. [csharp]
  17. public async void SomeFunction()
  18. {
  19. GD.Print("Timer started.");
  20. await ToSignal(GetTree().CreateTimer(1.0f), "timeout");
  21. GD.Print("Timer ended.");
  22. }
  23. [/csharp]
  24. [/codeblocks]
  25. </description>
  26. <tutorials>
  27. </tutorials>
  28. <members>
  29. <member name="time_left" type="float" setter="set_time_left" getter="get_time_left">
  30. The time remaining.
  31. </member>
  32. </members>
  33. <signals>
  34. <signal name="timeout">
  35. <description>
  36. Emitted when the timer reaches 0.
  37. </description>
  38. </signal>
  39. </signals>
  40. </class>