====== Функции игрового движка ======

===== get_response =====
**Краткое описание:**\\
Возвращает готовую строку из пакета отправленного сервером клиенту. Получить ответ от сервера в специальном формате строки.\\
**Использование:**
<Code Lua [enable_line_numbers=0]>get_response( flag )</Code>
**Обязательные аргументы:**
  * 1 : <flag> (integer -- число)

===== createFileRecovery =====
**Краткое описание:**\\
Создает служебный файл игрового движка\\
**Использование:**
<Code Lua [start_line_numbers_at=1]>-- Восстановление настроек запуска движка
function goRecovery()
  ...

  -- Создание файла после некорректного выхода
  cl_exec( "createFileRecovery", "../cache.dat" )
end</Code>
Создает файл в данном случае **cache.dat** с текстом внутри:
<Code Lua [enable_line_numbers=0]>recoveryMode=1</Code>
**Обязательные аргументы:**
  * 1 : <имя файла> (строка)

===== declareRecovery =====
**Краткое описание:**\\
Сообщает игровому движку о файле\\
<Code Lua [enable_line_numbers=0]>cl_exec( "declareRecovery", "../cache.dat" )</Code>
**Обязательные аргументы:**
  * 1 : <имя файла> (строка)

===== getRecoveryFile =====
**Краткое описание:**\\
Получает назначенный файл от игрового движка
<Code Lua [enable_line_numbers=0]>cl_exec( "getRecoveryFile" )</Code>

===== wait =====
**Краткое описание:**\\
Создает временную задержку в миллисекундах\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "wait", 100 )</Code>
**Обязательные аргументы:**
  * 1 : <длительность> (мс)

===== yield =====
**Краткое описание:**\\
Создает в потоке временную задержку (используется для снижения нагрузки на процессор)\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "yield" )</Code>

===== quitApp =====
**Краткое описание:**\\
Игровой движок завершает работу. Выход из приложения\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "quitApp" )</Code>

===== existsFile =====
**Краткое описание:**\\
Возвращает **true** или **false** при проверке на существование файла\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "existsFile", filename )</Code>
**Обязательные аргументы:**
  * 1 : <имя файла> (строка)

===== msg =====
**Краткое описание:**\\
Создает диалоговое окно с вопросом и отработкой кнопок\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "msg", "Предыдущий запуск: MotionEngine завершился некорректно.\nЗапустить в безопасном режиме?\n\nЭто рекомендуется сделать большинству пользователей.", 
    "Запустить в безопасном режиме?", "MB_YESNOCANCEL", "MB_ICONWARNING" )</Code>
**Полный пример использования:**
<Code Lua [start_line_numbers_at=1]>-- Создание MessageBox
messagebox = cl_exec( "msg", "Предыдущий запуск: MotionEngine завершился некорректно.\nЗапустить в безопасном режиме?\n\nЭто рекомендуется сделать большинству пользователей.", 
"Запустить в безопасном режиме?", "MB_YESNOCANCEL", "MB_ICONWARNING" )

-- 6, 7, 2
if(cl_exec( "getMsgID", messagebox ) == "IDYES") then
  cl_exec( "deleteFile", cl_exec( "getRecoveryFile" ) )
end
if(cl_exec( "getMsgID", messagebox ) == "IDNO") then
  cl_exec( "deleteFile", cl_exec( "getRecoveryFile" ) )
end
if(cl_exec( "getMsgID", messagebox ) == "IDCANCEL") then 
  
end</Code>
кусок кода из C++ (согласно: [[https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-messagebox|https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-messagebox]])
<Code Сpp [enable_line_numbers=0]>// Кнопки
#define MB_ABORTRETRYIGNORE   0x00000002L
#define MB_CANCELTRYCONTINUE  0x00000006L
#define MB_HELP               0x00004000L
#define MB_OK                 0x00000000L
#define MB_OKCANCEL           0x00000001L
#define MB_RETRYCANCEL        0x00000005L
#define MB_YESNO              0x00000004L
#define MB_YESNOCANCEL        0x00000003L
    
// Иконки
#define MB_ICONEXCLAMATION    0x00000030L
#define MB_ICONWARNING        0x00000030L
#define MB_ICONINFORMATION    0x00000040L
#define MB_ICONASTERISK       0x00000040L
#define MB_ICONQUESTION       0x00000020L
#define MB_ICONSTOP           0x00000010L
#define MB_ICONERROR          0x00000010L
#define MB_ICONHAND           0x00000010L
</Code>
**Обязательные аргументы:**
  * 1 : <текст> (строка)
  * 2 : <заголовок окна> (строка)
  * 3 : <кнопки> (строка)
  * 4 : <иконка> (строка)

