1 parent 9f38ca1 commit f6beaa7Copy full SHA for f6beaa7
1 file changed
datapack/data/advanced_math/modules/pid.lua
@@ -146,6 +146,15 @@ end
146
--
147
-- @type PID
148
local pid = {
149
+ --- Performs a PID control step
150
+ -- @tparam PID self The PID instance
151
+ -- @tparam number|vector|quaternion value The current value being measured
152
+ -- @tparam number dt The time since the last step
153
+ -- @treturn number|vector|quaternion The control output
154
+ -- @usage output = pid:step(value)
155
+ -- @usage output = pid:step(value, 0.5)
156
+ step = function() end, -- to be replaced in constructor
157
+
158
--- Enables/disables the clamping of the output value
159
160
-- @tparam PID self The PID instance
0 commit comments