Типы параметров для Менеджера плагинов

Noxmils
Автор темы
Не в сети
Захожу иногда

Больше

7 года 5 мес. назад - 7 года 4 мес. назад #107600 от Noxmils

Noxmils создал тему: Типы параметров для Менеджера плагинов

Решил попробовать перевести этот материал . Надеюсь, будет полезно. Спасибо Dmy за наводку!

ВНИМАНИЕ: Спойлер!

ВВЕДЕНИЕ В НОВЫЙ МЕНЕДЖЕР ПЛАГИНОВ ДЛЯ RPG MAKER MV 1.5.0+

Недавнее обновление добавило новый Менеджер плагинов. С ним можно создавать мощные плагины, такие как этот:

Параметр группы (@parent)
Вы можете использовать @parent для создания родительского параметра. Просто добавьте название родительского параметра после @parent.

Code:

/*:
 * @param C:\
 *
 * @param Windows
 * @parent C:\
 *
 * @param System32
 * @parent Windows
 *
 * @param notepad.exe
 * @parent System32
 *
 * @param shell32.dll
 * @parent System32
 *
 * @param explorer.exe
 * @parent Windows
 *
 * @param D:\
 *
 * @param Documents
 * @parent D:\
 */

Он не будет изменять синтаксис при считывании значений в игре.

Code:

PluginManager.parameters('TreeDemo')['notepad.exe']

Наименования для локализации (@text)
Название параметра может отличаться от того, которое указано в редакторе. Вы можете использовать @text для корректировки имени, отображаемого в редакторе.

Code:

/*:
 * @param enable
 * @text Enable the Quest System
 * @default true
 *
 * @param mainmenu
 * @text Show in Main Menu
 * @parent enable
 */

Для получения значения в игре используйте имя указанное после @param, а не после @text.

Code:

PluginManager.parameters('TextDemo')['enable']
# => "true"

PluginManager.parameters('TextDemo')['Enable the Quest System']
# => undefined

Типы данных (@type)
Текстовый тип

Code:

@type text

Эта директива создаст в редакторе поле для ввода одно строчной строковой переменной. Такое же, какое было основным для всей предыдущей версии. Этот тип будет использоваться, если Вы опустите директиву @type или укажите в ней несуществующий тип.

Запись

Code:

@type note

Эта директива создаст в редакторе поле для ввода многострочной строковой переменной.

Внимание: результатом использования этой директивы будет строка в формате JSON. Это означает, что для использования значения в игре, Вам потребуется извлечь это значение применив JSON.parse.

Code:

var value = PluginManager.parameters('PluginEditorDemo')['Note']

console.log(value)
# => "Aluxes: Eventually...\nAluxes: I can say something longer than one line!\nAluxes: This is super powerful!\norzFly: Oh well..."

console.log(JSON.parse(value))
# => Aluxes: Eventually...
# => Aluxes: I can say something longer than one line!
# => Aluxes: This is super powerful!
# => orzFly: Oh well...

Числовой тип

Code:

@type number

Эта директива создаст в редакторе поле для ввода числового значения с помощью стрелок.

Code:

@max 100
@min -100

Эти две директивы можно использовать, чтобы задать диапазон для параметра.

Code:

@decimals 2

Эта директива позволит числу быть десятичной дробью с определенным количеством знаков после запятой. Если эту директиву опустить, то число будет только целочисленным.

Файл

Code:

@type file

Эта директива создаст поле для указания пути к графическому или аудио файлу.

Code:

@dir audio/bgm/

Эта директива установит основную папку с файлом. Этот путь не будет включен в результат.

Code:

@require 1

При использовании этой директивы, файл, используемый этим параметром, будет включен в сборку при компиляции, если выбрано "Исключить неиспользованные файлы".

Выборщик объекта

Code:

@type animation
@type actor
@type class
@type skill
@type item
@type weapon
@type armor
@type enemy
@type troop
@type state
@type tileset
@type common_event
@type switch
@type variable

Эта директива создаст в редакторе выпадающий список для выбора соответствующего объекта. В результате будет получен ID выбранного объекта. Если ничего не выбрано, то результатом будет 0.

Code:

@require 1

(Только для @type animation) если использована эта директива, то указанная данным параметром анимация будет включена в сборку, если выбрано "Исключить неиспользованные файлы".

Переключатель

Code:

@type boolean

Эта директива создаст в редакторе переключатель с двумя положениями, возвращающий значение true или false. Исходные наименования положений переключателя ON и OFF.

Code:

@on Enable
@off Disable

Вы можете изменить наименование положений переключателя с помощью директив @on и @off.

Выбор

Code:

@type select
@option XP
@option VX
@option VX Ace
@option MV

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

Code:

@type select
@option XP
@value 1.0
@option VX
@value 2.0
@option VX Ace
@value 2.1
@option MV
@value 3.0

Вы можете изменить передаваемое значение применив директиву @value для каждого @option.

Комбинированный тип

Code:

@type combo
@option XP
@option VX
@option VX Ace
@option MV

Эта директива создаст в редакторе строку для ввода текста с выпадающим списком. Пользователь сможет как выбрать один из имеющихся вариантов, так и ввести свой собственный.
здесь директива @value не поддерживается.

Список
После добавления [] к любому из существующих типов, в редакторе появится список величин, которые будут вводится аналогично типу, котором добавили []. Все указанные ниже директивы работают:

Code:

@type text[]
@type note[]
@type number[]
@type variable[]
@type item[]
@type combo[]
@type file[]
@type struct<Anything>[]

Code:

var value = PluginManager.parameters('PluginEditorDemo')['Text List']