===== getMsgID =====
**Краткое описание:**\\
Возвращает строку. Преобразует число в ID события\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "getMsgID", messagebox )</Code>
**Может возвращать**
  * 1 **IDOK**
  * 2 **IDCANCEL**
  * 3 **IDABORT**
  * 4 **IDRETRY**
  * 5 **IDIGNORE**
  * 6 **IDYES**
  * 17 **IDNO**
  * 10 **IDTRYAGAIN**
  * 11 **IDCONTINUE**
**Обязательные аргументы:**
  * 1 : <messagebox> (integer -- число) Ответ от диалогового окна

===== readTable =====
**Краткое описание:**\
Аналог стандартной функции **require** ([[#require]]). Для подключения модулей в отдельных потоках.\\
**Пример создания таблицы:**
<Code Lua [start_line_numbers_at=1]>local ServerType = {
    name = "ExampleServer",
    version = "1.0"
}

function ServerType:greet()
    print( "Hello from " .. self.name )
end

function ServerType:greet2()
    print( "Test from " .. self.name )
end
return ServerType
</Code>
**Пример использования таблицы:**
<Code Lua [start_line_numbers_at=1]>local ServerType = cl_exec( "readTable" , "mp._servertype" )
for k, v in pairs( ServerType ) do
    print( "Key:", k, "Value:", v )
end</Code>
**Обязательные аргументы:**
  * 1 : <имя файла> (строка). Путь вместо **'**/**'**, пишется точка.

===== joinServer =====
**Краткое описание:**\\
Подключение к серверу, указывается IP-адрес и порт.\\
**Возвращает integer:**
  * 0 -- если не указан IP-адрес сервера для подключения
  * 1 -- если IP-адрес был указан и модуль сетевой готов подключится
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "joinServer", "192.168.138.128", 28600 )</Code>
**Обязательные аргументы:**
  * 1 : <IP> (строка).
  * 2 : <port> (integer -- число).

===== disconnect =====
**Краткое описание:**\\
Производит отключение от сервера.\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "disconnect" )</Code>
**Примечание**\\
Рекомендуем использовать внутри условия [[#isActiveServer]], что активно подключение к серверу
<Code Lua [start_line_numbers_at=1]>
if cl_exec( "isActiveServer" ) then
  -- тут
end
</Code>

===== createPacket =====
**Краткое описание:**\\
Создает и отправляет пакет серверу\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "createPacket", flag, int_table( _serverType, "LOW" ), "getPosition()" )</Code>
**Обязательные аргументы:**
  * 1 : <тип> (integer -- число). Тип пакета
  * 2 : <критичность> (integer -- число). Критичность пакета
  * 3 : <контент> (строка). Текст пакета
**Примечание**\\
Рекомендуем использовать внутри условия [[#isActiveServer]]
<Code Lua [start_line_numbers_at=1]>
if cl_exec( "isActiveServer" ) then
  -- тут
end
</Code>

===== getActivePlayer =====
**Краткое описание:**\\
Возвращает текущего игрока (за которого мы играем!) а именно его ID в модуле сервера\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "getActivePlayer" )</Code>
**Примечание**\\
Рекомендуем использовать внутри условия [[#isActiveServer]]. Возвращать функция может ID строку либо пустая строка.
<Code Lua [start_line_numbers_at=1]>
if cl_exec( "isActiveServer" ) then
  -- тут
end
</Code>

===== isActiveServer =====
**Краткое описание:**\\
Возвращает:
  * 0 -- если нет соединенися с сервером
  * 1 -- если уже подключены к серверу
**Пример использования:**
<Code Lua [start_line_numbers_at=1]>
if cl_exec( "isActiveServer" ) then
  ...
end
</Code>

===== PropsLoading =====
**Краткое описание:**\\
Задает режим игровому движку. Используется для создания новых объектов моделей на сцене. **Функция устаревшая (не понятно работает или нет)**\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "PropsLoading", <integer> )</Code>
**Обязательные аргументы:**
  * 1 : <integer> (число). (0 -- начать работу с объектами или 1 -- закончить работу с объектами)

===== PropRemove =====
**Краткое описание:**\\
Добавляет в список для дальнейшего удаления объекта. После добавления необходимо произвести удаление с помощью функции [[#PropProcessRemove]]
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "PropRemove", "db07dc8054b761be7db7e22227cc2787" )</Code>
**Обязательные аргументы:**
  * 1 : <ID> (строка). Указывается ID созданного объекта который на сцене

===== PropProcessRemove =====
**Краткое описание:**\\
Удаляет объекты со сцены. Смотрите функцию [[#PropProcessRemove]]\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "PropProcessRemove" )</Code>

===== propCreate =====
**Краткое описание:**\\
Добавляет в список для дальнейшего создания объекта. После добавления необходимо произвести создание моделей с помощью функции [[#propProcessCreate]].
Функция возвращает ID нового объекта.\\
**Пример использования:**\\
Создается одна модель:
  * задается в список
  * производится процесс создания модели на сцене
<Code Lua [start_line_numbers_at=1]>modelpic = cl_exec( "propCreate", 
    0,                -- слой
    foundFile[i],     -- файл mep-модели
    "",               -- скин
    "0.0;0.0;0.0",    -- позиция XYZ
    "-90.0;0.0;90.0", -- поворот XYZ
    0.1               -- масштаб
)
cl_exec( "propProcessCreate" )</Code>
**Обязательные аргументы:**
  * 1 : <layer> (integer -- число). слой у сцены (начинается с 0)
  * 2 : <filename> (строка). Указывается имя файла mep-модели
  * 3 : <filename> (строка). Указывается имя файла скина .mtx
  * 4 : <position> (строка). позиция в формате: X;Y;Z
  * 5 : <rotation> (строка). поворот в формате: X;Y;Z
  * 6 : <scale> (float -- число с плавающей точкой). Масштаб объекта

===== propCreateId =====
**Краткое описание:**\\
Добавляет в список для дальнейшего создания объекта. После добавления необходимо произвести создание моделей с помощью функции [[#propProcessCreate]].
Существует другой аналог функции [[#propCreateId]], [[#propCreate]] которая возвращает случайный ID новой 3д-модели\\
**Пример использования:**\\
Создается одна модель:
  * задается в список
  * производится процесс создания модели на сцене
<Code Lua [start_line_numbers_at=1]>cl_exec( "propCreateId", 
    0,                                    -- слой
    "db07dc8054b761be7db7e22227cc2787",   -- id-объекта
    "bed_05.mep",                         -- файл mep-модели
    "bed_03_blanket.ME2.s0.mtx",          -- скин
    "0.0;0.0;0.0",                        -- позиция XYZ
    "-90.0;0.0;90.0",                     -- поворот XYZ
    0.1                                   -- масштаб
)
cl_exec( "propProcessCreate" )</Code>
**Обязательные аргументы:**
  * 1 : <layer> (integer -- число). слой у сцены (начинается с 0)
  * 2 : <filename> (строка). Указывается имя файла mep-модели
  * 3 : <filename> (строка). Указывается имя файла скина .mtx
  * 4 : <position> (строка). позиция в формате: X;Y;Z
  * 5 : <rotation> (строка). поворот в формате: X;Y;Z
  * 6 : <scale> (float -- число с плавающей точкой). Масштаб объекта

===== propProcessCreate =====
**Краткое описание:**\\
Создает объекты на сцене. Смотрите функцию [[#propCreate]] и [[#propCreateId]]\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "propProcessCreate" )</Code>

===== propTransform =====
**Краткое описание:**\\
Изменяет трансформацию объекта на сцене\\
**Пример использования:**
<Code Lua [start_line_numbers_at=1]>cl_exec( "propTransform", "db07dc8054b761be7db7e22227cc2787", 
    string.format("%.2f;%.2f;%.2f", self.x, (self.y-230), self.z),
    string.format("%.2f;%.2f;%.2f", -90.0, 0.0, ((-self.yaw)+180)), 
    "0.1;0.1;0.1"
)</Code>
**Обязательные аргументы:**
  * 1 : <id> (строка). ID-объекта на сцене
  * 2 : <position> (строка). Позиция в формате: X;Y;Z
  * 3 : <rotation> (строка). Поворот в формате: X;Y;Z
  * 4 : <scale> (строка). Масштаб в формате: X;Y;Z

===== goScreenshot =====
**Краткое описание:**\\
Создает скриншот игрового движка\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "goScreenshot", 0 )</Code>
**Обязательные аргументы:**
  * 1 : <base64> (integer -- число).
  * если 0, то сохранение в файл идёт ../screenshot<порядковый номер скриншота>.png
  * если 1, то сохраняется в base64 кодировке вывести можно код функцией [[#getScreenshotData]]

===== getScreenshotData =====
**Краткое описание:**
Возвращает строку с данными base64 созданного скриншота (ранее создан с помощью [[#goScreenshot]])\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>scrnData = cl_exec( "getScreenshotData" )</Code>

===== camera_origin =====
**Краткое описание:**
Задает местоположение камеры\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "camera_origin", 0.0, 0.0, 0.0 )</Code>
**Обязательные аргументы:**
  * 1 : <x> (float -- число с плавающей точкой).
  * 2 : <y> (float -- число с плавающей точкой).
  * 3 : <z> (float -- число с плавающей точкой).

===== camera_angles =====
**Краткое описание:**
Задает углы камеры\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "camera_angles", 90.0, 60.0 )</Code>
**Обязательные аргументы:**
  * 1 : <yaw> (float -- число с плавающей точкой) поворот 0 -> 360 градусов.
  * 2 : <pitch> (float -- число с плавающей точкой) наклон -90 -> 90 градусов.

===== camera_freeze =====
**Краткое описание:**
Задает заморозку камеры\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "camera_freeze", 1 )</Code>
**Обязательные аргументы:**
  * 1 : <enabled> 1 включено, 0 выключено.

===== camera_zoom =====
**Краткое описание:**
Задает заморозку камеры\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "camera_zoom", 45.0 )</Code>
**Обязательные аргументы:**
  * 1 : <zoom> приближение камеры.

===== camera_speed =====
**Краткое описание:**
Задает заморозку камеры\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "camera_speed", 5.0 )</Code>
**Обязательные аргументы:**
  * 1 : <speed> скорость полета камеры.

===== camera_sensitivity =====
**Краткое описание:**
Задает заморозку камеры\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "camera_sensitivity", 0.1 )</Code>
**Обязательные аргументы:**
  * 1 : <sensitivity> чувствительность камеры.

===== camera_getX =====
**Краткое описание:**
Возвращает позицию X камеры в формате числа с плавающей точкой (float)\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "camera_getX" )</Code>
> если произошла ошибка, возвращается -1.0 значение

===== camera_getY =====
**Краткое описание:**
Возвращает позицию Y камеры в формате числа с плавающей точкой (float)\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "camera_getY" )</Code>
> если произошла ошибка, возвращается -1.0 значение

===== camera_getZ =====
**Краткое описание:**
Возвращает позицию Z камеры в формате числа с плавающей точкой (float)\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "camera_getZ" )</Code>
> если произошла ошибка, возвращается -1.0 значение

===== camera_getYaw =====
**Краткое описание:**
Возвращает Yaw (поворот) камеры в формате числа с плавающей точкой (float)\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "camera_getYaw" )</Code>
> если произошла ошибка, возвращается -1.0 значение

===== camera_getPitch =====
**Краткое описание:**
Возвращает Pitch (наклон) камеры в формате числа с плавающей точкой (float)\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "camera_getPitch" )</Code>
> если произошла ошибка, возвращается -1.0 значение

===== camera_getFreeze =====
**Краткое описание:**
Возвращает состояние заморозки камеры в формате числа (integer)\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "camera_getFreeze" )</Code>
> если произошла ошибка, возвращается -1 значение

===== camera_getZoom =====
**Краткое описание:**
Возвращает значение приближения камеры в формате числа с плавающей точкой (float)\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "camera_getZoom" )</Code>
> если произошла ошибка, возвращается -1.0 значение

===== camera_getSpeed =====
**Краткое описание:**
Возвращает скорость полета камеры в формате числа с плавающей точкой (float)\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "camera_getSpeed" )</Code>
> если произошла ошибка, возвращается -1.0 значение

===== camera_getSensitivity =====
**Краткое описание:**
Возвращает чувствительность камеры в формате числа с плавающей точкой (float)\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "camera_getSensitivity" )</Code>
> если произошла ошибка, возвращается -1.0 значение

===== player_forward =====
**Краткое описание:**
Выполняет перемещение камеры вперед игрока\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "player_forward" )</Code>

===== player_backward =====
**Краткое описание:**
Выполняет перемещение камеры назад игрока\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "player_backward" )</Code>
**Пример использования в скриптах:**
<Code Lua [enable_line_numbers=0]>
    if keyboard:getKey("GLFW_KEY_UP", "GLFW_PRESS") then cl_exec( "player_forward" ) end
    if keyboard:getKey("GLFW_KEY_DOWN", "GLFW_PRESS") then cl_exec( "player_backward" ) end
    if keyboard:getKey("GLFW_KEY_LEFT", "GLFW_PRESS") then cl_exec( "player_left" ) end
    if keyboard:getKey("GLFW_KEY_RIGHT", "GLFW_PRESS") then cl_exec( "player_right" ) end
</Code>

===== player_left =====
**Краткое описание:**
Выполняет перемещение камеры влево игрока\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "player_left" )</Code>

===== player_right =====
**Краткое описание:**
Выполняет перемещение камеры вправо игрока\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "player_right" )</Code>

