SAMP.Lua

Изначально эта библиотека задумывалась как простой апи исключительно для обработки сетевых пакетов, но в процессе было решешо, что лучше бы сделать её полноценной библиотекой для работы с сампом, в будущем это позволит избавить от необходимости использования SAMPFUNCS. Пока реализован только модуль, значительно упрощающий работу с пакетами, так что говорить сейчас будем о нём.

SAMP.Events
Этот модуль добавляет событийную обработку входящих и исходящих RakNet пакетов. Имеет удобный API, полностью кастомизируем, предоставляет те же возможности, что и обычные хуки: чтение, перезапись, игнорирование.


Использование
Простой пример обработки исходящего сообщения в чат:

local sampev = require 'lib.samp.events'

function sampev.onSendChat(msg)
  print('You said: ' .. msg)
end

Да, настолько просто. Нужно лишь загрузить библиотеку и добавить функцию с соответствующими аргументами, вот и всё.
Перезапись данных в пакете настолько же проста, нужно лишь вернуть из функции все значения в том же порядке, занеся их в таблицу.

function sampev.onSendChat(msg)
  return {'I said: ' .. msg}
end

Будет дописывать текст "I said:" в начало каждого отправляемого сообщения.
Если вернуть из функции false, то пакет будет проигнорирован клиентом. Этот код запретит серверу изменять позицию игрока:

function sampev.onSetPlayerPos(position)
  print(string.format('Server tried to change your position to %0.2f %0.2f %0.2f', position.x, position.y, position.z))
  return false
end

Структуры всех пакетов находятся в файле events.lua.

Перезапись исходящих пакетов синхронизации слегка отличается от всех остальных - они не требуют возврата аргументов, а вместо этого данные перезаписываются как в обычной таблице lua. Это сделано для повышения производительности.
Пример перезаписи позиции в исходящих данных синхронизации игрока:

function sampev.onSendPlayerSync(data)
  print('Original position:', data.position.x, data.position.y, data.position.z)
  data.position.x = 1337
  data.position.y = 1488
  data.position.z = 228
end

Это применимо только в событиях onSendPlayerSync, onSendVehicleSync, onSendPassengerSync, onSendAimSync, onSendUnoccupiedSync, onSendTrailerSync, onSendBulletSync, onSendSpectatorSync.
Структуры всех пакетов синхронизации находятся в файле synchronization.lua.


Примеры скриптов
AntiCarJack - перехват и игнорирование входящего RPC и пакета синхронизации
Bubble Sniffer - перехват и обработка входящего RPC
DerpCam - перезапись данных исходящего пакета синхронизации
Chat Bliss - перезапись, игнорирование и обработка исходящего RPC

Спойлер: Для опытных разработчиков

Кастомизация
API структурирован так, что позволяет вносить в него любые изменения, не прибегая к изменению исходных файлов модулей.
Добавление своего обработчика для серверного пакета проигрывания звука:

local sampev = 'lib.samp.events'
local raknet = 'lib.samp.raknet'
sampev.INTERFACE.INCOMING_RPCS[raknet.RPC.PLAYSOUND] = {'onPlaySound', {soundId = 'int32'}, {x = 'float'}, {y = 'float'}, {z = 'float'}}

И теперь в тот же файл можно добавить функцию для обработки события:

function sampev.onPlaySound(sound, x, y, z)
-- добавляем сообщение в лог
print(string.format('Sound %d at coords %0.2f, %0.2f, %0.2f', sound, x, y, z))
-- и отключаем звук, запрещая дальнейшую обработку пакета
return false
end

Следует сразу разобрать код регистрации события, чтобы стало понятнее.

sampev.INTERFACE. -- поле INTERFACE - это все экспортируемые элементы модуля
INCOMING_RPCS -- обращение к списку входящих RPC
[raknet.RPC.PLAYSOUND] -- обращение к элементу таблицы INCOMING_RPCS по индексу, в данном случае INCOMING_RPCS - это таблица, содержащая список структур всех входящих RPC, а raknet.RPC.PLAYSOUND - идентификатор требуемого RPC
= -- присваиваем ему новое значение - таблицу с информацией о событии и структурой пакета
{'onPlaySound', -- название события, функция события будет использовать это имя
-- структура пакета. каждый параметр должен быть заключен в отдельную таблицу, иметь название и тип в формате {названиеПараметра = 'тип'}
{soundId = 'int32'}, {coords = 'vector3d'}}

Очевидно, что INCOMING_RPCS - это не единственная таблица, их четыре:
INCOMING_RPCS - входящие RPC
OUTCOMING_RPCS - исходящие RPC
INCOMING_PACKETS - входящие пакеты
OUTCOMING_PACKETS - исходящие пакеты

Новый тип тоже можно добавить без изменения исходников библиотеки:

