nalc/player_physics
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Make "README.md" better

Browse Source
This commit is contained in:
Panquesito7 2019-08-22 19:56:10 -05:00 committed by GitHub
parent 975b2e8ff4
commit 254156999a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,15 +1,15 @@
# player_physics # Player Physics
A minetest mod to centralize the management of player's stats(sprint, jump, gravity) A minetest mod to centralize the management of player's stats(sprint, jump, gravity)
Because many mods (sprint, 3d_armor and others) rewrite the stats in their corner and it cancel Because many mods (sprint, 3d_armor and others) rewrite the stats in their corner and it cancel
***API*** ## API
- player_physics.set_stats(player, "uniq_name", table) - player_physics.set_stats(player, "uniq_name", table)
- player_physics.remove_stats(player, "uniq_name") - player_physics.remove_stats(player, "uniq_name")
**Exemple** ## API examples
- player_physics.set_stats(player, "potion_speedlvl1", {speed=0.35}) - player_physics.set_stats(player, "potion_speedlvl1", {speed=0.35})
@ -17,12 +17,12 @@ Because many mods (sprint, 3d_armor and others) rewrite the stats in their corne
- player_physics.remove_stats(player, "potion_speedlvl1") - player_physics.remove_stats(player, "potion_speedlvl1")
**Temporary effect** ## Temporary effect
- player_physics.add_effect(player, "uniq_name", time, stats) - player_physics.add_effect(player, "uniq_name", time, stats)
- player_physics.remove_effect(player, "uniq_name") - player_physics.remove_effect(player, "uniq_name")
**Exemple** ## Code example
You make a potion that adds speed for 10 seconds. You make a potion that adds speed for 10 seconds.
on_use = function(itemstack, user, pointed_thing) on_use = function(itemstack, user, pointed_thing)
@ -30,6 +30,3 @@ You make a potion that adds speed for 10 seconds.
itemstack:take_item() itemstack:take_item()
return itemstack return itemstack
end end