Improve docs

This commit is contained in:
Aaron Smith 2023-08-09 15:33:14 +01:00
parent 0e6e8300fb
commit 04e28f390d
13 changed files with 186 additions and 116 deletions

View file

@ -97,6 +97,10 @@ local springs: { [SpringData<any>]: Node<any> } = {}
setmetatable(springs, { __mode = "vs" })
local function spring<T>(target: () -> T, period: number?, damping_ratio: number?): () -> T
if damping_ratio and damping_ratio > 1 then
throw "damping ratio cannot be greater than 1"
end
local inputs, initial_position = capture(target)
local output, output_get = create(initial_position)