mirror of
https://github.com/MihailRis/voxelcore.git
synced 2026-11-21 09:59:44 +00:00
fix docs typos and other trash
This commit is contained in:
parent
9744407599
commit
ef61e28f50
88 changed files with 359 additions and 358 deletions
|
|
@ -95,4 +95,4 @@ function bit_converter.bytes_to_sint32(bytes: table|Bytearray, [опционал
|
|||
```lua
|
||||
function bit_converter.bytes_to_int64(bytes: table|Bytearray, [опционально] order: string) -> int
|
||||
```
|
||||
Конвертирует массив байтов в 8-х байтовое знаковое число
|
||||
Конвертирует массив байтов в 8-и байтовое знаковое число
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Модуль core:data_buffer
|
||||
|
||||
## Буффер данных
|
||||
## Буфер данных
|
||||
### Хранит в себе массив байтов и позволяет легко получать или добавлять разные значения
|
||||
|
||||
```lua
|
||||
|
|
@ -11,7 +11,7 @@ function data_buffer(
|
|||
)
|
||||
```
|
||||
Создаёт новый экземпляр **data_buffer**.
|
||||
Если **useBytearray** равен **true**, то байты буффера будут хранится ввиде **Bytearray**. Это может снизить производительность, но также и уменьшить размер буффера в памяти
|
||||
Если **useBytearray** равен **true**, то байты буфера будут храниться в виде **Bytearray**. Это может снизить производительность, но также и уменьшить размер буфера в памяти
|
||||
|
||||
```lua
|
||||
function data_buffer:set_order(order: string)
|
||||
|
|
@ -22,62 +22,62 @@ function data_buffer:set_order(order: string)
|
|||
```lua
|
||||
function data_buffer:put_byte(byte: int)
|
||||
```
|
||||
Записывает байт в буффер
|
||||
Записывает байт в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_bytes(bytes: table|Bytearray)
|
||||
```
|
||||
Записывает байты в буффер
|
||||
Записывает байты в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_string(str: string)
|
||||
```
|
||||
Конвертирует строку в байты и записывает их в буффер
|
||||
Конвертирует строку в байты и записывает их в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_bool(bool: boolean)
|
||||
```
|
||||
Конвертирует булевое значение в байт и записывает его в буффер
|
||||
Конвертирует булевое значение в байт и записывает его в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_float32(float: number)
|
||||
```
|
||||
Конвертирует плавающее число одинарной точности в байты и записывает их в буффер
|
||||
Конвертирует плавающее число одинарной точности в байты и записывает их в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_float64(float: number)
|
||||
```
|
||||
Конвертирует плавающее число двойной точности в байты и записывает их в буффер
|
||||
Конвертирует плавающее число двойной точности в байты и записывает их в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_uint16(int: int)
|
||||
```
|
||||
Конвертирует беззнаковое 2-х байтовое число в байты и записывает их в буффер
|
||||
Конвертирует беззнаковое 2-х байтовое число в байты и записывает их в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_uint32(int: int)
|
||||
```
|
||||
Конвертирует беззнаковое 4-х байтовое число в байты и записывает их в буффер
|
||||
Конвертирует беззнаковое 4-х байтовое число в байты и записывает их в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_sint16(int: int)
|
||||
```
|
||||
Конвертирует знаковое 2-х байтовое число в байты и записывает их в буффер
|
||||
Конвертирует знаковое 2-х байтовое число в байты и записывает их в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_sint32(int: int)
|
||||
```
|
||||
Конвертирует знаковое 4-х байтовое число в байты и записывает их в буффер
|
||||
Конвертирует знаковое 4-х байтовое число в байты и записывает их в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_int64(int: int)
|
||||
```
|
||||
Конвертирует знаковое 8-и байтовое число в байты и записывает их в буффер
|
||||
Конвертирует знаковое 8-и байтовое число в байты и записывает их в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_number(num: number)
|
||||
```
|
||||
Конвертирует любое число в байты и записывает их в буффер;
|
||||
Конвертирует любое число в байты и записывает их в буфер;
|
||||
|
||||
Первый байт это тип значения:
|
||||
```lua
|
||||
|
|
@ -93,7 +93,7 @@ sint32 = 8
|
|||
```lua
|
||||
function data_buffer:get_byte() -> int
|
||||
```
|
||||
Возвращает следующий байт из буффера
|
||||
Возвращает следующий байт из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_bytes(n) -> table|Bytearray
|
||||
|
|
@ -103,47 +103,47 @@ function data_buffer:get_bytes(n) -> table|Bytearray
|
|||
```lua
|
||||
function data_buffer:get_string() -> string
|
||||
```
|
||||
Читает следующую строку из буффера
|
||||
Читает следующую строку из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_bool() -> boolean
|
||||
```
|
||||
Читает следующий логический булев из буффера
|
||||
Читает следующий логический булев из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_float32() -> number
|
||||
```
|
||||
Читает следующее плавающее число одинарной точности из буффера
|
||||
Читает следующее плавающее число одинарной точности из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_float64() -> number
|
||||
```
|
||||
Читает следующее плавающее число двойной точности из буффера
|
||||
Читает следующее плавающее число двойной точности из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_uint16() -> int
|
||||
```
|
||||
Читает следующее 2-х байтовое беззнаковое целое число из буффера
|
||||
Читает следующее 2-х байтовое беззнаковое целое число из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_uint32() -> int
|
||||
```
|
||||
Читает следующее 4-х байтовое беззнаковое целое число из буффера
|
||||
Читает следующее 4-х байтовое беззнаковое целое число из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_sint16() -> int
|
||||
```
|
||||
Читает следующее 2-х байтовое знаковое целое число из буффера
|
||||
Читает следующее 2-х байтовое знаковое целое число из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_sint32() -> int
|
||||
```
|
||||
Читает следующее 4-х байтовое знаковое целое число из буффера
|
||||
Читает следующее 4-х байтовое знаковое целое число из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_int64() -> int
|
||||
```
|
||||
Читает следующее 8-х байтовое знаковое целое число из буффера
|
||||
Читает следующее 8-и байтовое знаковое целое число из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_number() -> number
|
||||
|
|
@ -153,14 +153,14 @@ function data_buffer:get_number() -> number
|
|||
```lua
|
||||
function data_buffer:size() -> int
|
||||
```
|
||||
Возвращает размер буффера
|
||||
Возвращает размер буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:set_position(int: pos)
|
||||
```
|
||||
Устанавливает текущую позицию в буффере
|
||||
Устанавливает текущую позицию в буфере
|
||||
|
||||
```lua
|
||||
function data_buffer:set_bytes(table: bytes)
|
||||
```
|
||||
Устанавливает байты в буффер
|
||||
Устанавливает байты в буфер
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ function vector2:rot(
|
|||
angle: number->rad,
|
||||
--Вращение вектора относительно осей ("x", "y", "z")
|
||||
axis: str,
|
||||
--Если истина, то угол поворота певеодится автоматический из градусы в радианы
|
||||
--Если истина, то угол поворота переводится автоматически из градусов в радианы
|
||||
convert2deg: bool
|
||||
) -> vec2
|
||||
```
|
||||
|
|
@ -162,7 +162,7 @@ function vector3:rot(
|
|||
angle: number->rad,
|
||||
--Вращение вектора относительно осей ("x", "y", "z")
|
||||
axis: str,
|
||||
--Если истина, то угол поворота певеодится автоматический из градусы в радианы
|
||||
--Если истина, то угол поворота переводится автоматически из градусов в радианы
|
||||
convert2deg: bool
|
||||
) -> vec2
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue