Configure
Configure is a utility library that allows plugins to easily make a GUI for the configs.
Описание
Конфигурация анализирует данный кодек для конфигурирования и генерирует пользовательский интерфейс для этого кодека. Чтобы использовать его, просто заверните конфигурацию в этот плагин Завернутый конфигуратор класс и зарегистрировать его. Вы должны получить доступ к своей конфигурации только через эту обернутую конфигурацию. Например.
WrappedConfig = новый WrappedConfig<>
PartyConfig. Кодек,
с Config (PartyConfig.CODEC),
Новый ConfigMetadata («PartyChat»)
);
зарегистрироватьConfig (завернутый Config);
Затем пользователи увидят ваш мод, когда они запускаются. /конфигурация.
Редактировать мод выглядит как
\
Вы можете добавить документацию в свои записи кодека, чтобы они отображались в виде подсказки. Например.
.append()
Новый KeyedCodec<>("PlayerSendChatFormat", BuilderCodec). Стреляй,
PartyConfig::setPlayerSendChatFormat
PartyConfig:getPlayerSendChatFormat
.documentation («Это определяет формат, в котором будут отображаться партийные чаты»). Из этого плагина "+
Вы можете использовать в качестве заполнителей [[Получатель]], [[Получатель]] и [[Получатель]]. Другие плагины могут "+
«Добавить больше».
.add()
Который появится как
> Примечание: Вместо прямого доступа к настройке, вы должны использовать метод WrappedConfig#read. Например.
config.read (c -> c.getSystemPrefix())
// или
config.read (PartyConfig::getSystemPrefix)
Это гарантирует, что вы получаете доступ к конфигурации безопасным способом. Если конфигурация сохранена, плагин будет безопасно использовать новые значения.
Показать оригинальное описание (English)
Configure parses a given codec for a config and generates a UI for that codec. To use it, just wrap your config in this plugin's WrappedConfig class and register it. You should only access your config via this wrapped config. E.g.
wrappedConfig = new WrappedConfig<>(
PartyConfig.CODEC,
withConfig(PartyConfig.CODEC),
new ConfigMetadata("PartyChat")
);
registerConfig(wrappedConfig);
Then, users will see your mod show up when they run /config.
Editing a mod looks like
\
You can add documentation to your codec entries so that they show up as a tooltip. E.g.
.append(
new KeyedCodec<>("PlayerSendChatFormat", BuilderCodec.STRING),
PartyConfig::setPlayerSendChatFormat,
PartyConfig::getPlayerSendChatFormat
).documentation("This decides the format in which party chats will show up. From this plugin, " +
"you can use '[SENDER]', '[RECEIVER]', and [MESSAGE] as placeholders. Other plugins can " +
"add more.")
.add()
Which will show up like
> Note: Instead of accessing the config directly, you should use the WrappedConfig#read method. E.g.
config.read(c -> c.getSystemPrefix())
// or
config.read(PartyConfig::getSystemPrefix)
This ensures you are accessing the config in a thread safe way. If the config is saved, the plugin will safely use the new values.