events.INTERFACE.BitStreamIO.fvector3 = { -- название типа после последней точки
   read = function(bs) -- функция чтения. первый аргумент - битстрим
     local vec = {}
     vec.x = raknetBitStreamReadFloat(bs)
     vec.y = raknetBitStreamReadFloat(bs)
     vec.z = raknetBitStreamReadFloat(bs)
     return vec
   end,
   write = function(bs, value) -- функция записи
     raknetBitStreamWriteFloat(bs, value.x)
     raknetBitStreamWriteFloat(bs, value.y)
     raknetBitStreamWriteFloat(bs, value.z)
   end
}

В случае, если пакет имеет какую-то сложную структуру, не описываемую даже с помощью пользовательских типов, то вместо структуры можно передать функцию, которая будет обрабатывать данные. Например как это сделано для RPC InitGame:

INCOMING_RPCS[RPC.INITGAME] = {'onInitGame', onInitGameReader, onInitGameWriter} -- второй и третий аргумент - это функции чтения и записи

Для большего количества примеров смотрите исходный код.

Что касается всей библиотеки в целом, то она ещё находится на зачаточной стадии и обсуждать кроме планов нечего. По сути она должна заменить собой основную часть SAMPFUNCS - моддинг сампа.

Скачать последнюю версию и следить за изменениями всегда можно на GitHub.
Установка: скачать samp.zip из последнего релиза и целиком скопировать папку 'samp' (не содержимое папки!) из архива в каталог 'moonloader/lib/'.

Любая помощь в разработке приветствуется, особенно с добавлением новых структур. Предложите Pull request на гитхабе или напишите в этой теме.

Ну и конечно же крохотное нано-спасибо hnnssy за помощь.

 

[Synthetic_Boundless]

README Тоже кидать в мунлоудер?

 

[RoffDaniel]

README Тоже кидать в мунлоудер?

Нет

 

[astynk]

В исходящей инкар синхре quaternion идет от 0 до 3, во входящей - от 1 до 4

 

[Evgeniy_Pavuk]

Почему айди текстрдравов -1? Что не так?

local ev = require('samp.events')


function main()
    repeat wait(0) until isSampAvailable()
        sampRegisterChatCommand("td", function(td)
        acti = not acti
    end)
wait(-1)
end

function ev.onShowTextDraw(textdrawId, data)
    if acti then
        print(data.letterColor..' '..textdrawId, -1)
    end
end

 

[Roma Yakushov]

Почему айди текстрдравов -1? Что не так?Посмотреть вложение 39347

local ev = require('samp.events')


function main()
    repeat wait(0) until isSampAvailable()
        sampRegisterChatCommand("td", function(td)
        acti = not acti
    end)
wait(-1)
end

function ev.onShowTextDraw(textdrawId, data)
    if acti then
        print(data.letterColor..' '..textdrawId, -1)
    end
end

Ид текстдрава это второе, в print цвет не нужно ставить

 

[Evgeniy_Pavuk]

Ид текстдрава это второе, в print цвет не нужно ставить

Эм, мне нужно узнать цвет текстдрава и его айди.

 

[paulohardy]

Эм, мне нужно узнать текст текстдрава и его айди.

print(data.text..' '..textdrawId)

 

[Evgeniy_Pavuk]

print(data.text..' '..textdrawId)

Описался Цвет
Но прикол в том что айди постоянно -1

 

[paulohardy]

Описался Цвет
Но прикол в том что айди постоянно -1

print(data.letterColor..' '..textdrawId)

 

[Evgeniy_Pavuk]

print(data.letterColor..' '..textdrawId)

Ну у меня так и выводится но постоянно id -1

 

[paulohardy]

Ну у меня так и выводится но постоянно id -1

у тебя не айди -1, ты в print после запятой пишешь -1 и думаешь что это айди, в print НЕ нужен цвет, если ты скопируешь в блокнот строку из твоего же сообщения и увеличишь размер символов то там виден пробел между цветом и настоящим айди

 

[DolgorukovGTA]

Ну у меня так и выводится но постоянно id -1

Вызывая метод print(), цвет отдельным параметром писать не нужно, в отличие от:

sampAddChatMessage(text, color) -- здесь во 2-ом параметре можно писать "-1" (цвет в uint формате, белый цвет)

 

[Forex13377]

Что делать,все установил,но каждый скрипт пишет SAMP.Lua is not connected

 

[Fluffy Paws]

[16:39:37.113504] (error) events.lua: Z:\Games\GTA San Andreas\moonloader\events.lua:162: table index is nil
stack traceback:
Z:\Games\GTA San Andreas\moonloader\events.lua:162: in main chunk
[16:39:37.113504] (error) events.lua: Script died due to an error. (0FCA0CA4)

 

[NOOBPAndA]

Это как УДФ в АХК?