update doc/*/scripting/builtins/libentities.md

This commit is contained in:
MihailRis 2025-11-25 18:28:39 +03:00
parent d450bd3564
commit 145a7b6273
2 changed files with 17 additions and 0 deletions

View File

@ -36,6 +36,15 @@ entities.def_index(name: str) -> int
-- Returns number of available entity definitions
entities.defs_count() -> int
```
> [!NOTE]
> The following functions for retrieving multiple entities return tables with integer keys (uid).
> For iteration, use `pairs`, and for calculating the table size, use `table.count_pairs`.
> Using `ipairs` will yield incorrect results, since the returned table is not an array.
```lua
-- Returns a table of all loaded entities
entities.get_all() -> table

View File

@ -35,6 +35,14 @@ entities.def_index(name: str) -> int
-- Возвращает число доступных определений сущностей
entities.defs_count() -> int
```
> [!NOTE]
> Следующие функции для получения получения нескольких сущностей возвращают таблицы с целочисленными ключами (uid).
> Для итерации нужно использовать pairs, для подсчёта размера таблицы - table.count_pairs.
> Использование ipairs даст некорректные результаты, так как возвращаемая таблица не является массивом.
```lua
-- Возвращает таблицу всех загруженных сущностей
entities.get_all() -> table