summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWuzzy <almikes@aol.com>2015-02-11 20:54:13 +0100
committerWuzzy <almikes@aol.com>2015-02-11 20:54:13 +0100
commit4b1c38fdcf6ba5dab86d8f1ff5d0927136d479d2 (patch)
treecffc6eaf4105c10b58b039d3125fedc15c9a34ad
parent6ff02d4db865ea6fef0b7c30764624005fd736ac (diff)
Fix documentation on hb.register_hudbar
-rw-r--r--API.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/API.md b/API.md
index 14c2934..5e2d55d 100644
--- a/API.md
+++ b/API.md
@@ -50,10 +50,13 @@ a vertical gradient.
A 16×16 image shown left of the HUD bar. This is optional.
### `hb.register_hudbar(identifier, text_color, label, textures, default_start_value, default_start_max, start_hide, format_string)`
-This function adds a new custom HUD
+This function registers a new custom HUD bar definition to the HUD bars mod, so it can be later used to be displayed, changed, hidden
+and unhidden on a per-player basis.
Note this does not yet display the HUD bar.
-There is currently no reliable way to force a certain order at which the custom HUD bars will be placed.
+The HUD bars will be displayed in a “first come, first serve” order. This mod does not allow fow a custom order or a way to set it
+manually in a reliable way.
+
#### Parameters
* `identifier`: A globally unique internal name for the HUD bar, will be used later to refer to it. Please only rely on alphanumeric characters for now.