update doc/*/xml-ui-layouts.md

This commit is contained in:
MihailRis 2024-07-28 12:46:31 +03:00
parent 8ca12127db
commit 479046a268
2 changed files with 37 additions and 34 deletions

View File

@ -27,50 +27,52 @@ Examples:
# Common element attributes # Common element attributes
- **id** - element identifier. Type: string. - `id` - element identifier. Type: string.
- **pos** - element position. Type: 2D vector. - `pos` - element position. Type: 2D vector.
- **size** - element size. Type: 2D vector. - `size` - element size. Type: 2D vector.
- **color** - element color. Type: RGBA color. - `color` - element color. Type: RGBA color.
- **margin** - element margin. Type: 4D vector - `margin` - element margin. Type: 4D vector
*left, top, right, bottom* *left, top, right, bottom*
- **visible** - element visibility. Type: boolean (true/false) - `visible` - element visibility. Type: boolean (true/false)
- **position-func** - position supplier for an element (two numbers), called on every parent container size update or on element adding on a container. May be called before *on_hud_open* - `position-func` - position supplier for an element (two numbers), called on every parent container size update or on element adding on a container. May be called before *on_hud_open*
# Common *container* attributes # Common *container* attributes
Buttons and panels are also containers. Buttons and panels are also containers.
- **padding** - element padding. Type: 4D vector. - `padding` - element padding. Type: 4D vector.
*left, top, right, bottom* *left, top, right, bottom*
**scrollable** - element scrollability. Works on panels only. Type: boolean `scrollable` - element scrollability. Works on panels only. Type: boolean
# Common *panel* attributes # Common *panel* attributes
Buttons are also panels. Buttons are also panels.
- **max-length** - maximal length of panel stretching before scrolling (if scrollable = true). Type: number - `max-length` - maximal length of panel stretching before scrolling (if scrollable = true). Type: number
# Common elements # Common elements
## *button* ## *button*
Inner text is a button text. Inner text is a button text.
- **text-align** - inner text alignment (*left/center/right*). Type: string. - `text-align` - inner text alignment (*left/center/right*). Type: string.
- **onclick** - Lua function called on button press. - `onclick` - Lua function called on button press.
## *image* ## *image*
- **src** - name of an image stored in textures folder. Extension is not specified. Type: string. - `src` - name of an image stored in textures folder. Extension is not specified. Type: string.
Example: *gui/error* Example: *gui/error*
## *trackbar* ## *trackbar*
- **min** - minimal value. Type: number. Default: 0 - `min` - minimal value. Type: number. Default: 0
- **max** - maximal value. Type: number. Default: 1 - `max` - maximal value. Type: number. Default: 1
- **value** - initial value. Type: number. Default: 0 - `value` - initial value. Type: number. Default: 0
- **step** - track step size. Type: number: Default: 1 - `step` - track step size. Type: number: Default: 1
- **track-width** track pointer width (in steps). Type: number. Default: 1 - `track-width` track pointer width (in steps). Type: number. Default: 1
- **consumer** - Lua function - new value consumer - `consumer` - Lua function - new value consumer
- **supplier** - Lua function - value supplier - `supplier` - Lua function - value supplier
- `change-on-release` - Call consumer on trackbar release only. Type: boolean. Default: false
# Inventory elements # Inventory elements
@ -84,21 +86,21 @@ Element is a container. Does not have specific attributes.
## *slot* ## *slot*
Element must be in direct sub-element of *inventory*. Element must be in direct sub-element of *inventory*.
- **index** - inventory slot index (starting from 0). Type: integer - `index` - inventory slot index (starting from 0). Type: integer
- **item-source** - content access panel behaviour (infinite source of an item). Type: boolean - `item-source` - content access panel behaviour (infinite source of an item). Type: boolean
- **sharefunc** - Lua event called on <btn>LMB</btn> + <btn>Shift</btn>. Inventory id and slot index passed as arguments. - `sharefunc` - Lua event called on <btn>LMB</btn> + <btn>Shift</btn>. Inventory id and slot index passed as arguments.
- **updatefunc** - Lua event called on slot content update.Inventory id and slot index passed as arguments. - `updatefunc` - Lua event called on slot content update.Inventory id and slot index passed as arguments.
- **onrightclick** - Lua event called on <btn>RMB</btn> click. Inventory id and slot index passed as arguments. - `onrightclick` - Lua event called on <btn>RMB</btn> click. Inventory id and slot index passed as arguments.
## *slots-grid* ## *slots-grid*
- **start-index** - inventory slot index of the first slot. Type: integer - `start-index` - inventory slot index of the first slot. Type: integer
- **rows** - number of grid rows (unnecessary if *cols* and *count* specified). Type: integer - `rows` - number of grid rows (unnecessary if *cols* and *count* specified). Type: integer
- **cols** - number of grid columns (unnecessary if *rows* and *count* specified). Type: integer - `cols` - number of grid columns (unnecessary if *rows* and *count* specified). Type: integer
- **count** - total number of slots in grid (unnecessary if *rows* and *cols* specified). Type: integer - `count` - total number of slots in grid (unnecessary if *rows* and *cols* specified). Type: integer
- **interval** - visual slots interval. Type: number - `interval` - visual slots interval. Type: number
- **padding** - grid padding (not slots interval). Type: number. (*deprecated*) - `padding` - grid padding (not slots interval). Type: number. (*deprecated*)
- **sharefunc** - Lua event called on <btn>LMB</btn> + <btn>Shift</btn>. Inventory id and slot index passed as arguments. - `sharefunc` - Lua event called on <btn>LMB</btn> + <btn>Shift</btn>. Inventory id and slot index passed as arguments.
- **updatefunc** - Lua event called on slot content update.Inventory id and slot index passed as arguments. - `updatefunc` - Lua event called on slot content update.Inventory id and slot index passed as arguments.
- **onrightclick** - Lua event called on <btn>RMB</btn> click. Inventory id and slot index passed as arguments. - `onrightclick` - Lua event called on <btn>RMB</btn> click. Inventory id and slot index passed as arguments.

View File

@ -117,6 +117,7 @@
- `track-color` - цвет указателя при наведении курсора. Тип: RGBA цвет. - `track-color` - цвет указателя при наведении курсора. Тип: RGBA цвет.
- `consumer` - lua функция-приемник установленного значения - `consumer` - lua функция-приемник установленного значения
- `supplier` - lua функция-поставщик значения - `supplier` - lua функция-поставщик значения
- `change-on-release` - Вызов функции-приемника (consumer) происходит только тогда, когда пользователь отпускает указатель. Тип: логический. По-умолчанию: false
# Элементы инвентаря # Элементы инвентаря