summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWuzzy <almikes@aol.com>2015-02-12 03:31:27 +0100
committerWuzzy <almikes@aol.com>2015-02-12 03:31:27 +0100
commitc2e2a377e615345da941b85a66869a8948f8eaeb (patch)
tree4b5945a1e972b21b7383d1e231b4eca836effc42
parent1d4af7e0eeb5d318f44b2414edbd2f87e582ce05 (diff)
Mention the keywords “health” and “breath”
-rw-r--r--API.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/API.md b/API.md
index 0f20ff7..e421d8d 100644
--- a/API.md
+++ b/API.md
@@ -25,7 +25,7 @@ In order to use this API, you should be aware of a few basic rules in order to u
* Both current value and maximum must not be smaller than 0
* Both current value and maximum must be real numbers. So no NaN, infinity, etc.
* The HUD bar will be hidden if the maximum equals 0. This is intentional.
-* The health and breath HUD bars are hardcoded and can not be changed with this API.
+* The health and breath HUD bars are hardcoded.
These are soft rules, the HUD bars mod will not enforce all of these.
But this mod has been programmed under the assumption that these rules are followed, for integrity.
@@ -59,7 +59,7 @@ 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.
+* `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. The identifiers “`health`” and “`breath`” are used internally for the built-in health and breath bar, respectively. Please do not use these names.
* `text_color`: A 3-octet number defining the color of the text. The octets denote, in this order red, green and blue and range from `0x00` (complete lack of this component) to `0xFF` (full intensity of this component). Example: `0xFFFFFF` for white.
* `label`: A string which is displayed on the HUD bar itself to describe the HUD bar. Try to keep this string short.
* `textures`: A table with the following fields: