add spartan readme

This commit is contained in:
wsor4035 2023-12-03 15:42:52 -05:00
parent 5c487bd11a
commit c712bf662c

25
readme.md Normal file

@ -0,0 +1,25 @@
# api
note: supports all keys minetest does
```lua
controls.register_on_press(function(player, key)
-- called on key down
-- @player: player object
-- @key: key pressed
end)
controls.register_on_hold(function(player, key, length)
-- called while key is held
-- @player: player object
-- @key: key pressed
-- @length: length of time key was held in seconds
end)
controls.register_on_release(function(player, key, length)
-- called on key up
-- @player: player object
-- @key: key pressed
-- @length: length of time key was held in seconds
end)
```