===== player_jump =====
**Краткое описание:**
Выполняет перемещение камеры прыжок игрока\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "player_jump" )</Code>

===== physics_is =====
**Краткое описание:**
Возвращает работает ли в данный момент сцена PhysX\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>local physics = cl_exec( "physics_is" )</Code>

===== physics_start =====
**Краткое описание:**
Запуск сцены в PhysX\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "physics_start" )</Code>

===== physics_stop =====
**Краткое описание:**
Остановить сцену в PhysX\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "physics_stop" )</Code>

===== physics_debug =====
**Краткое описание:**
Включить/Выключить отладчик в PhysX\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>cl_exec( "physics_debug", 1 )</Code>
**Обязательные аргументы:**
  * 1 : <enabled> параметр 1 или 0 для включения-выключения отладчика.




====== Транспорт ======

===== vehicle_create =====
**Краткое описание:**\\
Создает автомобиль на координатах позиции и вращения, возвращает айди созданного автомобиля\\

**пример настроек в файле [[/me/config/vehicle|тут]]**\\

**Использование:**
<Code Lua [enable_line_numbers=0]>local carId = cl_exec( "vehicle_create", "../Contents/cfg/vehicle_kubel.json", 
    0.0, (2.0+0.5+1.0)*2, 0.0, 0, 0, 0)</Code>
