From 6352e8e3196f78388b6c771073f9e03eaa612673 Mon Sep 17 00:00:00 2001 From: Kae <80987908+Novaenia@users.noreply.github.com> Date: Tue, 20 Jun 2023 14:33:09 +1000 Subject: everything everywhere all at once --- doc/lua/updatablescript.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 doc/lua/updatablescript.md (limited to 'doc/lua/updatablescript.md') 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. -- cgit v1.2.3