SceneTreeTimer.xml 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="SceneTreeTimer" inherits="Reference" 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. yield(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. <methods>
  29. </methods>
  30. <members>
  31. <member name="time_left" type="float" setter="set_time_left" getter="get_time_left">
  32. The time remaining.
  33. </member>
  34. </members>
  35. <signals>
  36. <signal name="timeout">
  37. <description>
  38. Emitted when the timer reaches 0.
  39. </description>
  40. </signal>
  41. </signals>
  42. <constants>
  43. </constants>
  44. </class>