Wait: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Bale
Minimum wait is 1 second
imported>Eliteofdelete
No edit summary
 
Line 18: Line 18:
function_description=This function will initiate a countdown from {{pspan|secs}} seconds to 0, during which time nothing else will be acted on. It essentially pauses a script. In addition, a countdown prints to the CLI at varying intervals (every 15 secs for large numbers, 5 seconds for smaller numbers and every second from 5 seconds down).</p><p>Minimum wait is 1 second, even if {{pspan|secs}} is 0.|
function_description=This function will initiate a countdown from {{pspan|secs}} seconds to 0, during which time nothing else will be acted on. It essentially pauses a script. In addition, a countdown prints to the CLI at varying intervals (every 15 secs for large numbers, 5 seconds for smaller numbers and every second from 5 seconds down).</p><p>Minimum wait is 1 second, even if {{pspan|secs}} is 0.|


needscode=yes|
code1={{CodeSample|
title=Code Samples|
description=The following example will give a 5 second countdown before running dj's EatDrink script, if you have it. |
code=
<syntaxhighlight>
print("Running the EatDrink script in...");
wait(5);
if (svn_exists("therazekolmafia-eatdrink"))
  cli_execute("EatDrink.ash");
else print("You currently do not have EatDrink script, check the forums for it!", "blue");
 
</syntaxhighlight>|
 
}}|
see_also={{SeeAlso|waitq}}|
see_also={{SeeAlso|waitq}}|
cli_equiv=The CLI command "wait" functions the same and can be used to pause basic .txt scripts.|
cli_equiv=The CLI command "wait" functions the same and can be used to pause basic .txt scripts.|

Latest revision as of 23:05, 21 January 2015

Function Syntax

void wait(int secs )

  • secs is the number of seconds you want to delay further action.

This function will initiate a countdown from secs seconds to 0, during which time nothing else will be acted on. It essentially pauses a script. In addition, a countdown prints to the CLI at varying intervals (every 15 secs for large numbers, 5 seconds for smaller numbers and every second from 5 seconds down).

Minimum wait is 1 second, even if secs is 0.

Code Samples

The following example will give a 5 second countdown before running dj's EatDrink script, if you have it.

print("Running the EatDrink script in...");
wait(5);
if (svn_exists("therazekolmafia-eatdrink"))
   cli_execute("EatDrink.ash");
else print("You currently do not have EatDrink script, check the forums for it!", "blue");

CLI Equivalent

The CLI command "wait" functions the same and can be used to pause basic .txt scripts.

See Also

waitq()