**Обязательные аргументы:**
  * 1 : <filename> файл настроек автомобиля
  * 2 : <positionX> (float -- число с плавающей точкой)
  * 3 : <positionY> 
  * 4 : <positionZ> 
  * 5 : <rotationX> (float -- число с плавающей точкой)
  * 6 : <rotationY>
  * 7 : <rotationZ>

===== vehicle_camera =====
**Краткое описание:**\\
Задает настройки камеры слежения за автомобилем. Рекомендуем применять функцию перед командой vehicle_enter, для предварительной подготовки камеры к работе\\

**пример настроек в файле [[/me/config/vehicle_camera|тут]]**\\

**Использование:**
<Code Lua [enable_line_numbers=0]>cl_exec( "vehicle_camera", "../Contents/cfg/vehicle_kubel_cam.json")</Code>
**Обязательные аргументы:**
  * 1 : <filename> файл настроек камеры

===== vehicle_destroy =====
**Краткое описание:**\\
Удаляет автомобиль по айди\\
**Использование:**
<Code Lua [enable_line_numbers=0]>cl_exec( "vehicle_destroy", 2)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля

===== vehicle_is =====
**Краткое описание:**\\
Проверяет существует ли автомобиль по айди\\
**Использование:**
<Code Lua [enable_line_numbers=0]>cl_exec( "vehicle_is", 2)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля

