Вопросы по Lua скриптингу

Общая тема для вопросов по разработке скриптов на языке программирования Lua, в частности под MoonLoader.

• Задавая вопрос, убедитесь, что его нет в списке частых вопросов и что на него ещё не отвечали (воспользуйтесь поиском).
• Поищите ответ в теме посвященной разработке Lua скриптов в MoonLoader
• Отвечая, убедитесь, что ваш ответ корректен.
• Старайтесь как можно точнее выразить мысль, а если проблема связана с кодом, то обязательно прикрепите его к сообщению, используя блок [code=lua]здесь мог бы быть ваш код[/code].
• Если вопрос связан с MoonLoader-ом первым делом желательно поискать решение на wiki.

Частые вопросы

— Как научиться писать скрипты? С чего начать?
Информация - Гайд - Всё о Lua скриптинге для MoonLoader^{(https://blast.hk/threads/22707/)}
— Как вывести текст на русском? Вместо русского текста у меня какие-то каракули.

Спойлер

Изменить кодировку файла скрипта на Windows-1251. В Atom: комбинация клавиш Ctrl+Shift+U, в Notepad++: меню Кодировки -> Кодировки -> Кириллица -> Windows-1251.

— Как получить транспорт, в котором сидит игрок?

Спойлер

local veh = storeCarCharIsInNoSave(PLAYER_PED)

— Как получить свой id или id другого игрока?

Спойлер

local _, id = sampGetPlayerIdByCharHandle(PLAYER_PED) -- получить свой ид
local _, id = sampGetPlayerIdByCharHandle(ped) -- получить ид другого игрока. ped - это хендл персонажа

— Как проверить, что строка содержит какой-то текст?

Спойлер

if string.find(str, 'текст', 1, true) then
-- строка str содержит "текст"
end

— Как эмулировать нажатие игровой клавиши?

Спойлер

local game_keys = require 'game.keys' -- где-нибудь в начале скрипта вне функции main

setGameKeyState(game_keys.player.FIREWEAPON, -1) -- будет сэмулировано нажатие клавиши атаки

Все иды клавиш находятся в файле moonloader/lib/game/keys.lua.
Подробнее о функции setGameKeyState здесь: lua - setgamekeystate | BlastHack — DEV_WIKI^{(https://www.blast.hk/wiki/lua:setgamekeystate)}

— Как получить id другого игрока, в которого целюсь я?

Спойлер

local valid, ped = getCharPlayerIsTargeting(PLAYER_HANDLE) -- получить хендл персонажа, в которого целится игрок
if valid and doesCharExist(ped) then -- если цель есть и персонаж существует
  local result, id = sampGetPlayerIdByCharHandle(ped) -- получить samp-ид игрока по хендлу персонажа
  if result then -- проверить, прошло ли получение ида успешно
    -- здесь любые действия с полученным идом игрока
  end
end

— Как зарегистрировать команду чата SAMP?

Спойлер

-- До бесконечного цикла/задержки
sampRegisterChatCommand("mycommand", function (param)
     -- param будет содержать весь текст введенный после команды, чтобы разделить его на аргументы используйте string.match()
    sampAddChatMessage("MyCMD", -1)
end)

— Крашит игру при вызове sampSendChat. Как это исправить?

Спойлер

Это происходит из-за бага в SAMPFUNCS, когда производится попытка отправки пакета определенными функциями изнутри события исходящих RPC и пакетов. Исправления для этого бага нет, но есть способ не провоцировать его. Вызов sampSendChat изнутри обработчика исходящих RPC/пакетов нужно обернуть в скриптовый поток с нулевой задержкой:

function onSendRpc(id)
  -- крашит:
  -- sampSendChat('Send RPC: ' .. id)

  -- норм:
  lua_thread.create(function()
    wait(0)
    sampSendChat('Send RPC: ' .. id)
  end)
end

 

[natr1um]

Я хотел спросить кое-что о MoonLoader и SA:MP.
Это связано с событием onChatMessage в lib.samp.events.

Сообщения не обрабатываются, пока игра находится на паузе. Есть ли какой-нибудь обходной способ, или я делаю что-то неправильно?

Мне хотелось бы получать сообщения в реальном времени, даже когда игра на паузе. Буду благодарен за любую помощь, спасибо.

^ if the translated version, which I tried didn't hold up translate this as the final version in case of confusions:

Hello, I wanted to ask something about moonloader and samp, it deals with the onChatMessage event in lib.samp.events the messages aren't processed until the game in unpaused, is there a work around or am I doing something wrong? I would like to access the messages in realtime even while the game is paused, any help is appreaciated thanks

script_name('TX-Comms-Discord')
script_author('Natr1um')
require "lib.moonloader"
local sampev = require "lib.samp.events"

if script_properties then
    script_properties('work-in-pause', 'forced-reloading-only')
end

function sampev.onChatMessage(playerId, text)
    name = sampGetPlayerNickname(playerId)
    local fpath = os.getenv('TEMP') .. '\\stub.json'
    downloadUrlToFile("http://localhost:8000/sendMsg?id=" .. name .. "&msg=" .. text, fpath, function(id, status, p1, p2) end)
end

Для контекста: localhost на этом порту существует и работает. Я не смог найти другого способа использовать socket.http или любую другую HTTP-библиотеку для Lua. Эта часть работает нормально, когда игра не на паузе, так что об этом можно не беспокоиться.

for context, the localhost on that port does exist, and functions, I couldn't find any other way to use socket.http or any other http lib for lua, that part works fine when the game is unpaused so no need to worry about it

 

[Sanurial]

Я хотел спросить кое-что о MoonLoader и SA:MP.
Это связано с событием onChatMessage в lib.samp.events.

Сообщения не обрабатываются, пока игра находится на паузе. Есть ли какой-нибудь обходной способ, или я делаю что-то неправильно?

Мне хотелось бы получать сообщения в реальном времени, даже когда игра на паузе. Буду благодарен за любую помощь, спасибо.

^ if the translated version, which I tried didn't hold up translate this as the final version in case of confusions:

Hello, I wanted to ask something about moonloader and samp, it deals with the onChatMessage event in lib.samp.events the messages aren't processed until the game in unpaused, is there a work around or am I doing something wrong? I would like to access the messages in realtime even while the game is paused, any help is appreaciated thanks

script_name('TX-Comms-Discord')
script_author('Natr1um')
require "lib.moonloader"
local sampev = require "lib.samp.events"

if script_properties then
    script_properties('work-in-pause', 'forced-reloading-only')
end

function sampev.onChatMessage(playerId, text)
    name = sampGetPlayerNickname(playerId)
    local fpath = os.getenv('TEMP') .. '\\stub.json'
    downloadUrlToFile("http://localhost:8000/sendMsg?id=" .. name .. "&msg=" .. text, fpath, function(id, status, p1, p2) end)
end

Для контекста: localhost на этом порту существует и работает. Я не смог найти другого способа использовать socket.http или любую другую HTTP-библиотеку для Lua. Эта часть работает нормально, когда игра не на паузе, так что об этом можно не беспокоиться.

for context, the localhost on that port does exist, and functions, I couldn't find any other way to use socket.http or any other http lib for lua, that part works fine when the game is unpaused so no need to worry about it

Проблема тут в том, как вообще устроена работа с памятью и событиями в SA:MP. Событие onChatMessage в samp.events срабатывает, когда игра обрабатывает входящие RPC-пакеты. Когда ты ставишь игру на паузу (выходишь в меню ESC), основной цикл игры замирает, и обработка сетевых пакетов через стандартные хуки MoonLoader тоже приостанавливается.

Даже если у скрипта стоит свойство work-in-pause, это лишь позволяет самому скрипту (его циклу main) крутиться в фоне, но не заставляет samp.events магически ловить пакеты, которые игра в данный момент игнорирует из-за паузы.

1. Антипауза: Самый простой вариант использовать скрипт или настройки, которые отключают реальную паузу при выходе в меню. Тогда игра продолжит получать пакеты, и твой хук будет работать.
2. Прямое чтение из памяти (BitStream): Это более хардкорный метод. Нужно хукать входящие RPC на более низком уровне, до того как игра решит их «отложить» из-за паузы. Но для обычного скрипта на пересылку сообщений это может быть избыточно.

по поводу HTTP: downloadUrlToFile, то это асинхронная функция, и она в целом норм для простых запросов, но если захочешь чего-то более серьезного без фризов, посмотри в сторону библиотеки copas или effil, хотя для локалхоста и твой вариант сойдет.

script_name('TX-Comms-Discord')
script_author('Natr1um')

require "lib.moonloader"
local sampev = require "lib.samp.events"
local encoding = require 'encoding'
encoding.default = 'CP1251'
u8 = encoding.UTF8

-- Это свойство позволяет скрипту работать в ESC,
-- но для работы сетевых событий нужна включенная антипауза в самой игре/клиенте
script_properties('work-in-pause')

function sampev.onChatMessage(playerId, text)
    -- Используем pcall, чтобы скрипт не лег, если ник не достался
    local result, name = pcall(sampGetPlayerNickname, playerId)
    if not result then name = "Unknown" end
   
    -- Кодируем в UTF-8 для корректной передачи в веб, если нужно
    local message = u8(text)
    local nickname = u8(name)
   
    -- Формируем запрос
    local fpath = os.getenv('TEMP') .. '\\stub.json'
    local url = string.format("http://localhost:8000/sendMsg?id=%s&msg=%s",
        encodeUrl(nickname), encodeUrl(message))
   
    downloadUrlToFile(url, fpath, function(id, status, p1, p2)
        -- Можно добавить лог в консоль для отладки
    end)
end

function encodeUrl(str)
    if str then
        str = str:gsub("\n", "\r\n")
        str = str:gsub("([^%w %-%_%.%~])", function(c)
            return string.format("%%%02X", string.byte(c))
        end)
        str = str:gsub(" ", "+")
    end
    return str
end

function main()
    while true do
        wait(0)
        -- Тут скрипт будет жить даже в паузе
    end
end