API.md

   1 API documentation for the HUD bars mod 1.4.1
   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)`
  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`: This is optional; You can specify an alternative format string display the final text on the HUD bar. The default format string is “`%s: %d/%d`” (in this order: Label, current value, maximum value). See also the Lua documentation of `string.format`.
  70
  71 #### Return value
  72 Always `nil`.
  73
  74
  75 ## Displaying a HUD bar
  76 After a HUD bar has been registered, they are not yet displayed yet for any player. HUD bars must be
  77 explicitly initialized on a per-player basis.
  78
  79 You probably want to do this in the `minetest.register_on_joinplayer`.
  80
  81 ### `hb.init_hudbar(player, identifier, start_value, start_max, start_hidden)`
  82 This function initialzes and activates a previously registered HUD bar and assigns it to a
  83 certain client/player. This has only to be done once per player and after that, you can change
  84 the values using `hb.change_hudbar`.
  85
  86 However, if `start_hidden` was set to `true` for the HUD bar (in `hb.register_hudbar`), the HUD bar
  87 will initially be hidden, but the HUD elements are still sent to the client. Otherwise,
  88 the HUD bar will be initially be shown to the player.
  89
  90 #### Parameters
  91 * `player`: `ObjectRef` of the player to which the new HUD bar should be displayed to.
  92 * `identifier`: The identifier of the HUD bar type, as specified in `hb.register_hudbar`.
  93 * `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`.
  94 * `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`
  95 * `start_hidden`: Whether the HUD bar is initially hidden. This is optional, `default_start_hidden` of the registration function will be used as default
  96
  97 #### Return value
  98 Always `nil`.
  99
 100
 101
 102 ## Modifying a HUD bar
 103 After a HUD bar has been added, you can change the current and maximum value and other attributes on a per-player basis.
 104 You use the function `hb.change_hudbar` for this.
 105
 106 ### `hb.change_hudbar(player, identifier, new_value, new_max_value, new_icon, new_bgicon, new_bar, new_label, new_text_color)`
 107 Changes the values and the appearance of an initialized HUD bar for a certain player. `new_value`
 108 and `new_max_value` are the most important parameters as they specify the new current and maximum new values, you do not need
 109 to worry too much about the other parameters.
 110
 111 The following parameters are less important and provided for styling the HUD bar after registration (if
 112 this is desired). The “styling” parameters parallel the parameters of `hb.register_hudbar`. It is
 113 recommended to not change the style of a HUD bar too often as this can be distracting or confusing
 114 for players.
 115
 116 `new_value`, `new_max_value` `new_icon`, `new_bgicon`, `new_bar`, `new_label` and `new_text_color` can be
 117 `nil`; if one of them is `nil`, that means the value is unchanged. If all those values are `nil`, this
 118 function is a no-op.
 119
 120 This function tries to minimize the amount of calls to `hud_change` of the Minetest Lua API
 121 (and thus, network traffic), when you only change the value and/or  maximum value. In this case,
 122 `hud_change` is only called if it is actually needed, e.g. when the actual length of the bar
 123 or the displayed string changed, so you do not have to worry about it. There is, however, no
 124 such network optimization for the “styling” parameters, so keep this in mind.
 125
 126 #### Parameters
 127 * `player`: `ObjectRef` of the player to which the HUD bar belongs to
 128 * `identifier`: The identifier of the HUD bar type to change, as specified in `hb.register_hudbar`.
 129 * `new_value`: The new current value of the HUD bar
 130 * `new_max_value`: The new maximum value of the HUD bar
 131 * `new_icon`: File name of the new icon
 132 * `new_bgicon`: File name of the new background icon for the modern-style statbar
 133 * `new_bar`: File name of the new bar segment image
 134 * `new_label`: A new text label of the HUD bar. Note the format string still applies
 135 * `new_text_color`: A 3-octet number defining the new color of the text.
 136
 137 #### Return value
 138 Always `nil`.
 139
 140
 141 ## Hiding and unhiding a HUD bar
 142 You can also hide custom HUD bars, meaning they will not be displayed for a certain player. You can still
 143 use `hb.change_hudbar` on a hidden HUD bar, the new values will be correctly displayed after the HUD bar
 144 has been unhidden. Both functions will only call `hud_change` if there has been an actual change to avoid
 145 unneccessary traffic.
 146
 147 Note that the hidden state of a HUD bar will *not* be saved by this mod on server shutdown, so you may need
 148 to write your own routines for this or by setting the correct value for `start_hidden` when calling
 149 `hb.init_hudbar`.
 150
 151 ### `hb.hide_hudbar(player, identifier)`
 152 Hides the specified HUD bar from the screen of the specified player.
 153
 154 #### Parameters
 155 * `player`: `ObjectRef` of the player to which the HUD bar belongs to
 156 * `identifier`: The identifier of the HUD bar type to hide, as specified in `hb.register_hudbar`.
 157
 158 #### Return value
 159 Always `nil`.
 160
 161
 162 ### `hb.unhide_hudbar(player, identifier)`
 163 Makes a previously hidden HUD bar visible again to a player.
 164
 165 #### Parameters
 166 * `player`: `ObjectRef` of the player to which the HUD bar belongs to
 167 * `identifier`: The identifier of the HUD bar type to unhide, as specified in `hb.register_hudbar`.
 168
 169 #### Return value
 170 Always `nil`.
 171
 172
 173 ## Reading HUD bar information
 174 It is also possible to read information about an active HUD bar.
 175
 176 ### `hb.get_hudbar_state(player, identifier)`
 177 Returns the current state of the active player's HUD bar.
 178
 179 #### Parameters
 180 * `player`: `ObjectRef` of the player to which the HUD bar belongs to
 181 * `identifier`: The identifier of the HUD bar type to hide, as specified in `hb.register_hudbar`.
 182
 183 #### Return value
 184 A table which holds information on the current state of the HUD bar. Note the table is a deep
 185 copy of the internal HUD bar state, it is *not* a reference; the information hold by the table is
 186 only true for the moment you called this function. The fields of this table are:
 187
 188 * `value`: Current value of HUD bar.
 189 * `max`: Current maximum value of HUD bar.
 190 * `hidden`: Boolean denoting whether the HUD bar is hidden.
 191 * `barlength`: The length of the HUD bar in pixels. This field is meaningless if the HUD bar is currently hidden.
 192 * `text`: The text shown on the HUD bar. This fiels is meaningless if the HUD bar is currently hidden.