nalc/minetest_mana
1
0
Fork 0
forked from mtcontrib/minetest_mana
Code Issues Pull Requests Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Wuzzy 2015-05-25 22:53:09 +02:00
parent 336b6dac87
commit b157b892dd
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
API.md
View File

@ -41,7 +41,12 @@ the new maximum.
### `mana.setregen(playername, value)` ### `mana.setregen(playername, value)`
Sets the mana regeneration per mana tick of the player to `value`. Sets the mana regeneration per mana tick of the player to `value`.
Negative values are not permitted. Floating-point numbers are also permitted, in which the generation
of 1 mana takes longer than 1 mana tick. I.e. `0.5`. means
that 1 mana is generated every 2 mana ticks. A negative value means the
player loses mana.
The length of one “mana tick” is specified as the server-wide setting The length of one “mana tick” is specified as the server-wide setting
`mana_default_regen` in seconds. `mana_default_regen` in seconds.

2
README.txt
View File

@ -38,7 +38,7 @@ Configuration
This mod can be configured with minetest.conf! The following settings are accepted: This mod can be configured with minetest.conf! The following settings are accepted:
* `mana_default_max`: Initial max. mana given to new players. Default: `200`. This value must be non-negative. * `mana_default_max`: Initial max. mana given to new players. Default: `200`. This value must be non-negative.
* `mana_default_regen`: Initial regenerated mana per “mana tick”. Default: `1`. This value must be non-negative. * `mana_default_regen`: Initial regenerated mana per “mana tick”. Default: `1`. This value can be a floating value. I.e. if the value is `0.5`, 1 mana is generated every two mana ticks (note that the player's mana amount is still a whole number). This value can be negative, in which case the player will lose mana.
* `mana_regen_timer`: The length of a “mana tick” in seconds. Each player will get his/her mana increased by the current * `mana_regen_timer`: The length of a “mana tick” in seconds. Each player will get his/her mana increased by the current
regen value per mana tick. Default: `0.2`. This value must be positive, also try to avoid very small values regen value per mana tick. Default: `0.2`. This value must be positive, also try to avoid very small values
as those could probably stress your machine a lot. as those could probably stress your machine a lot.