TenPlus1/pova-cd2025
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tweak readme

Browse Source
This commit is contained in:
TenPlus1 2018-04-19 09:34:19 +01:00
parent 630d680379
commit 510bfa161d
1 changed files with 12 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,35 +1,32 @@
# POVA
Pova gives mod makers a set of functions that safely apply overrides for player
speed, jump height and gravity effects.
Pova gives mod makers a set of functions that safely apply overrides for player speed, jump height and gravity effects.
## Settings
'pova_loop' setting is true by default and will calculate and set overrides
once a second for each player.
'pova_loop' setting is true by default and will calculate and set overrides once a second for each player.
## Functions
- pova.set_override_defaults = function(name, def)
pova.set_override_defaults = function(name, def)
Sets default speed, jump and gravity for a player.
- Sets default speed, jump and gravity for a player that overrides are added onto.
- pova.add_override = function(name, item, def)
pova.add_override = function(name, item, def)
Adds a named override which can add or remove from speed, jump and gravity.
- Adds a named override which can add or remove from speed, jump and gravity.
- pova.get_override = function(name, item)
pova.get_override = function(name, item)
Returns the table containing {speed, jump, gravity} for the added item.
- Returns the table containing {speed, jump, gravity} for the added item.
- pova.del_override = function(name, item)
pova.del_override = function(name, item)
Removes the settings for the named item.
- Removes the settings for the named item.
- pova.do_override(player)
pova.do_override(player)
Calculates and sets new overrides instantly, this can be used when the
'pova_loop' setting is false.
- Calculates and sets new overrides instantly, this can be used when the 'pova_loop' setting is false.
## Changelog