clarify function header

CBATeam · Apr 29, 2018 · 92a9619 · 92a9619
1 parent 449a7db
commit 92a9619
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/addons/common/fnc_waitUntilAndExecute.sqf b/addons/common/fnc_waitUntilAndExecute.sqf
@@ -10,7 +10,8 @@ Parameters:
     _condition   - The function to evaluate as condition. <CODE>
     _statement   - The function to run once the condition is true. <CODE>
     _args        - Parameters passed to the functions (statement and condition) executing. (optional) <ANY>
-    _timeout     - Timeout for the condition in seconds. (optional) <NUMBER>
+    _timeout     - If >= 0, timeout for the condition in seconds.  If < 0, no timeout.
+                   Exactly 0 means timeout immediately on the next iteration.(optional, default -1) <NUMBER>
     _timeoutCode - Will execute instead of _statement if the condition times out. (optional) <CODE>
 
 Passed Arguments: