minetest-australopithecus/minetest-australopithecus-auto-hud-hide
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added usage information.

Browse Source
This commit is contained in:
Robert Zenz 2015-12-19 10:42:08 +01:00
parent 04f683c37a
commit f1db6405ed
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README
View File

@ -42,3 +42,18 @@ The system can be configured by adding settings to the `minetest.conf`:
# The interval in which the check is run, in seconds, defaults to 0.1.
autohudhide_interval = 0.1
Run manually
------------
You can invoke the system manually either for all players by invoking
`autohudhide.run`, or on a single player by invoking `autohidehud.run_on_player`
which accepts the Player as single parameter.
Force activation
----------------
You can also force the activation of the system, even if it has been disabled
in the configuration, by invoking `autohudhide.activate_internal`.