add doc/en/scripting/modules/*

This commit is contained in:
MihailRis
2024-06-13 21:08:06 +03:00
parent 92cc208b0a
commit d057f68432
8 changed files with 471 additions and 26 deletions
+12 -10
View File
@@ -1,3 +1,5 @@
# Модуль core:bit_converter
## Конвертация значений в байты и обратно
```lua
@@ -23,27 +25,27 @@ function bit_converter.double_to_bytes(number: double) -> table
```lua
function bit_converter.uint16_to_bytes(integer: int) -> table
```
Конвертирует беззнаковое 2-х битное целое число в байты
Конвертирует беззнаковое 2-х байтовое целое число в байты
```lua
function bit_converter.uint32_to_bytes(integer: int) -> table
```
Конвертирует беззнаковое 4-х битное целое число в байты
Конвертирует беззнаковое 4-х байтовое целое число в байты
```lua
function bit_converter.int16_to_bytes(integer: int) -> table
```
Конвертирует знаковое 2-х битное целое число в байты
Конвертирует знаковое 2-х байтовое целое число в байты
```lua
function bit_converter.int32_to_bytes(integer: int) -> table
```
Конвертирует знаковое 4-х битное целое число в байты
Конвертирует знаковое 4-х байтовое целое число в байты
```lua
function bit_converter.int64_to_bytes(integer: int) -> table
```
Конвертирует знаковое 8-и битное целое число в байты
Конвертирует знаковое 8-и байтовое целое число в байты
```lua
function bit_converter.bytes_to_string(table: bytes) -> string
@@ -68,24 +70,24 @@ function bit_converter.bytes_to_double(table: bytes) -> number
```lua
function bit_converter.bytes_to_uint16(table: bytes) -> integer
```
Конвертирует массив байтов в 2-х битное беззнаковое число
Конвертирует массив байтов в 2-х байтовое беззнаковое число
```lua
function bit_converter.bytes_to_uint32(table: bytes) -> integer
```
Конвертирует массив байтов в 4-х битное беззнаковое число
Конвертирует массив байтов в 4-х байтовое беззнаковое число
```lua
function bit_converter.bytes_to_int16(table: bytes) -> integer
```
Конвертирует массив байтов в 2-х битное знаковое число
Конвертирует массив байтов в 2-х байтовое знаковое число
```lua
function bit_converter.bytes_to_int32(table: bytes) -> integer
```
Конвертирует массив байтов в 4-х битное знаковое число
Конвертирует массив байтов в 4-х байтовое знаковое число
```lua
function bit_converter.bytes_to_int64(table: bytes) -> integer
```
Конвертирует массив байтов в 8-х битное знаковое число
Конвертирует массив байтов в 8-х байтовое знаковое число
+13 -11
View File
@@ -1,3 +1,5 @@
# Модуль core:data_buffer
## Буффер данных
### Хранит в себе массив байтов и позволяет легко получать или добавлять разные значения
@@ -39,27 +41,27 @@ function data_buffer:put_double(number: double)
```lua
function data_buffer:put_uint16(integer: int)
```
Конвертирует беззнаковое 2-х битное число в байты и записывает их в буффер
Конвертирует беззнаковое 2-х байтовое число в байты и записывает их в буффер
```lua
function data_buffer:put_uint32(integer: int)
```
Конвертирует беззнаковое 4-х битное число в байты и записывает их в буффер
Конвертирует беззнаковое 4-х байтовое число в байты и записывает их в буффер
```lua
function data_buffer:put_int16(integer: int)
```
Конвертирует знаковое 2-х битное число в байты и записывает их в буффер
Конвертирует знаковое 2-х байтовое число в байты и записывает их в буффер
```lua
function data_buffer:put_int32(integer: int)
```
Конвертирует знаковое 4-х битное число в байты и записывает их в буффер
Конвертирует знаковое 4-х байтовое число в байты и записывает их в буффер
```lua
function data_buffer:put_int64(integer: int)
```
Конвертирует знаковое 8-и битное число в байты и записывает их в буффер
Конвертирует знаковое 8-и байтовое число в байты и записывает их в буффер
```lua
function data_buffer:put_number(number: num)
@@ -110,27 +112,27 @@ function data_buffer:get_double() -> number
```lua
function data_buffer:get_uint16() -> integer
```
Читает следующее 2-х битное беззнаковое целое число из буффера
Читает следующее 2-х байтовое беззнаковое целое число из буффера
```lua
function data_buffer:get_uint32() -> integer
```
Читает следующее 4-х битное беззнаковое целое число из буффера
Читает следующее 4-х байтовое беззнаковое целое число из буффера
```lua
function data_buffer:get_int16() -> integer
```
Читает следующее 2-х битное знаковое целое число из буффера
Читает следующее 2-х байтовое знаковое целое число из буффера
```lua
function data_buffer:get_int32() -> integer
```
Читает следующее 4-х битное знаковое целое число из буффера
Читает следующее 4-х байтовое знаковое целое число из буффера
```lua
function data_buffer:get_int64() -> integer
```
Читает следующее 8-х битное знаковое целое число из буффера
Читает следующее 8-х байтовое знаковое целое число из буффера
```lua
function data_buffer:get_number() -> number
@@ -150,4 +152,4 @@ function data_buffer:set_position(integer: pos)
```lua
function data_buffer:set_bytes(table: bytes)
```
Устанавливает байты в буффер
Устанавливает байты в буффер
@@ -1,4 +1,5 @@
# Вектора
# Модули core:vector2, core:vector3
## Vector2
### Операции над векторами
@@ -7,6 +8,7 @@
function vector2:round(decimals: number) -> round[vec2]
```
Округление компонентов вектора
```lua
function vector2:len() -> number
```
@@ -68,7 +70,7 @@ function vector2:rot(
### Операции с векторами
```lua
local vec2 = require("res:vector2")
local vec2 = require("core:vector2")
local v1 = vec2(5, 10)
local v2 = vec2(10, 15)
@@ -170,7 +172,7 @@ function vector3:rot(
```lua
local vec3 = require("res:vector3")
local vec3 = require("core:vector3")
local v1 = vec3(1, 2, 3)
local v2 = vec3(4, 5, 6)