Импорт функций

Импорт синтетических модулей

Чтобы импортировать функции из другого плагина, используйте систему require от Plugify для загрузки синтетического модуля для целевого плагина.

local Plugify = require('plugify')
local Vector2, Vector3, Vector4, Matrix4x4 = Plugify.Vector2, Plugify.Vector3, Plugify.Vector4, Plugify.Matrix4x4
local master = require('plugin_from_another_language')

• plugify: Основной модуль Plugify, предоставляющий служебные классы, такие как Vector2, Vector3 и т.д.
• plugin_from_another_language: Синтетический модуль для целевого плагина. Замените это на имя плагина, из которого вы хотите импортировать функции.

Вызов импортированных функций

После импорта синтетического модуля вы можете вызывать его функции напрямую.

Пример 1: Вызов простой функции

local function func()
    master.ParamCallback(
        111, 
        2.2, 
        5.1234, 
        Vector4:new(-125.1, -225.2, -325.3, -425.4), 
        {60000000, -700000000, 80000000000}, 
        'D', 
        'pink metal', 
        'Y', 
        -100
    )
end

return {
    func = func
}

• ParamCallback: Это пример функции, экспортируемой целевым плагином. Замените его на фактическое имя функции.
• Параметры: Передайте необходимые параметры, как определено в сигнатуре функции.

Пример 2: Вызов функции с параметром-обратным вызовом

Если импортируемая функция требует обратный вызов в качестве параметра, вы можете определить обратный вызов в Lua и передать его функции. Вот пример:

local CallbackHolder = {
    mockFunc = function(u32, v3, u_vec)
        -- Изменить параметры (переданные по ссылке)
        u32 = 42
        v3 = Vector3:new(1.0, 2.0, 3.0)
        u_vec = {1, 2, 3}
        -- Вернуть измененные значения
        return nil, u32, v3, u_vec
    end
}

local function func_call()
    local result = master.CallFuncCallback(CallbackHolder.mockFunc)
    return result
end

return {
    func_call = func_call
}

• CallFuncCallback: Это пример функции, которая принимает обратный вызов в качестве параметра.
• mockFunc: Это функция обратного вызова, определенная в JavaScript. Она изменяет параметры, переданные по ссылке, и возвращает их в массиве.
• Возвращаемые значения: Функция обратного вызова возвращает null (для типа возвращаемого значения void) и измененные параметры.

Использование онлайн-генератора:

Посетите [https://gen.plugify.net/](инструмент plugify-gen) для генерации файлов типов через удобный веб-интерфейс. Просто загрузите файл манифеста плагина (.pplugin) и выберите Lua в качестве целевого языка, чтобы сгенерировать соответствующий файл аннотаций .lua.

Использование инструмента командной строки:

Вы также можете скачать и использовать инструмент-генератор локально из репозитория plugify-gen.

Пример использования:

plugify-gen -manifest ./plugins/MyPlugin/MyPlugin.pplugin -output ./types/ -lang lua

Сгенерированный файл типов:

• Скрипт сгенерирует файл lua (например, MyPlugin.lua) в указанной выходной папке.
• Пример содержимого файла типов:
  MyPlugin.lua

  ---@param a integer
  ---@param b number
  ---@param c number
  ---@param d Vector4
  ---@param e integer[]
  ---@param f string
  ---@param g string
  ---@param h string
  ---@param k integer
  function ParamCallback(a, b, c, d, e, f, g, h, k) end
  
  ---@alias Func fun(u32: integer, vec3: Vector3, vecU32: integer[]): nil, integer, Vector3, integer[]
  
  ---@param callback Func
  ---@return string
  function CallFuncCallback(callback) end
  

Использование файлов типов в вашей IDE:

• Поместите сгенерированный файл типов (.lua) в каталог вашего проекта (но не в папку с плагинами).
• IDE, такие как VSCode, будут использовать файл типов для предоставления подсказок по типам и автодополнения.

Поддержка VSCode:

• VSCode автоматически обнаруживает файлы типов в вашем проекте. Убедитесь, что папка types (или папка, содержащая ваши .lua файлы) включена в ваш файл luaconfig.json.
• Пример конфигурации luaconfig.json:
  {
      "compilerOptions": {
          "typeRoots": ["./types"]
      }
  }