Skip to content

Commit f6beaa7

Browse files
committed
Added a placeholder function for documentation purposes
1 parent 9f38ca1 commit f6beaa7

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

  • datapack/data/advanced_math/modules

datapack/data/advanced_math/modules/pid.lua

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,15 @@ end
146146
--
147147
-- @type PID
148148
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+
149158
--- Enables/disables the clamping of the output value
150159
--
151160
-- @tparam PID self The PID instance

0 commit comments

Comments
 (0)