===== vehicle_originX =====
**Краткое описание:**\\
Получить позицию автомобиля по X\\
**Использование:**
<Code Lua [enable_line_numbers=0]>local x = cl_exec( "vehicle_originX", 2)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля

===== vehicle_originY =====
**Краткое описание:**\\
Получить позицию автомобиля по Y\\
**Использование:**
<Code Lua [enable_line_numbers=0]>local y = cl_exec( "vehicle_originY", 2)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля

===== vehicle_originZ =====
**Краткое описание:**\\
Получить позицию автомобиля по Z\\
**Использование:**
<Code Lua [enable_line_numbers=0]>local z = cl_exec( "vehicle_originZ", 2)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля

===== vehicle_rotationX =====
**Краткое описание:**\\
Получить поворот автомобиля по X\\
**Использование:**
<Code Lua [enable_line_numbers=0]>local rx = cl_exec( "vehicle_rotationX", 2)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля

===== vehicle_rotationY =====
**Краткое описание:**\\
Получить поворот автомобиля по Y\\
**Использование:**
<Code Lua [enable_line_numbers=0]>local ry = cl_exec( "vehicle_rotationY", 2)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля

===== vehicle_rotationZ =====
**Краткое описание:**\\
Получить поворот автомобиля по Z\\
**Использование:**
<Code Lua [enable_line_numbers=0]>local rz = cl_exec( "vehicle_rotationZ", 2)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля

===== vehicle_teleport =====
**Краткое описание:**\\
Телепортировать на конкретную координату автомобиль\\
**Использование:**
<Code Lua [enable_line_numbers=0]>cl_exec( "vehicle_teleport", 2, 150, 10, 10)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля (если значение -1, то игрок выходит из машины)
  * 2 : <x> позиция X для телепортирования
  * 3 : <y> позиция Y для телепортирования
  * 4 : <z> позиция Z для телепортирования

===== vehicle_rotate =====
**Краткое описание:**\\
Вращать автомобиль по X,Y,Z\\
**Использование:**
<Code Lua [enable_line_numbers=0]>cl_exec( "vehicle_rotate", 2, 0, 0, 90)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля (если значение -1, то игрок выходит из машины)
  * 2 : <x> поворот X для телепортирования
  * 3 : <y> поворот Y для телепортирования
  * 4 : <z> поворот Z для телепортирования

===== vehicle_enter =====
**Краткое описание:**\\
Игрок садится в указанный автомобиль\\
**Использование:**
<Code Lua [enable_line_numbers=0]>cl_exec( "vehicle_enter", 2)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля (если значение -1, то игрок выходит из машины)

===== vehicle_driveType =====
**Краткое описание:**\\
Задать динамически привод колес, значения: 0 - задний, 1 - передний, 2 - 4x4\\
**Использование:**
<Code Lua [enable_line_numbers=0]>cl_exec( "vehicle_driveType", 2, 0)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля
  * 2 : <driveType> тип привода 0, 1, 2

===== vehicle_getDriveType =====
**Краткое описание:**\\
Возвращает значение привода: 0 - задний, 1 - передний, 2 - 4x4\\
**Использование:**
<Code Lua [enable_line_numbers=0]>cl_exec( "vehicle_getDriveType ", 2)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля

