Next: set_heartbeat_freq

Prev: log

run_script

run_script(name, arguments)
run_script(name, arguments, background-flag)
This function executes the script named by string name, passing it the arguments in the list arguments. Each element of arguments must be a string. Coldmud looks for the script named by name in the directory scripts in the current directory. name cannot contain a ../ sequence; that is, it cannot walk back down the directory hierarchy.

If background-flag is specified, it must be an integer. If it is non-zero, then script is run in the background. Otherwise, Coldmud waits for the script to execute.

If background-flag is not specified, run_script() returns the return status of the script, or -1 if it does not successfully execute the script. If background-flag is specified, then run_script() might return -1 if the script is not successfully executed, and it may even return the return status of the script if the script executes extremely quickly, but it will usually return 0.