diff --git a/doc/en/scripting/ui.md b/doc/en/scripting/ui.md index 2d338a5aa..c92e79f9d 100644 --- a/doc/en/scripting/ui.md +++ b/doc/en/scripting/ui.md @@ -231,6 +231,22 @@ Properties: | value | string | yes | yes | Selected value | | options | table | yes | yes | List of options (tables `{value=..., text=...}`) | +## Progress bar (progressbar) + +Properties: + +| Name | Type | Read | Write | Description | +|------------|--------|------|-------|---------------------------------------------------------------| +| value | float | yes | yes | current value | +| min | float | yes | yes | minimum value | +| max | float | yes | yes | maximum value | +| progress | float | yes | no | progress 0..1 | +| barColor | rgba | yes | yes | color of the filled part | +| bgColor | rgba | yes | yes | background color (empty part) | +| textColor | rgba | yes | yes | text color | +| textFormat | string | yes | yes | text format (sprintf: `%1$` — raw value, `%2$` — percent 0–100) | +| smooth | bool | yes | yes | smooth value change | + ## Inventory Properties: diff --git a/doc/en/xml-ui-layouts.md b/doc/en/xml-ui-layouts.md index 0bd1b5353..e666b6210 100644 --- a/doc/en/xml-ui-layouts.md +++ b/doc/en/xml-ui-layouts.md @@ -193,6 +193,26 @@ Example of list description: - `selected` - initially selected value. Default: "". - `onselect` - function to which the user-selected value is passed +## Progress bar - *progressbar* + +Non-interactive element for displaying progress. Draws a background and a filled part. + +- `min` - minimal value. Type: number. Default: 0 +- `max` - maximal value. Type: number. Default: 100 +- `value` - initial value. Type: number. Default: 0 +- `bar-color` - color of the filled part. Type: RGBA color. Default: blue `#3399FFCC` +- `bg-color` - background color (empty part). Type: RGBA color. Default: semi-transparent black `#00000066` +- `orientation` - fill direction: `horizontal` / `vertical` +- `supplier` - Lua function - value supplier, called every frame +- `smooth` - smooth value change on updates. Type: boolean. Default: false +- `text-format` - format of the text centered in the bar (sprintf, two arguments: `%1$` - raw value, `%2$` - percent 0-100) + ```xml + + + + ``` +- `text-color` - text color. Type: RGBA color. Default: white `#FFFFFFFF` + ## *bindbox* An element for displaying and editing key or mouse button bindings. diff --git a/doc/ru/scripting/ui.md b/doc/ru/scripting/ui.md index 631d5e00f..7fca96d34 100644 --- a/doc/ru/scripting/ui.md +++ b/doc/ru/scripting/ui.md @@ -231,6 +231,22 @@ Canvas.decode(data: Bytearray, format: str) -> Canvas | value | string | да | да | Выбранное значение | | options | table | да | да | Список опций (таблиц `{value=..., text=...}`) | +## Прогресс-бар (progressbar) + +Свойства: + +| Название | Тип | Чтение | Запись | Описание | +| ---------- | ------ | ------ | ------ | ---------------------------------------------------------------------- | +| value | float | да | да | текущее значение | +| min | float | да | да | минимальное значение | +| max | float | да | да | максимальное значение | +| progress | float | да | нет | прогресс 0..1 | +| barColor | rgba | да | да | цвет заполненной части | +| bgColor | rgba | да | да | цвет фона (пустой части) | +| textColor | rgba | да | да | цвет текста | +| textFormat | string | да | да | формат текста (sprintf: `%1$` — сырое значение, `%2$` — процент 0–100) | +| smooth | bool | да | да | плавное изменение значения | + ## Инвентарь (inventory) Свойства: diff --git a/doc/ru/xml-ui-layouts.md b/doc/ru/xml-ui-layouts.md index 2ca6da1ce..06e73a497 100644 --- a/doc/ru/xml-ui-layouts.md +++ b/doc/ru/xml-ui-layouts.md @@ -194,6 +194,26 @@ - `selected` - изначально выбранное значение. По-умолчанию: "". - `onselect` - функция, в которую передаётся выбранное пользователем значение +## Прогресс-бар - *progressbar* + +Неинтерактивный элемент для отображения прогресса. Рисует фон и заполненную часть. + +- `min` — минимальное значение. Тип: число. По-умолчанию: 0 +- `max` — максимальное значение. Тип: число. По-умолчанию: 100 +- `value` — начальное значение. Тип: число. По-умолчанию: 0 +- `bar-color` — цвет заполненной части. Тип: RGBA цвет. По-умолчанию: синий `#3399FFCC` +- `bg-color` — цвет фона (пустой части). Тип: RGBA цвет. По-умолчанию: чёрный полупрозрачный `#00000066` +- `orientation` — направление заполнения: `horizontal` / `vertical` +- `supplier` — Lua-функция-поставщик значения, вызывается каждый кадр +- `smooth` — плавное изменение значения при обновлениях. Тип: логический. По-умолчанию: false +- `text-format` — формат текста по центру бара (sprintf, два аргумента: `%1$` — сырое значение, `%2$` — процент 0–100) + ```xml + + + + ``` +- `text-color` — цвет текста. Тип: RGBA цвет. По-умолчанию: белый `#FFFFFFFF` + ## Привязка ввода - *bindbox* Элемент для отображения и изменения привязки клавиш или кнопок мыши.