Changes between Version 9 and Version 10 of Scripting/API

Timestamp:

Jun 22, 2025, 7:47:16 PM (2 months ago)

Author:

admin

Comment:

--

Scripting/API

@@ -15 +15 @@
 
 Once again: every operation ends with a call to `.go()`, which will actually perform the operation and return the result, if any. Don't forget it, or nothing will happen!
+
+== Interrupt/abort Support ==
+
+If your script does any iteration, it should support being interrupted by the user, in case it takes too long or enters an infinite loop. !WorldPainter cannot kill your script in such a case, so you need to support interruption explicitly, by using one of the following two methods:
+
+* `wp.interrupted` - this is a boolean property which you can check, and if `true`, cleanly abort your operation, cleaning up in so far as necessary.
+* `wp.checkForInterrupt()` - this is a function you can call which does nothing as long as an interrupt has not been requested, and throws an exception if an interrupt ''has'' been requested. Use this if it is OK to just abort whatever the script is doing without doing clean-up.
+
+Do either of these in some inner loop, where it is guaranteed to be reached even if your code enters an infinite loop at a higher level.
+
+Note that any changes the script might have already made to the Dimension are not automatically rolled back. The user will have to do that by closing the script window and activating the Undo action using the toolbar button or by pressing Ctrl+Z.
 
 == Commandline Arguments ==