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

Update documentation about internal stuff about changing and hiding

Browse Source
This commit is contained in:
Wuzzy 2015-02-11 20:47:29 +01:00
parent 1016828877
commit 6ff02d4db8
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
API.md
View File

@ -105,6 +105,9 @@ You use the function `hb.change_hudbar` for this.
Changes the values of an initialized HUD bar for a certain player. `new_value` and `new_max_value` Changes the values of an initialized HUD bar for a certain player. `new_value` and `new_max_value`
can be `nil`; if one of them is `nil`, that means the value is unchanged. If both values can be `nil`; if one of them is `nil`, that means the value is unchanged. If both values
are `nil`, this function is a no-op. are `nil`, this function is a no-op.
This function also tries minimize the amount of calls to `hud_change` of the Minetest Lua API, and
therefore, network traffic. `hud_change` is only called if it is actually needed, i.e. when the
actual length of the bar or the displayed string changed, so you do not have to worry about it.
#### Parameters #### Parameters
* `player`: `ObjectRef` of the player to which the HUD bar belongs to * `player`: `ObjectRef` of the player to which the HUD bar belongs to
@ -119,7 +122,8 @@ Always `nil`.
## Hiding and unhiding a HUD bar ## Hiding and unhiding a HUD bar
You can also hide custom HUD bars, meaning they will not be displayed for a certain player. You can still You can also hide custom HUD bars, meaning they will not be displayed for a certain player. You can still
use `hb.change_hudbar` on a hidden HUD bar, the new values will be correctly displayed after the HUD bar use `hb.change_hudbar` on a hidden HUD bar, the new values will be correctly displayed after the HUD bar
has been unhidden. has been unhidden. Both functions will only call `hud_change` if there has been an actual change to avoid
unneccessary traffic.
Note that the hidden state of a HUD bar will *not* be saved by this mod on server shutdown, so you may need Note that the hidden state of a HUD bar will *not* be saved by this mod on server shutdown, so you may need
to write your own routines for this. to write your own routines for this.