From 0b0bd71a0c96bb7b81b2ccbd0813a1b318c31ea1 Mon Sep 17 00:00:00 2001 From: Tachytaenius Date: Fri, 2 Dec 2022 12:51:49 +0000 Subject: [PATCH] Adjust action timer API Lua API docs --- docs/dev/Lua API.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/dev/Lua API.rst b/docs/dev/Lua API.rst index bbc56b03b..8eb5e2c74 100644 --- a/docs/dev/Lua API.rst +++ b/docs/dev/Lua API.rst @@ -1553,12 +1553,14 @@ Action Timer API This is an API to allow manipulation of unit action timers, to speed them up or slow them down. All functions in this API have overflow/underflow protection when modifying action timers (the value will cap out). +Actions with a timer of 0 (or less) will not be modified as they are completed (or invalid in the case of negatives). +Timers will be capped to go no lower than 1. ``affectedActionType`` parameters are integers from the DF enum ``unit_action_type``. E.g. ``df.unit_action_type.Move``. ``affectedActionTypeGroup`` parameters are integers from the (custom) DF enum ``unit_action_type_group``. They are as follows: * ``All`` (does not include unknown unit action types) * ``Movement`` - * ``MovementFeet`` (check if the unit is not on ground before using this one?) + * ``MovementFeet`` (intended to only be used when the unit is standing, such as with pegasus boots from the modding guide) * ``Combat`` (includes bloodsucking) * ``Work``