mods/hudbars/API.md

   1 API documentation for the HUD bars mod
   2 ======================================
   3
   4 ## Introduction
   5 This API allows you to add, change, hide and unhide custom HUD bars for this mod.
   6
   7 ## Overview
   8 To give you a *very* brief overview over this API, here is the basic workflow on how to add your own custom HUD bar:
   9
  10 * Create images for your HUD bar
  11 * Call `hb.register_hudbar` to make the definition of the HUD bar known to this mod
  12 * Call `hb.init_hudbar` for each player for which you want to use previously defined HUD bar
  13 * Use `hb.change_hudbar` whenever you need to change the values of a HUD bar of a certain player
  14 * If you need it: Use `hb.hide_hudbar` and `hb.unhide_hudbar` to hide or unhide HUD bars of a certain player
  15
  16 ## The basic rules
  17 In order to use this API, you should be aware of a few basic rules in order to understand it:
  18
  19 * A HUD bar is an approximate graphical representation of the ratio of a current value and a maximum value, i.e. current health of 15 and maximum health of 20. A full HUD bar represents 100%, an empty HUD bar represents 0%.
  20 * The current value must always be equal to or smaller then the maximum
  21 * Both current value and maximum must not be smaller than 0
  22 * Both current value and maximum must be real numbers. So no NaN, infinity, etc.
  23 * The HUD bar will be hidden if the maximum equals 0. This is intentional.
  24 * The health and breath HUD bars are hardcoded.
  25
  26 These are soft rules, the HUD bars mod will not enforce all of these.
  27 But this mod has been programmed under the assumption that these rules are followed, for integrity.
  28
  29 ## Adding a HUD bar
  30 To make a new HUD bar known to this mod, you need …
  31
  32 * … an image of size 2×16 for the bar
  33 * … an icon of size 16×16 (optional)
  34 * … to register it with `hb.register_hudbar`
  35
  36 ### Bar image
  37 The image for the bar will be repeated horizontally to denote the “value” of the HUD bar.
  38 It **must** be of size 2×16.
  39 If neccessary, the image will be split vertically in half, and only the left half of the image
  40 is displayed. So the final HUD bar will always be displayed on a per-pixel basis.
  41
  42 The default bar images are single-colored, but you can use other styles as well, for instance,
  43 a vertical gradient.
  44
  45 ### Icon
  46 A 16×16 image shown left of the HUD bar. This is optional.
  47
  48 ### `hb.register_hudbar(identifier, text_color, label, textures, default_start_value, default_start_max, default_start_hidden, format_string, format_string_config)`
  49 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
  50 and unhidden on a per-player basis.
  51 Note this does not yet display the HUD bar.
  52
  53 The HUD bars will be displayed in a “first come, first serve” order. This API does not allow fow a custom order or a way to set it
  54 manually in a reliable way. However, you can use the setting `hudbars_sorting` for this. See the advanced setting menu in Minetest
  55 for more information.
  56
  57
  58 #### Parameters
  59 * `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.
  60 * `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.
  61 * `label`: A string which is displayed on the HUD bar itself to describe the HUD bar. Try to keep this string short.
  62 * `textures`: A table with the following fields:
  63  * `bar`: The file name of the bar image (as string). This is only used for the `progress_bar` bar type (see `README.txt`, settings section).
  64  * `icon`: The file name of the icon, as string. For the `progress_bar` type, it is shown as single image left of the bar, for the two statbar bar types, it is used as the statbar icon and will be repeated. This field can be `nil`, in which case no icon will be used, but this is not recommended, because the HUD bar will be invisible if the one of the statbar bar types is used.
  65  * `bgicon`: The file name of the background icon, it is used as the background for the modern statbar mode only. This field can be `nil`, in which case no background icon will be displayed in this mode.
  66 * `default_start_value`: If this HUD bar is added to a player, and no initial value is specified, this value will be used as initial current value
  67 * `default_max_value`: If this HUD bar is added to a player, and no initial maximum value is specified, this value will be used as initial maximum value
  68 * `default_start_hidden`: The HUD bar will be initially start hidden by default when added to a player. Use `hb.unhide_hudbar` to unhide it.
  69 * `format_string`: Optional; You can specify an alternative format string to use for the final text on the HUD bar. The default format string is “`@1: @2/@3`” (The “@” numbers are placeholders that have a meaning in this order: @1 = Label, @2 = current value, @3 = maximum value). Do *not* use minetest.translator on this string, the string will be translated by `hudbars`, but you still must put this string into the translation catalogue file.
  70 * `format_string_config`: Required if `format_string` is set. This allows to change which parameters to use in the format string. It's a table with these fields:
  71  * `textdomain`: Text domain of the format string, used by `minetest.translate`
  72  * `order`: Table that contains the order of the placeholders. It's also possible to remove placeholders. Default order: `{ "label", "value", "max_value" }`
  73  * `format_value`: Format string to apply when displaying `value`. Syntax is same as in `string.format`. Default: `"%d"`
  74  * `format_max_value`: Same as `format_value` but is applied to `max_value`
  75
  76 #### Example
  77 Example (mostly) from `hbarmor` mod:
  78
  79 ```
  80 hb.register_hudbar("armor", 0xFFFFFF, minetest.translator("hbarmor", "Armor"), { icon = "hbarmor_icon.png", bgicon = "hbarmor_bgicon.png", bar = "hbarmor_bar.png" }, 0, 100, hbarmor.autohide, N("@1: @2%"), { order = { "label", "value" }, textdomain = "hbarmor" } )
  81 ```
  82
  83 Displays an armor HUD bar with a label of the form „Armor: 53%“. (`N` is a dummy function that returns its argument, used to make the string visible for translator scripts.)
  84
  85 #### Return value
  86 Always `nil`.
  87
  88
  89 ## Displaying a HUD bar
  90 After a HUD bar has been registered, they are not yet displayed yet for any player. HUD bars must be
  91 explicitly initialized on a per-player basis.
  92
  93 You probably want to do this in the `minetest.register_on_joinplayer`.
  94
  95 ### `hb.init_hudbar(player, identifier, start_value, start_max, start_hidden)`
  96 This function initialzes and activates a previously registered HUD bar and assigns it to a
  97 certain client/player. This has only to be done once per player and after that, you can change
  98 the values using `hb.change_hudbar`.
  99
 100 However, if `start_hidden` was set to `true` for the HUD bar (in `hb.register_hudbar`), the HUD bar
 101 will initially be hidden, but the HUD elements are still sent to the client. Otherwise,
 102 the HUD bar will be initially be shown to the player.
 103
 104 #### Parameters
 105 * `player`: `ObjectRef` of the player to which the new HUD bar should be displayed to.
 106 * `identifier`: The identifier of the HUD bar type, as specified in `hb.register_hudbar`.
 107 * `start_value`: The initial current value of the HUD bar. This is optional, `default_start_value` of the registration function will be used, if this is `nil`.
 108 * `start_max`: The initial maximum value of the HUD bar. This is optional, `default_start_max` of the registration function will be used, if this is `nil`
 109 * `start_hidden`: Whether the HUD bar is initially hidden. This is optional, `default_start_hidden` of the registration function will be used as default
 110
 111 #### Return value
 112 `true` on success, `false` otherwise.
 113
 114
 115 ## Modifying a HUD bar
 116 After a HUD bar has been added, you can change the current and maximum value and other attributes on a per-player basis.
 117 You use the function `hb.change_hudbar` for this.
 118
 119 ### `hb.change_hudbar(player, identifier, new_value, new_max_value, new_icon, new_bgicon, new_bar, new_label, new_text_color)`
 120 Changes the values and the appearance of an initialized HUD bar for a certain player. `new_value`
 121 and `new_max_value` are the most important parameters as they specify the new current and maximum new values, you do not need
 122 to worry too much about the other parameters.
 123
 124 The following parameters are less important and provided for styling the HUD bar after registration (if
 125 this is desired). The “styling” parameters parallel the parameters of `hb.register_hudbar`. It is
 126 recommended to not change the style of a HUD bar too often as this can be distracting or confusing
 127 for players.
 128
 129 `new_value`, `new_max_value` `new_icon`, `new_bgicon`, `new_bar`, `new_label` and `new_text_color` can be
 130 `nil`; if one of them is `nil`, that means the value is unchanged. If all those values are `nil`, this
 131 function is a no-op.
 132
 133 This function tries to minimize the amount of calls to `hud_change` of the Minetest Lua API
 134 (and thus, network traffic), when you only change the value and/or  maximum value. In this case,
 135 `hud_change` is only called if it is actually needed, e.g. when the actual length of the bar
 136 or the displayed string changed, so you do not have to worry about it. There is, however, no
 137 such network optimization for the “styling” parameters, so keep this in mind.
 138
 139 #### Parameters
 140 * `player`: `ObjectRef` of the player to which the HUD bar belongs to
 141 * `identifier`: The identifier of the HUD bar type to change, as specified in `hb.register_hudbar`.
 142 * `new_value`: The new current value of the HUD bar
 143 * `new_max_value`: The new maximum value of the HUD bar
 144 * `new_icon`: File name of the new icon
 145 * `new_bgicon`: File name of the new background icon for the modern-style statbar
 146 * `new_bar`: File name of the new bar segment image
 147 * `new_label`: A new text label of the HUD bar. Note the format string still applies
 148 * `new_text_color`: A 3-octet number defining the new color of the text.
 149
 150 #### Return value
 151 `true` on success, `false` otherwise.
 152
 153
 154 ## Hiding and unhiding a HUD bar
 155 You can also hide custom HUD bars, meaning they will not be displayed for a certain player. You can still
 156 use `hb.change_hudbar` on a hidden HUD bar, the new values will be correctly displayed after the HUD bar
 157 has been unhidden. Both functions will only call `hud_change` if there has been an actual change to avoid
 158 unneccessary traffic.
 159
 160 Note that the hidden state of a HUD bar will *not* be saved by this mod on server shutdown, so you may need
 161 to write your own routines for this or by setting the correct value for `start_hidden` when calling
 162 `hb.init_hudbar`.
 163
 164 ### `hb.hide_hudbar(player, identifier)`
 165 Hides the specified HUD bar from the screen of the specified player.
 166
 167 #### Parameters
 168 * `player`: `ObjectRef` of the player to which the HUD bar belongs to
 169 * `identifier`: The identifier of the HUD bar type to hide, as specified in `hb.register_hudbar`.
 170
 171 #### Return value
 172 `true` on success, `false` otherwise.
 173
 174
 175 ### `hb.unhide_hudbar(player, identifier)`
 176 Makes a previously hidden HUD bar visible again to a player.
 177
 178 #### Parameters
 179 * `player`: `ObjectRef` of the player to which the HUD bar belongs to
 180 * `identifier`: The identifier of the HUD bar type to unhide, as specified in `hb.register_hudbar`.
 181
 182 #### Return value
 183 `true` on success, `false` otherwise.
 184
 185
 186 ## Reading HUD bar information
 187 It is also possible to read information about existing HUD bars.
 188
 189 ### `hb.get_hudbar_state(player, identifier)`
 190 Returns the current state of the active player's HUD bar.
 191
 192 #### Parameters
 193 * `player`: `ObjectRef` of the player to which the HUD bar belongs to
 194 * `identifier`: The identifier of the HUD bar type to hide, as specified in `hb.register_hudbar`.
 195
 196 #### Return value
 197 On success, returns a table which holds information on the current state of the HUD bar. Note
 198 the table is a deep copy of the internal HUD bar state, it is *not* a reference; the information
 199 hold by the table is only true for the moment you called this function. The fields of this table are:
 200
 201 * `value`: Current value of HUD bar.
 202 * `max`: Current maximum value of HUD bar.
 203 * `hidden`: Boolean denoting whether the HUD bar is hidden.
 204 * `barlength`: The length of the HUD bar in pixels. This field is meaningless if the HUD bar is currently hidden.
 205 * `text`: The text shown on the HUD bar. This fiels is meaningless if the HUD bar is currently hidden.
 206
 207 If the player does not exist, returns `nil` instead.
 208
 209 ### `hb.get_hudbar_identifiers()`
 210 Returns a table of all currently registered HUD bar identifiers.