func_event_waitevent.rst 545 B

123456789101112131415161718192021222324252627282930313233343536373839
  1. .. _func_event_waitevent:
  2. =========
  3. WaitEvent
  4. =========
  5. WaitEvent -
  6. Description
  7. ===========
  8. .. code-block:: blitzmax
  9. WaitEvent()
  10. Get the next event from the event queue, waiting if necessary
  11. #WaitEvent removes an event from the event queue and updates the #CurrentEvent
  12. global variable.
  13. If there are no events in the event queue, #WaitEvent halts program execution until
  14. an event is available.
  15. Parameters
  16. ==========
  17. Return Values
  18. =============
  19. The id of the next event in the event queue
  20. Examples
  21. ========
  22. See Also
  23. ========