===== vehicle_wheelOrigin =====
**Краткое описание:**\\
Задать позицию колеса\\
**Использование:**
<Code Lua [enable_line_numbers=1]>
cl_exec( "vehicle_wheelOrigin", 2, 0, -100.0, 0.0, -100.5)
cl_exec( "vehicle_wheelOrigin", 2, 1, 100.0, 0.0, -100.5)
cl_exec( "vehicle_wheelOrigin", 2, 2, -100.0, 0.0, 100.5)
cl_exec( "vehicle_wheelOrigin", 2, 3, 100.0, 0.0, 100.5)
</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля
  * 2 : <idwheel> айди колеса 0-3
  * 3: <x> позиция X
  * 4: <y> позиция Y
  * 5: <z> позиция Z

===== vehicle_chassis =====
**Краткое описание:**\\
Создать или изменить созданное шасси\\
**Использование:**
<Code Lua [enable_line_numbers=1]>
cl_exec( "vehicle_chassis", 2, -100.0, 0.0, -100.5, 50)
</Code>
Если необходимо изменить только высоту от земли до шасси:
<Code Lua [enable_line_numbers=1]>
cl_exec( "vehicle_chassis", 2, -1, -1, -1, 50)
</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля
  * 2: <x> размер X
  * 3: <y> размер Y
  * 4: <z> размер Z
  * 5 : <clearance> высота от земли до шасси

===== vehicle_modelOffset =====
**Краткое описание:**\\
Задать локальную позицию в машине (для создания кузова 3д-моделью)\\
**Использование:**
<Code Lua [enable_line_numbers=1]>
cl_exec( "vehicle_modelOffset", 2, 0.5, 0.2, 0.0)
</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля
  * 2: <x> позиция X
  * 3: <y> позиция Y
  * 4: <z> позиция Z

===== vehicle_ModelX =====
**Краткое описание:**\\
Получить позицию модель-автомобиля по X\\
**Использование:**
<Code Lua [enable_line_numbers=0]>local x = cl_exec( "vehicle_ModelX", 2)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля

===== vehicle_ModelY =====
**Краткое описание:**\\
Получить позицию модель-автомобиля по Y\\
**Использование:**
<Code Lua [enable_line_numbers=0]>local y = cl_exec( "vehicle_ModelY", 2)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля

===== vehicle_ModelZ =====
**Краткое описание:**\\
Получить позицию модель-автомобиля по Z\\
**Использование:**
<Code Lua [enable_line_numbers=0]>local z = cl_exec( "vehicle_ModelZ", 2)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля

===== vehicle_ModelRX =====
**Краткое описание:**\\
Получить поворот модель-автомобиля по X\\
**Использование:**
<Code Lua [enable_line_numbers=0]>local rx = cl_exec( "vehicle_ModelRX", 2)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля

===== vehicle_ModelRY =====
**Краткое описание:**\\
Получить поворот модель-автомобиля по Y\\
**Использование:**
<Code Lua [enable_line_numbers=0]>local ry = cl_exec( "vehicle_ModelRY", 2)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля

===== vehicle_ModelRZ =====
**Краткое описание:**\\
Получить поворот модель-автомобиля по Z\\
**Использование:**
<Code Lua [enable_line_numbers=0]>local rz = cl_exec( "vehicle_ModelRZ", 2)</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля


===== vehicle_getOriginCenterOfMassX =====
**Краткое описание:**\\
Возвращает координату X центра масс автомобиля\\
**Использование:**
<Code Lua [enable_line_numbers=1]>
cl_exec( "vehicle_getOriginCenterOfMassX", 2)
</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля

===== vehicle_getOriginCenterOfMassY =====
**Краткое описание:**\\
Возвращает координату Y центра масс автомобиля\\
**Использование:**
<Code Lua [enable_line_numbers=1]>
cl_exec( "vehicle_getOriginCenterOfMassY", 2)
</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля

===== vehicle_getOriginCenterOfMassZ =====
**Краткое описание:**\\
Возвращает координату Z центра масс автомобиля\\
**Использование:**
<Code Lua [enable_line_numbers=1]>
cl_exec( "vehicle_getOriginCenterOfMassZ", 2)
</Code>
**Обязательные аргументы:**
  * 1 : <id> айди созданного ранее автомобиля




====== Основные функции скриптов ======
===== print =====
**Краткое описание:**
Выводит сообщение одной строкой, либо выводит строки с расстоянием между собой (похоже на табуляцию \t) но одной строкой\\
**Пример использования:**\\
обычный подход
<Code Lua [start_line_numbers_at=1]>print("[Lua] Test complete.")
-- вывод:
-- [Lua] Test complete.</Code>
вывод с помощью пробелов напоминающую табуляцию
<Code Lua [start_line_numbers_at=1]>print("test1", "test2", "test3")
-- вывод:
-- test1   test2   test3</Code>

