PulseStudio/VoxelEngine
PulseStudio/VoxelEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

documentation update

Browse Source
This commit is contained in:
Onran 2024-12-06 17:13:09 +09:00 committed by GitHub
parent 6a0bdde3b9
commit 0cd04e6570
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 57 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
doc/ru/scripting/modules/core_bit_converter.md
View File

@ -1,93 +1,98 @@
# Модуль core:bit_converter # Модуль core:bit_converter
## Доступные порядки байтов
**LE (Little-Endian)**
**BE (Big-Endian)**
По умолчанию используется **LE**
## Конвертация значений в байты и обратно ## Конвертация значений в байты и обратно
```lua ```lua
function bit_converter.string_to_bytes(string: str) -> table function bit_converter.string_to_bytes(str: string) -> table
``` ```
Конвертирует строку в байты Конвертирует строку в байты
```lua ```lua
function bit_converter.bool_to_byte(boolean: bool) -> integer function bit_converter.bool_to_byte(bool: boolean) -> integer
``` ```
Конвертирует логический булев в байт Конвертирует логический булев в байт
```lua ```lua
function bit_converter.single_to_bytes(number: single) -> table function bit_converter.float32_to_bytes(float: number, [опционально] order: string) -> table
``` ```
Конвертирует плавающее значение одинарной точности в байты Конвертирует плавающее значение одинарной точности в байты
```lua ```lua
function bit_converter.double_to_bytes(number: double) -> table function bit_converter.float64_to_bytes(float: number, [опционально] order: string) -> table
``` ```
Конвертирует плавающее значение двойной точности в байты Конвертирует плавающее значение двойной точности в байты
```lua ```lua
function bit_converter.uint16_to_bytes(integer: int) -> table function bit_converter.uint16_to_bytes(int: integer, [опционально] order: string) -> table
``` ```
Конвертирует беззнаковое 2-х байтовое целое число в байты Конвертирует беззнаковое 2-х байтовое целое число в байты
```lua ```lua
function bit_converter.uint32_to_bytes(integer: int) -> table function bit_converter.uint32_to_bytes(int: integer, [опционально] order: string) -> table
``` ```
Конвертирует беззнаковое 4-х байтовое целое число в байты Конвертирует беззнаковое 4-х байтовое целое число в байты
```lua ```lua
function bit_converter.int16_to_bytes(integer: int) -> table function bit_converter.sint16_to_bytes(int: integer, [опционально] order: string) -> table
``` ```
Конвертирует знаковое 2-х байтовое целое число в байты Конвертирует знаковое 2-х байтовое целое число в байты
```lua ```lua
function bit_converter.int32_to_bytes(integer: int) -> table function bit_converter.sint32_to_bytes(int: integer, [опционально] order: string) -> table
``` ```
Конвертирует знаковое 4-х байтовое целое число в байты Конвертирует знаковое 4-х байтовое целое число в байты
```lua ```lua
function bit_converter.int64_to_bytes(integer: int) -> table function bit_converter.int64_to_bytes(int: integer, [опционально] order: string) -> table
``` ```
Конвертирует знаковое 8-и байтовое целое число в байты Конвертирует знаковое 8-и байтовое целое число в байты
```lua ```lua
function bit_converter.bytes_to_string(table: bytes) -> string function bit_converter.bytes_to_string(bytes: table) -> string
``` ```
Конвертирует массив байтов в строку Конвертирует массив байтов в строку
```lua ```lua
function bit_converter.byte_to_bool(integer: byte) -> boolean function bit_converter.byte_to_bool(byte: integer) -> boolean
``` ```
Конвертирует байт в логическое булевое значение Конвертирует байт в логическое булевое значение
```lua ```lua
function bit_converter.bytes_to_single(table: bytes) -> number№ function bit_converter.bytes_to_float32(bytes: table|Bytearray, [опционально] order: string) -> number
``` ```
Конвертирует массив байтов в плавающее число одинарной точности Конвертирует массив байтов в плавающее число одинарной точности
```lua ```lua
function bit_converter.bytes_to_double(table: bytes) -> number function bit_converter.bytes_to_float64(bytes: table|Bytearray, [опционально] order: string) -> number
``` ```
Конвертирует массив байтов в плавающее число двойной точности Конвертирует массив байтов в плавающее число двойной точности
```lua ```lua
function bit_converter.bytes_to_uint16(table: bytes) -> integer function bit_converter.bytes_to_uint16(bytes: table|Bytearray, [опционально] order: string) -> integer
``` ```
Конвертирует массив байтов в 2-х байтовое беззнаковое число Конвертирует массив байтов в 2-х байтовое беззнаковое число
```lua ```lua
function bit_converter.bytes_to_uint32(table: bytes) -> integer function bit_converter.bytes_to_uint32(bytes: table|Bytearray, [опционально] order: string) -> integer
``` ```
Конвертирует массив байтов в 4-х байтовое беззнаковое число Конвертирует массив байтов в 4-х байтовое беззнаковое число
```lua ```lua
function bit_converter.bytes_to_int16(table: bytes) -> integer function bit_converter.bytes_to_sint16(bytes: table|Bytearray, [опционально] order: string) -> integer
``` ```
Конвертирует массив байтов в 2-х байтовое знаковое число Конвертирует массив байтов в 2-х байтовое знаковое число
```lua ```lua
function bit_converter.bytes_to_int32(table: bytes) -> integer function bit_converter.bytes_to_sint32(bytes: table|Bytearray, [опционально] order: string) -> integer
``` ```
Конвертирует массив байтов в 4-х байтовое знаковое число Конвертирует массив байтов в 4-х байтовое знаковое число
```lua ```lua
function bit_converter.bytes_to_int64(table: bytes) -> integer function bit_converter.bytes_to_int64(bytes: table|Bytearray, [опционально] order: string) -> integer
``` ```
Конвертирует массив байтов в 8-х байтовое знаковое число Конвертирует массив байтов в 8-х байтовое знаковое число

