forked from VoxeLibre/VoxeLibre
Resopnd to review comments changing API.md file
This commit is contained in:
parent
b8a2b47af4
commit
36a7b5f3bf
|
|
@ -1,4 +1,4 @@
|
|||
# vl_hudbars mod API
|
||||
# `vl_hudbars` mod API
|
||||
|
||||
This mod is used for registering hudbars to display stats e.g. health, breath on the player's screen for VoxeLibre
|
||||
|
||||
|
|
@ -28,45 +28,45 @@ When being squished, layers can overlap, so the correct z_index_step should be u
|
|||
### `vl_hudbars.register_hudbar(hudbar_params)`
|
||||
Register a new hudbar which can be subsequently used for players
|
||||
All types of hudbar can have fields:
|
||||
* identifier: string (required) - the technical name of this hudbar
|
||||
* sort_index: number (default 0) - the priority in terms of y-positioning relative to other hudbars; setting this value lower will make the hudbar lower down on average
|
||||
* on_right: bool (default false) - which side of the screen to put this hudbar; false puts it on left, true on right
|
||||
* direction: number (default 0) - the direction to display this hudbar; 0 is left-to-right, 1 is right-to-left, other values are not allowed
|
||||
* layer_gap: number (default 4) - the number of pixels gap to put by default between layers of this hudbar - will be decreased by hudbar squishing
|
||||
* scale_y: number (default 1) - the aspect ratio of the icons on the hudbar, i.e. height/width of icon texture
|
||||
* value_type: string (default "absolute") - can take "absolute" or "proportional"; see above
|
||||
* is_compound: bool (default false) - whether this hudbar is compound or simple; see above *WARNING: Proportional compound hudbars are untested and might crash the game*
|
||||
* take_up_space: bool (default true) - whether this hudbar should cause other hudbars to reposition or whether they may be drawn over this hudbar *WARNING: Untested*
|
||||
* value_scale: number (default 1) - for "absolute"-type hudbars, how much one half-texture represents in value
|
||||
* round_to_full_texture: bool (default false) - whether this hudbar should be forced to a whole number of background textures displayed, even if its maximum number of half-textures is odd; applies to all parts of the hudbar
|
||||
* z_index: number (default 99) - the z-index of the first layer of this hudbar (see MT Lua API docs)
|
||||
* `identifier`: string (required) - the technical name of this hudbar
|
||||
* `sort_index`: number (default 0) - the priority in terms of y-positioning relative to other hudbars; setting this value lower will make the hudbar lower down on average
|
||||
* `on_right`: bool (default false) - which side of the screen to put this hudbar; false puts it on left, true on right
|
||||
* `direction`: number (default 0) - the direction to display this hudbar; 0 is left-to-right, 1 is right-to-left, other values are not allowed
|
||||
* `layer_gap`: number (default 4) - the number of pixels gap to put by default between layers of this hudbar - will be decreased by hudbar squishing
|
||||
* `scale_y`: number (default 1) - the aspect ratio of the icons on the hudbar, i.e. height/width of icon texture
|
||||
* `value_type`: string (default "absolute") - can take "absolute" or "proportional"; see above
|
||||
* `is_compound`: bool (default false) - whether this hudbar is compound or simple; see above *WARNING: Proportional compound hudbars are unused in the game itself and are considered an experimental feature. Bugs are possible.*
|
||||
* `take_up_space`: bool (default true) - whether this hudbar should cause other hudbars to reposition or whether they may be drawn over this hudbar *WARNING: Untested*
|
||||
* `value_scale`: number (default 1) - for "absolute"-type hudbars, how much one half-texture represents in value
|
||||
* `round_to_full_texture`: bool (default false) - whether this hudbar should be forced to a whole number of background textures displayed, even if its maximum number of half-textures is odd; applies to all parts of the hudbar
|
||||
* `z_index`: number (default 99) - the z-index of the first layer of this hudbar (see MT Lua API docs)
|
||||
|
||||
Fields applicable to simple-type hudbars:
|
||||
* default_max_val: number (default 1) - the starting maximum value of this hudbar when it is instantiated (don't set to 0 for "proportional"-type hudbars)
|
||||
* default_value: number (default 0) - the starting value of this hudbar when it is instantiated
|
||||
* default_hidden: bool (default false) - whether to automatically hide this hudbar when it is instantiated
|
||||
* icon: texture string (required) - the default 'on' texture of this hudbar when it is instantiated
|
||||
* bgicon: texture string (required) - the default 'off' texture of this hudbar when it is instantiated
|
||||
* layers: number (default 1) - for "proportional"-type hudbars, how many layers this hudbar should have
|
||||
* z_index_step: number (default -1) - how much to change z-index by each layer; useful for changing how a hudbar should look when squished
|
||||
* `default_max_val`: number (default 1) - the starting maximum value of this hudbar when it is instantiated (don't set to 0 for "proportional"-type hudbars)
|
||||
* `default_value`: number (default 0) - the starting value of this hudbar when it is instantiated
|
||||
* `default_hidden`: bool (default false) - whether to automatically hide this hudbar when it is instantiated
|
||||
* `icon`: texture string (required) - the default 'on' texture of this hudbar when it is instantiated
|
||||
* `bgicon`: texture string (required) - the default 'off' texture of this hudbar when it is instantiated
|
||||
* `layers`: number (default 1) - for "proportional"-type hudbars, how many layers this hudbar should have
|
||||
* `z_index_step`: number (default -1) - how much to change z-index by each layer; useful for changing how a hudbar should look when squished
|
||||
|
||||
Fields applicable to compound-type hudbars
|
||||
* parts: table (required) - the table of parts this hudbar should have; the keys are part identifiers and the values are tables defining the parts:
|
||||
* default_max_val: number (default 1) - the starting maximum value of this part when it is instantiated (don't set to 0 for "proportional"-type hudbars)
|
||||
* default_value: number (default 0) - the starting value of this part when it is instantiated
|
||||
* default_hidden: bool (default false) - whether to automatically hide this part when it is instantiated
|
||||
* icon: texture string (required) - the default 'on' texture of this part when it is instantiated
|
||||
* bgicon: texture string (required) - the default 'off' texture of this part when it is instantiated
|
||||
* layers: number (default 1) - for "proportional"-type hudbars, how many layers this part should have
|
||||
* part_sort_index: number (default 0) - the priority in terms of y-positioning this part has in the hudbar
|
||||
* take_up_space: bool (default true) - whether this part should cause other parts to reposition or whether they may be drawn over this part *WARNING: Untested*
|
||||
* z_index_offset: number (default -1) - how much to change z-index by at the start of drawing this part (set to -1 because when a part starts on a new layer the normal z_index_step is not applied)
|
||||
* z_index_step: number (default -1) - how much to change z-index by each layer; useful for changing how a part should look when squished (recommended to set to same for all parts, especially for "absolute"-type hudbars)
|
||||
* `parts`: table (required) - the table of parts this hudbar should have; the keys are part identifiers and the values are tables defining the parts:
|
||||
* `default_max_val`: number (default 1) - the starting maximum value of this part when it is instantiated (don't set to 0 for "proportional"-type hudbars)
|
||||
* `default_value`: number (default 0) - the starting value of this part when it is instantiated
|
||||
* `default_hidden`: bool (default false) - whether to automatically hide this part when it is instantiated
|
||||
* `icon`: texture string (required) - the default 'on' texture of this part when it is instantiated
|
||||
* `bgicon`: texture string (required) - the default 'off' texture of this part when it is instantiated
|
||||
* `layers`: number (default 1) - for "proportional"-type hudbars, how many layers this part should have
|
||||
* `part_sort_index`: number (default 0) - the priority in terms of y-positioning this part has in the hudbar
|
||||
* `take_up_space`: bool (default true) - whether this part should cause other parts to reposition or whether they may be drawn over this part *WARNING: Untested*
|
||||
* `z_index_offset`: number (default -1) - how much to change z-index by at the start of drawing this part (set to -1 because when a part starts on a new layer the normal z_index_step is not applied)
|
||||
* `z_index_step`: number (default -1) - how much to change z-index by each layer; useful for changing how a part should look when squished (recommended to set to same for all parts, especially for "absolute"-type hudbars)
|
||||
|
||||
### `vl_hudbars.init_hudbar(player, identifier)`
|
||||
Instantiate a hudbar for a particular player
|
||||
* player: ObjectRef of a player - if it is anything else the function is no-op
|
||||
* identifier: string - the identifier of the hudbar to instantiate; must have been registered previously
|
||||
* `player`: ObjectRef of a player - if it is anything else the function is no-op
|
||||
* `identifier`: string - the identifier of the hudbar to instantiate; must have been registered previously
|
||||
Should reset hudbar to default values if this function has previously been called *WARNING: Untested*
|
||||
|
||||
### `vl_hudbars.remove_hudbar(player, identifier)`
|
||||
|
|
@ -75,18 +75,18 @@ If the player does not have this hudbar instantiated this function is no-op
|
|||
|
||||
### `vl_hudbars.change_value(player, identifier, value, max_val, part)`
|
||||
Change the value and maximum value of a hudbar for a player
|
||||
* player: ObjectRef of a player - if it is anything else the function is no-op
|
||||
* identifier: string - the identifier of the hudbar to change the value of; must have been registered previously
|
||||
* value: number or nil - the new value of this hudbar, remains unchanged if nil
|
||||
* max_val: number or nil - the new maximum value of this hudbar, remains unchanged if nil
|
||||
* part: string or nil - the part of the hudbar to change the value of (for compound hudbars)
|
||||
* `player`: ObjectRef of a player - if it is anything else the function is no-op
|
||||
* `identifier`: string - the identifier of the hudbar to change the value of; must have been registered previously
|
||||
* `value`: number or nil - the new value of this hudbar, remains unchanged if nil
|
||||
* `max_val`: number or nil - the new maximum value of this hudbar, remains unchanged if nil
|
||||
* `part`: string or nil - the part of the hudbar to change the value of (for compound hudbars)
|
||||
If the player does not have this hudbar instantiated this function is no-op
|
||||
|
||||
### `vl_hudbars.hide(player, identifier, part)`
|
||||
Hide a hudbar for a player
|
||||
* player: ObjectRef of a player - if it is anything else the function is no-op
|
||||
* identifier: string - the identifier of the hudbar to hide; must have been registered previously
|
||||
* part: string or nil - the part of the hudbar to hide (for compound hudbars); if left nil all parts will be hidden
|
||||
* `player`: ObjectRef of a player - if it is anything else the function is no-op
|
||||
* `identifier`: string - the identifier of the hudbar to hide; must have been registered previously
|
||||
* `part`: string or nil - the part of the hudbar to hide (for compound hudbars); if left nil all parts will be hidden
|
||||
If the player does not have this hudbar instantiated this function is no-op
|
||||
|
||||
### `vl_hudbars.show(player, identifier, part)`
|
||||
|
|
@ -94,10 +94,10 @@ Show a hudbar for a player
|
|||
|
||||
### `vl_hudbars.set_icon(player, identifier, new_icon, part)`
|
||||
Change the icon of a hudbar
|
||||
* player: ObjectRef of a player - if it is anything else the function is no-op
|
||||
* identifier: string - the identifier of the hudbar to change icon of; must have been registered previously
|
||||
* new_icon: texture string - the new texture to use as the 'on' icon
|
||||
* part: string or nil - the part of the hudbar to change icon of (for compound hudbars)
|
||||
* `player`: ObjectRef of a player - if it is anything else the function is no-op
|
||||
* `identifier`: string - the identifier of the hudbar to change icon of; must have been registered previously
|
||||
* `new_icon`: texture string - the new texture to use as the 'on' icon
|
||||
* `part`: string or nil - the part of the hudbar to change icon of (for compound hudbars)
|
||||
If the player does not have this hudbar instantiated this function is no-op
|
||||
|
||||
### `vl_hudbars.reset_icon(player, identifier, part)`
|
||||
|
|
@ -114,8 +114,8 @@ Registers a hudbar icon modifier function applicable to all players.
|
|||
A hudbar icon modifier can change the icon on a hudbar based on certain conditions
|
||||
Hudbar icon modifications are mutually exclusive (only one may apply at once)
|
||||
Fields in `def`:
|
||||
* identifier: string (required) - the hudbar to modify
|
||||
* predicated: function(player) (required) - should return truthy if the player meets the condition required to change the look of the hudbar
|
||||
* icon: texture string (required) - the texture that the hudbar icon should be changed to
|
||||
* priority: number (required) - the priority of this modifier; a lower number is checked (and activated) with higher priority
|
||||
* part: string or nil - the part of the hudbar to modify (must be nil for simple hudbars, not-nil for compound hudbars)
|
||||
* `identifier`: string (required) - the hudbar to modify
|
||||
* `predicate`: function(player) (required) - should return truthy if the player meets the condition required to change the look of the hudbar
|
||||
* `icon`: texture string (required) - the texture that the hudbar icon should be changed to
|
||||
* `priority`: number (required) - the priority of this modifier; a lower number is checked (and activated) with higher priority
|
||||
* `part`: string or nil - the part of the hudbar to modify (must be nil for simple hudbars, not-nil for compound hudbars)
|
||||
|
|
|
|||
Loading…
Reference in New Issue