Веб-сайт самохостера Lotigara

summaryrefslogtreecommitdiff
path: root/doc/lua/updatablescript.md
diff options
context:
space:
mode:
authorKae <80987908+Novaenia@users.noreply.github.com>2023-06-20 14:33:09 +1000
committerKae <80987908+Novaenia@users.noreply.github.com>2023-06-20 14:33:09 +1000
commit6352e8e3196f78388b6c771073f9e03eaa612673 (patch)
treee23772f79a7fbc41bc9108951e9e136857484bf4 /doc/lua/updatablescript.md
parent6741a057e5639280d85d0f88ba26f000baa58f61 (diff)
everything everywhere
all at once
Diffstat (limited to 'doc/lua/updatablescript.md')
-rw-r--r--doc/lua/updatablescript.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/lua/updatablescript.md b/doc/lua/updatablescript.md
new file mode 100644
index 0000000..2dd55e1
--- /dev/null
+++ b/doc/lua/updatablescript.md
@@ -0,0 +1,13 @@
+Most entity script contexts include the *script* table, which provides bindings for getting and setting the script's update rate. Update deltas are specified in numbers of frames, so a script with an update delta of 1 would run every frame, or a script with an update delta of 60 would run once per second. An update delta of 0 means that the script's periodic update will never be called, but it can still perform actions through script calls, messaging, or event hooks.
+
+---
+
+#### `void` script.setUpdateDelta(`unsigned` dt)
+
+Sets the script's update delta.
+
+---
+
+#### `float` script.updateDt()
+
+Returns the duration in seconds between periodic updates to the script.