57
doc/ru/scripting/modules/core_data_buffer.md
View File

@ -4,67 +4,78 @@
### Хранит в себе массив байтов и позволяет легко получать или добавлять разные значения ### Хранит в себе массив байтов и позволяет легко получать или добавлять разные значения
```lua ```lua
function data_buffer(bytes) function data_buffer(
[опционально] bytes: table,
[опционально] order: string,
[опционально] useBytearray: boolean
)
``` ```
Создаёт новый экземпляр data_buffer (параметр bytes необязательный) Создаёт новый экземпляр **data_buffer**.
Если **useBytearray** равен **true**, то байты буффера будут хранится ввиде **Bytearray**. Это может снизить производительность, но также и уменьшить размер буффера в памяти
```lua ```lua
function data_buffer:put_byte(integer: byte) function data_buffer:set_order(order: string)
```
Задаёт порядок байтов для чисел.
Должен равняться одному из перечисленных в [**bit_converter**](core_bit_converter.md)
```lua
function data_buffer:put_byte(byte: integer)
``` ```
Записывает байт в буффер Записывает байт в буффер
```lua ```lua
function data_buffer:put_bytes(table: bytes) function data_buffer:put_bytes(bytes: table|Bytearray)
``` ```
Записывает байты в буффер Записывает байты в буффер
```lua ```lua
function data_buffer:put_string(string: str) function data_buffer:put_string(str: string)
``` ```
Конвертирует строку в байты и записывает их в буффер Конвертирует строку в байты и записывает их в буффер
```lua ```lua
function data_buffer:put_bool(boolean: bool) function data_buffer:put_bool(bool: boolean)
``` ```
Конвертирует булевое значение в байт и записывает его в буффер Конвертирует булевое значение в байт и записывает его в буффер
```lua ```lua
function data_buffer:put_single(number: single) function data_buffer:put_float32(float: number)
``` ```
Конвертирует плавающее число одинарной точности в байты и записывает их в буффер Конвертирует плавающее число одинарной точности в байты и записывает их в буффер
```lua ```lua
function data_buffer:put_double(number: double) function data_buffer:put_float64(float: number)
``` ```
Конвертирует плавающее число двойной точности в байты и записывает их в буффер Конвертирует плавающее число двойной точности в байты и записывает их в буффер
```lua ```lua
function data_buffer:put_uint16(integer: int) function data_buffer:put_uint16(int: integer)
``` ```
Конвертирует беззнаковое 2-х байтовое число в байты и записывает их в буффер Конвертирует беззнаковое 2-х байтовое число в байты и записывает их в буффер
```lua ```lua
function data_buffer:put_uint32(integer: int) function data_buffer:put_uint32(int: integer)
``` ```
Конвертирует беззнаковое 4-х байтовое число в байты и записывает их в буффер Конвертирует беззнаковое 4-х байтовое число в байты и записывает их в буффер
```lua ```lua
function data_buffer:put_int16(integer: int) function data_buffer:put_sint16(int: integer)
``` ```
Конвертирует знаковое 2-х байтовое число в байты и записывает их в буффер Конвертирует знаковое 2-х байтовое число в байты и записывает их в буффер
```lua ```lua
function data_buffer:put_int32(integer: int) function data_buffer:put_sint32(int: integer)
``` ```
Конвертирует знаковое 4-х байтовое число в байты и записывает их в буффер Конвертирует знаковое 4-х байтовое число в байты и записывает их в буффер
```lua ```lua
function data_buffer:put_int64(integer: int) function data_buffer:put_int64(int: integer)
``` ```
Конвертирует знаковое 8-и байтовое число в байты и записывает их в буффер Конвертирует знаковое 8-и байтовое число в байты и записывает их в буффер
```lua ```lua
function data_buffer:put_number(number: num) function data_buffer:put_number(num: number)
``` ```
Конвертирует любое число в байты и записывает их в буффер; Конвертирует любое число в байты и записывает их в буффер;
@ -73,10 +84,10 @@ function data_buffer:put_number(number: num)
zero = 0 zero = 0
uint16 = 1 uint16 = 1
uint32 = 2 uint32 = 2
int16 = 3
int32 = 4
int64 = 5 int64 = 5
double = 6 float64 = 6
sint16 = 7
sint32 = 8
``` ```
```lua ```lua
@ -85,9 +96,9 @@ function data_buffer:get_byte() -> integer
Возвращает следующий байт из буффера Возвращает следующий байт из буффера
```lua ```lua
function data_buffer:get_bytes(n) -> table function data_buffer:get_bytes(n) -> table|Bytearray
``` ```
Возвращает n следующих байтов, если n равен nil или не указан, то возвращается массив всех байтов Возвращает **n** следующих байтов, если **n** равен **nil** или не указан, то возвращается массив всех байтов
```lua ```lua
function data_buffer:get_string() -> string function data_buffer:get_string() -> string
@ -100,12 +111,12 @@ function data_buffer:get_bool() -> boolean
Читает следующий логический булев из буффера Читает следующий логический булев из буффера
```lua ```lua
function data_buffer:get_single() -> number function data_buffer:get_float32() -> number
``` ```
Читает следующее плавающее число одинарной точности из буффера Читает следующее плавающее число одинарной точности из буффера
```lua ```lua
function data_buffer:get_double() -> number function data_buffer:get_float64() -> number
``` ```
Читает следующее плавающее число двойной точности из буффера Читает следующее плавающее число двойной точности из буффера
@ -120,12 +131,12 @@ function data_buffer:get_uint32() -> integer
Читает следующее 4-х байтовое беззнаковое целое число из буффера Читает следующее 4-х байтовое беззнаковое целое число из буффера
```lua ```lua
function data_buffer:get_int16() -> integer function data_buffer:get_sint16() -> integer
``` ```
Читает следующее 2-х байтовое знаковое целое число из буффера Читает следующее 2-х байтовое знаковое целое число из буффера
```lua ```lua
function data_buffer:get_int32() -> integer function data_buffer:get_sint32() -> integer
``` ```
Читает следующее 4-х байтовое знаковое целое число из буффера Читает следующее 4-х байтовое знаковое целое число из буффера