Improved docs (#708)

* начало переписи доков

* extensions update

* libapp update

* libfile update

* io_stream update

* Update io_stream.md

* io_stream update x3

* io_stream update x4

* libtime update

* libgui update + make bytearray.md

* libinput update

* Update libapp.md

* Update libapp.md

* libgui update

* events.md ru fix

* да ну не надо так делать

--> не имеет смысла, ибо гитхаб -> показывает адекватно

* types refactoring

* fixes

* Update libblock.md

* Update libblock.md

* Update libbyteutil.md
This commit is contained in:
Xertis 2025-12-18 12:58:39 +03:00 • committed by MihailRis
parent 8b31bdeb78
commit ac02bc0c8e
43 changed files with 1107 additions and 1314 deletions

View file

@ -1,15 +1,15 @@
# Библиотека *pack*
```python
pack.is_installed(packid: str) -> bool
```lua
pack.is_installed(packid: string) -> boolean
```
Проверяет наличие установленного пака в мире
```lua
pack.data_file(packid: str, filename: str) -> str
pack.data_file(packid: string, filename: string) -> string
-- и
pack.shared_file(packid: str, filename: str) -> str
pack.shared_file(packid: string, filename: string) -> string
```
Возвращает путь к файлу данных
@ -33,46 +33,46 @@ file.write(pack.shared_file(PACK_ID, "example.txt"), text)
Используйте для хранения данных общих для всех миров.
```python
pack.get_folder(packid: str) -> str
```lua
pack.get_folder(packid: string) -> string
```
Возвращает путь к папке установленного контент-пака.
```python
pack.is_installed(packid: str) -> bool
```lua
pack.is_installed(packid: string) -> boolean
```
Проверяет наличие контент-пака в мире
```python
pack.get_installed() -> массив строк
```lua
pack.get_installed() -> table<string>
```
Возращает id всех установленных в мире контент-паков.
```python
pack.get_available() -> массив строк
```lua
pack.get_available() -> table<string>
```
Возвращает id всех доступных, но не установленных в мире контент-паков.
```python
pack.get_base_packs() -> массив строк
```lua
pack.get_base_packs() -> table<string>
```
Возвращает id всех базовых паков (неудаляемых)
```lua
pack.get_info(packid: str) -> {
id: str,
title: str,
creator: str,
description: str,
version: str,
path: str,
icon: str, -- отсутствует в headless режиме
dependencies: опциональный массив строк
pack.get_info(packid: string) -> {
id: string,
title: string,
creator: string,
description: string,
version: string,
path: string,
icon: string, -- отсутствует в headless режиме
dependencies: table<string> -- опциональный
}
```
@ -88,17 +88,17 @@ pack.get_info(packid: str) -> {
производить сканирование для каждого пака:
```lua
pack.get_info(packids: table) -> {id={...}, id2={...}, ...}
pack.get_info(packids: table<string>) -> table<string, table>
```
```lua
pack.assemble(packids: table) -> table
pack.assemble(packids: table<string>) -> table<string>
```
Проверяет корректность конфигурации и добавляет зависимости, возвращая полную.
Проверяет корректность конфигурации и добавляет зависимости, возвращая полную конфигурацию.
```lua
pack.request_writeable(packid: str, callback: function(str))
pack.request_writeable(packid: string, callback: function(string))
```
Запрашивает у пользователя право на модификацию пака. При подтвержении новая точка входа будет передана в callback.
Запрашивает у пользователя право на модификацию пака. При подтвержении новая точка входа будет передана в callback.