Add a code example for Spring.Yield()

beyond-all-reason · Sep 23, 2023 · bcba7cc · bcba7cc
1 parent 474f829
commit bcba7cc
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/rts/Lua/LuaUnsyncedCtrl.cpp b/rts/Lua/LuaUnsyncedCtrl.cpp
@@ -4837,6 +4837,13 @@ int LuaUnsyncedCtrl::SetClipboard(lua_State* L)
  *
  * Should be called after each widget/unsynced gadget is loaded in widget/gadget handler. Use it to draw screen updates and process windows events.
  *
+ * @usage#
+ * local wantYield = Spring.Yield and Spring.Yield() -- nil check: not present in synced
+ * for wupget in pairs(wupgetsToLoad) do
+ *   loadWupget(wupget)
+ *   wantYield = wantYield and Spring.Yield()
+ * end
+ *
  * @number sleep time in milliseconds.
  * @treturn bool when true caller should continue calling `Spring.Yield` during the widgets/gadgets load, when false it shouldn't call it any longer.
  */