console.log(value)
# => ["orzFly","orzDive","orzSwim"]

console.log(value[2])
# => o

var realValue = JSON.parse(value)
console.log(realValue[2])
# => orzSwim

Структура
Вы можете определить структуру, запустив новый блок комментариев в файле. Вы можете поместить его после основного блока. Первая строка определяет имя этой структуры (в примере, «ItemAward»). Эти параметры можно определить внутри этого блока аналогично обычным параметрам.

Code:

/*~struct~ItemAward:
 * @param Item
 * @type item
 * 
 * @param Count
 * @type number
 * @min 1
 * @max 99
 * @default 1
 */

Вы сможете воспользоваться этой структурой используя специальный тип:

Code:

@type struct<ItemAward>

Code:

var value = PluginManager.parameters('PluginEditorDemo')['Structure']

console.log(value)
# => {"Text":"orzFly","Note":"\"The quick brown fox jumps over the lazy dog.\\nThe lazy dog jumps over the quick brown fox.\\nThe quick brown fox jumps over the quick brown fox.\\nThe lazy dog jumps over the lazy dog.\"","Number":"233","Item":"1","Animation":"1","File (img/)":"system/GameOver"}

console.log(value["Text"])
# => undefined

var realValue = JSON.parse(value)
console.log(realValue["Text"])
# => orzFly

--

Пример плагина доступен в приложении, а также размещен на GitHub . Этот плагин предназначен для демонстрации нового Менеджера Плагинов для RPG Maker MV 1.5.0 и не имеет никаких реальных функций.

Дополню материал переводом маленького раздела из справки по мейкеру .

ВНИМАНИЕ: Спойлер!

Последнее редактирование: 7 года 4 мес. назад пользователем Noxmils. Причина: Исправил "дерективы" на "директивы"

Спасибо сказали: Dmy, AnnTenna, Lekste, DK, yuryol, Cabbit, KageDesu, vilka, NeKotZima

Пожалуйста Войти или Регистрация, чтобы присоединиться к беседе.

NeKotZima
Не в сети
Осваиваюсь на форуме

Больше

7 года 4 мес. назад #108184 от NeKotZima

NeKotZima ответил в теме Типы параметров для Менеджера плагинов

Спасибо, очень полезно! Написано немного корявенько, то "директива", то "деректива", но это уже придирки

Не знал, что так можно, в некоторых плагинах приходится писать вручную true и false.

Спасибо сказали: yuryol, Noxmils

Пожалуйста Войти или Регистрация, чтобы присоединиться к беседе.

yuryol
Не в сети
Живу я здесь

Больше

7 года 4 нед. назад #110483 от yuryol

yuryol ответил в теме Типы параметров для Менеджера плагинов

1) можно ли как-то добавлять условия для параметров?

к примеру если в примере ниже выбрал у параметра Type значение Variable

* @param Type
* @type select
* @option Variable
* @option Switch

то у следующего параметра Value тип становится variable

* @param Value
* @type variable

Хотелось бы подобие:

* @param Value
* @type (Type == 'Variable') ? variable : switch

2) есть ли возможность сделать параметр неактивным в зависимости от другого параметра?
Например, если какой-нибудь булевый параметр в положении "тру", то появляются другие параметры. Если "фолс", то этих параметров нет

Спасибо сказали: Noxmils

Пожалуйста Войти или Регистрация, чтобы присоединиться к беседе.

Noxmils
Автор темы
Не в сети
Захожу иногда

Больше

7 года 4 нед. назад #110534 от Noxmils

Noxmils ответил в теме Типы параметров для Менеджера плагинов

В той документации, что я пользовался, о таких возможностях не говорится. Я так подозреваю, что тип параметра передается в редактор в виде строки, аналогично данным из Команды плагина, поэтому всунуть какие-либо функции туда не получится. При попытке такое провернуть параметр становится текстовым.

Спасибо сказали: yuryol

Пожалуйста Войти или Регистрация, чтобы присоединиться к беседе.

Lekste
Не в сети
Завсегдатай

Больше

7 года 4 нед. назад #110535 от Lekste

Lekste ответил в теме Типы параметров для Менеджера плагинов

Ага. Комментарий с описанием параметров, скорей всего парсится редактором только 1 раз - при открытии списка плагинов или при открытии настроек плагина.

Тут, тогда, надо менять сам мейкер.
Или делать свое отдельное приложение-редактор плагинов

Спасибо сказали: yuryol, Noxmils

Пожалуйста Войти или Регистрация, чтобы присоединиться к беседе.

DK
Не в сети
Завсегдатай
DKPlugins

Больше

7 года 4 нед. назад #110548 от DK

DK ответил в теме Типы параметров для Менеджера плагинов

yuryol пишет: 1) можно ли как-то добавлять условия для параметров?

к примеру если в примере ниже выбрал у параметра Type значение Variable

* @param Type
* @type select
* @option Variable
* @option Switch

то у следующего параметра Value тип становится variable

* @param Value
* @type variable

Хотелось бы подобие:

* @param Value
* @type (Type == 'Variable') ? variable : switch

2) есть ли возможность сделать параметр неактивным в зависимости от другого параметра?
Например, если какой-нибудь булевый параметр в положении "тру", то появляются другие параметры. Если "фолс", то этих параметров нет

К сожалению, нет.

Спасибо сказали: Dmy, yuryol, Noxmils

Пожалуйста Войти или Регистрация, чтобы присоединиться к беседе.

Время создания страницы: 0.103 секунд

Работает на Kunena форум

Типы параметров для Менеджера плагинов

Панель Участника