===== function =====
**Краткое описание:**\\
Стандартная функция в языке программирования Lua. Можно использовать функцию как отдельный поток ([[#thread]])\\
**Пример использования:**\\
обычное объявление функции
<Code Lua [start_line_numbers_at=1]>function fn1( var1 )
    ...
end</Code>
объявление одной строкой
<Code Lua [enable_line_numbers=0]>fn1 = function(x) print(x) end</Code>
**Использование:**
<Code Lua [enable_line_numbers=0]>fn1( 11122 )</Code>

===== for как бесконечный цикл =====
**Краткое описание:**\\
В Lua для **i = 1 math.huge do** создает цикл, который повторяется бесконечно, поскольку **math.huge** представляет собой наибольшее положительное число, которое может представить Lua, фактически действуя как бесконечность.\\
**Пример использования:**
<Code Lua [start_line_numbers_at=1]>for i = 1, math.huge do
  print("Бесконечный цикл работает...")
end</Code>

===== coroutine =====
**Краткое описание:**\\
Механизм, позволяющий выполнять функции асинхронно и приостанавливать их выполнение на определённых этапах. В отличие от потоков, корутины не поддерживают параллелизм, но предоставляют удобный способ управлять асинхронным или частичным выполнением кода.
  * **coroutine.resume** -- запускает или возобновляет выполнение корутины.
  * **coroutine.yield** -- приостанавливает выполнение корутины до следующего вызова **resume**, сохраняя состояние.
**Пример использования:**
<Code Lua [start_line_numbers_at=1]>co1 = coroutine.create(function ()
    tes = 1
    while true do
        print("co1 " .. tes)
        tes = tes + 1
        coroutine.yield() -- Приостанавливаем выполнение корутины
        tes = tes + 1
    end
end)

coroutine.resume(co1) -- запуск/возобновление
coroutine.resume(co1)
coroutine.resume(co1)</Code>
вывод:
  * co1 1
  * co1 3
  * co1 5
**Разбор примера:**
<Code Lua [start_line_numbers_at=1]>-- Создаем корутину
co1 = coroutine.create(function ()
    tes = 1                    -- начальное значение
    while true do              -- бесконечный цикл
        print("co1 " .. tes)   -- вывод: 1, 3, 5...
        tes = tes + 1          -- увеличиваем на 1
        coroutine.yield()      -- стоп, ждём resume
        tes = tes + 1          -- продолжаем, увеличиваем ещё на 1
    end
end)

-- Запускаем/возобновляем корутину 3 раза
coroutine.resume(co1)  
-- Вывод: co1 1

coroutine.resume(co1)  
-- Вывод: co1 3

coroutine.resume(co1)  
-- Вывод: co1 5</Code>
1. Выполнение **coroutine.resume(co1)**
  * Запуск функции: tes = 1
  * вывод **"co1 1"**
  * tes = 2
  * coroutine.yield()
  * остановка функции
2. Выполнение **coroutine.resume(co1)**
  * Продолжение после yield(): tes = 3
  * вывод **"co1 3"**
  * tes = 4
  * yield()
  * остановка функции
3. Выполнение **coroutine.resume(co1)**
  * Продолжение после yield(): tes = 5
  * вывод **"co1 5"**
  * tes = 6
  * yield()
  * остановка функции

===== thread =====
**Краткое описание:**\\
Создаёт отдельные последовательности выполнения кода, которые могут выполняться параллельно. Выполнение нескольких задач одновременно, существенно повышает производительность и реакцию программы. \\
**Пример использования:**\\
отдельный поток
<Code Lua [start_line_numbers_at=1]>function test1()
...
end
-- вызов:
thread( test1 )</Code>
отдельный поток с несколькими аргументами
<Code Lua [start_line_numbers_at=1]>function test1( var1, var2 )
...
end
-- вызов:
thread( function() test1(11, 22) end )</Code>
отдельный поток с использованием бесконечного цикла
<Code Lua [start_line_numbers_at=1]>function test1()
while( true )
    do
      ...
      yield() -- необходимо использовать задержку для избежания нагрузки на CPU
    end
end
-- вызов:
thread( test1 )</Code>
**Примечание**\\
Отдельный поток не может работать со стандартным **require** ([[#require]]), альтернатива позволяет использовать таблицы ([[#readTable]]). Также не умеет работать с глобальными **metatable** (решение: локальные **metatable** можно создавать)\\
**Ошибка: при использовании require в отдельном потоке**
<Code Lua [enable_line_numbers=1]>local ServerType = require( "mp/_servertype" )
-- attempt to call a nil value (method '...')</Code>

===== require =====
**Краткое описание:**\\
Стандартная Lua функция, которая загружает модули (файлы со скриптами). Она делает следующее:
  * Проверяет, не был ли модуль уже загружен ранее (чтобы не загружать его дважды).
  * Если модуль ещё не загружен, ищет файл с именем, соответствующим переданной строке.
  * Выполняет этот файл.
  * Возвращает результат загрузки модуля.
**Пример использования:**\\
Пример создания модуля для **require** с последующим созданием переменной:
<Code Lua [start_line_numbers_at=1]>local TestModule = {
    KEY1 = 1,
    KEY2 = 10,
    KEY3 = 256
}

return TestModule
</Code>
Создание переменной в основном скрипте
<Code Lua [enable_line_numbers=0]>local TestModule = require("mp/testmodule.lua")</Code>
Подключение скрипта
<Code Lua [enable_line_numbers=0]>require("_utility")</Code>





====== Базовые функции (на основе _<скриптов>.lua) ======
===== int_table =====
  * Местоположение файла: **/lua/_utility.lua**
**Краткое описание:**\\
Возвращает значение строки из таблицы в виде числа\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>int_table( <таблица>, <ключ> )</Code>
<Code Lua [start_line_numbers_at=1]>...
local flag = int_table( _packetType, "PLAYER" )
...
</Code>
**Обязательные аргументы:**
  * 1 : <таблица> (таблица)
  * 2 : <ключ> (строка)

===== str_table =====
  * Местоположение файла: **/lua/_utility.lua**
**Краткое описание:**\\
Возвращает значение строки из таблицы\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>str_table( <таблица>, <ключ> )</Code>
<Code Lua [start_line_numbers_at=1]>...
local name = str_table( _tableTest, "PLAYER" )
...
</Code>
**Обязательные аргументы:**
  * 1 : <таблица> (таблица)
  * 2 : <ключ> (строка)

===== debug_str_table =====
  * Местоположение файла: **/lua/_utility.lua**
**Краткое описание:**\\
Выводит сообщение со строкой из таблицы\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>debug_str_table( <таблица>, <ключ> )</Code>
**Обязательные аргументы:**
  * 1 : <таблица> (таблица)
  * 2 : <ключ> (строка)

===== debug_table =====
  * Местоположение файла: **/lua/_utility.lua**
**Краткое описание:**\\
Выводит сообщение со всеми ключами и значениями\\
**Пример использования:**
<Code Lua [start_line_numbers_at=1]>debug_table( <таблица> )
-- вывод
-- Key: Firstname Value: Mark
</Code>
**Обязательные аргументы:**
  * 1 : <таблица> (таблица)

===== add_table =====
  * Местоположение файла: **/lua/_utility.lua**
**Краткое описание:**\\
Добавление нового значения в таблицу\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>add_table( <таблица>, <ключ> )</Code>
<Code Lua [start_line_numbers_at=1]>...
add_table( players, _local )
...</Code>
**Обязательные аргументы:**
  * 1 : <таблица> (таблица)
  * 2 : <ключ> (строка)

===== player_get_pos =====
  * Местоположение файла: **/lua/_utility.lua**
**Краткое описание:**\\
Возвращает строку позиции игрока в специальном формате (используется при передаче в пакет)\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>player_get_pos( <x>, <y>, <z>, <yaw>, <pitch> )</Code>
<Code Lua [start_line_numbers_at=1]>...
-- присваиваем координаты нашего персонажа
playerCurrent = player_get_pos(
        camera:getPosX(), -- x
        camera:getPosY(), -- y
        camera:getPosZ(), -- z
        camera:getYaw(),  -- поворот
        camera:getPitch() -- наклон
)
...</Code>
**Обязательные аргументы:**
  * 1 : <x> (мировая координата X)
  * 2 : <y> (мировая координата Y)
  * 3 : <z> (мировая координата Z)
  * 4 : <yaw> (поворот камеры игрока)
  * 5 : <pitch> (наклон камеры игрока)

===== wait =====
  * Местоположение файла: **/lua/_utility.lua**
**Краткое описание:**\\
Создает временную задержку в миллисекундах\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>wait( <мс> )</Code>
**Обязательные аргументы:**
  * 1 : <длительность> (мс)

===== yield =====
  * Местоположение файла: **/lua/_utility.lua**
**Краткое описание:**\\
Создает в потоке временную задержку (используется для снижения нагрузки на процессор)
**Пример использования:**
<Code Lua [enable_line_numbers=0]>yield()</Code>

===== shuffle =====
  * Местоположение файла: **/lua/_utility.lua**
**Краткое описание:**\\
Случайное перемешивание значений таблицы\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>shuffle( <таблица> )</Code>
**Обязательные аргументы:**
  * 1 : <таблица> (таблица)

===== DIR =====
  * Местоположение файла: **/lua/_utility.lua**
**Краткое описание:**\\
Возвращает путь к нужной директории\\
**Пример использования:**
<Code Lua [enable_line_numbers=0]>DIR( "textures" )</Code>
**Обязательные аргументы:**
  * 1 : <тип ресурса> (строка) - название значений из секции "directories" в файле: preferences.json\\
(к примеру: objects, shaders, sounds, levels, interface, textures, MEBOX, configs)