Improve hackStopIngameAudio() documentation

Warzone2100 · Nov 10, 2020 · 9daa81e · 9daa81e
1 parent d371fdc
commit 9daa81e
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/wzapi.cpp b/src/wzapi.cpp
@@ -739,7 +739,9 @@ wzapi::no_return_value wzapi::hackPlayIngameAudio(WZAPI_NO_PARAMS)
 
 //-- ## hackStopIngameAudio()
 //--
-//-- (3.3+ only)
+//-- Stop the in-game music. (3.3+ only)
+//-- This should be called from the eventStartLevel() event (or later).
+//-- Currently only used from the tutorial.
 //--
 wzapi::no_return_value wzapi::hackStopIngameAudio(WZAPI_NO_PARAMS)
 {