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 за помощь.

 

[qrlk]

addon есть?

Да, в нём есть нечто, что позволяет запоминать позицию в диалоге. Видимо, оно и мешает жить.
Сейчас попробую отыскать чистую версию.
Обидно, что придётся писать одну вещь отдельно под юзером с аддоном и без него.

 

[Wolfssohn]

Не работает.

function sampev.onChatMessage(id, text)
    print(text)
end

Я тут хочу, когда чат что то добавляется, чтобы вызвалась эта функция, но она не вызывается.


это работает

function sampev.onSendChat(msg)
    print(msg)
end

Эта вызывается.

Шо делать?

 

[Aniki]

Не работает.

function sampev.onChatMessage(id, text)
    print(text)
end

Я тут хочу, когда чат что то добавляется, чтобы вызвалась эта функция, но она не вызывается.


это работает

function sampev.onSendChat(msg)
    print(msg)
end

Эта вызывается.

Шо делать?

Не onChatMessage, а onServerMessage

 

[Wolfssohn]

function sampev.onShowDialog(dialogId)
      sampAddChatMessage("КУУУУУУУУУУУУУУУ", -1)
end

Чет не вызывается эта функция. пробовал и со всеми аргументами что в Events увидел - результата нет. Не вызывается эта функция при открытии диалога Даймонд РП
Где я натупил?

Аддона нет.
ГТА чистая. Куча клео скриптов на читы. И пару луа простых. Ничё так вроде не должно мешать.
Убрал все скрипты из клео папки и сампфункс. Нет результата.

 

[CatKnight]

С новым сампфунксом не возвращаются значения в событиях. С чем связано?

 

[Salvatore_Ferrari]

С новым сампфунксом не возвращаются значения в событиях. С чем связано?

Покажи как возвращаешь

 

[CatKnight]

Покажи как возвращаешь

Возьмём для определенности onServerMessage
return {color, text}

 

[AnWu]

Возьмём для определенности onServerMessage
return {color, text}

полный код

 

[CatKnight]

полный код

local sampev = require 'lib.samp.events'
function main()
  if not isSampLoaded() or not isSampfuncsLoaded() then return end
  while not isSampAvailable() do wait(100) end

  while true do
        wait(-1)
  end
end

--- Events
function sampev.onServerMessage(color, text)
  return {-1, "Текст"}
end

 

[AnWu]

local sampev = require 'lib.samp.events'
function main()
  if not isSampLoaded() or not isSampfuncsLoaded() then return end
  while not isSampAvailable() do wait(100) end

  while true do
        wait(-1)
  end
end

--- Events
function sampev.onServerMessage(color, text)
  return {-1, "Текст"}
end

И правда перезапись не работает. Но ловит. @FYP

 

[FYP]

С новым сампфунксом не возвращаются значения в событиях. С чем связано?

¯\_(ツ)_/¯
исправлено

 

[Akionka]

Каким образом перезаписать данные

function sampev.onShowTextDraw(id, textdraw)
    print(id, textdraw.color, textdraw.boxColor, textdraw.text)
    if id == 1097 then
        textdraw.color = 307851526
        return {id, textdraw}
    end
end

Вот так не работает:((

 

[romacaddy]

Каким образом перезаписать данные

function sampev.onShowTextDraw(id, textdraw)
    print(id, textdraw.color, textdraw.boxColor, textdraw.text)
    if id == 1097 then
        textdraw.color = 307851526
        return {id, textdraw}
    end
end

Вот так не работает:((

попробуй менять backgroundColor. на моем опыте, изменение color зачастую ни к чему не приводит

 

[Akionka]

попробуй менять backgroundColor. на моем опыте, изменение color зачастую ни к чему не приводит

А вообще правильный код? Я просто не работал с перезаписью этого RPC

 

[™ ChipFamily]

Samp.Lua стоит

[ML] (error) Sync.lua: D:\GTA San Andreas\moonloader\Sync.lua:87: undeclared or implicit tag 'VehicleSyncData'
stack traceback:
    [C]: in function 'new'
    D:\GTA San Andreas\moonloader\Sync.lua:87: in function 'samp_create_sync_data'
    D:\GTA San Andreas\moonloader\Sync.lua:55: in function 'send_pos_to_coord'
    D:\GTA San Andreas\moonloader\Sync.lua:25: in function <D:\GTA San Andreas\moonloader\Sync.lua:18>
[ML] (error) Sync.lua: Script died due to an error. (099D389C)