Package net.blueva.arcade.api.config
Interface ModuleConfigAPI
public interface ModuleConfigAPI
API for managing multiple configuration files per module.
Each module can have settings.yml, items.yml, rewards.yml, etc.
Uses the platform configuration backend internally (no YAML dependency needed in modules).
-
Method Summary
Modifier and TypeMethodDescriptionbooleanCheck if path exists in settings.ymlbooleancontainsFrom(String fileName, String path) Check if path exists in a specific config file.booleangetBoolean(String path) Get boolean from settings.ymlbooleangetBoolean(String path, boolean def) Get boolean with default from settings.ymlbooleangetBooleanFrom(String fileName, String path) Get boolean from a specific config file.booleangetBooleanFrom(String fileName, String path, boolean def) Get boolean with default from a specific config file.Get module's data folder.doubleGet double from settings.ymldoubleGet double with default from settings.ymldoublegetDoubleFrom(String fileName, String path) Get double from a specific config file.doublegetDoubleFrom(String fileName, String path, double def) Get double with default from a specific config file.intGet int from settings.ymlintGet int with default from settings.ymlintgetIntFrom(String fileName, String path) Get int from a specific config file.intgetIntFrom(String fileName, String path, int def) Get int with default from a specific config file.Get list of all registered config file names.Get string from main settings.ymlGet string with default from settings.ymlgetStringFrom(String fileName, String path) Get string from a specific config file.getStringFrom(String fileName, String path, String def) Get string with default from a specific config file.getStringList(String path) Get string list from settings.ymlgetStringListFrom(String fileName, String path) Get list from a specific config file.default StringgetTranslation(Object player, String key) Look up a translated string for this module using the runtime language API when available.default StringgetTranslation(Object player, String key, String... placeholders) Look up a translated string and replace MiniMessage placeholder tokens.default StringLook up a translated string and replace MiniMessage placeholder tokens.getTranslationList(Object player, String key) Look up a translated string list for this module using the runtime language API when available.getTranslationList(Object player, String key, String... placeholders) Look up a translated string list and replace MiniMessage placeholder tokens.getTranslationListOrDefault(Object player, String key, List<String> defaultValue) getTranslationListOrDefault(Object player, String key, List<String> defaultValue, String... placeholders) getTranslationListOrDefault(Object player, String key, List<String> defaultValue, Map<String, String> placeholders) default StringgetTranslationOrDefault(Object player, String key, String defaultValue) Look up a translated string and return a caller-provided fallback when missing.default StringgetTranslationOrDefault(Object player, String key, String defaultValue, String... placeholders) default StringgetTranslationOrDefault(Object player, String key, String defaultValue, Map<String, String> placeholders) booleanisRegistered(String fileName) Check if a config file is registered.booleanRegister a config file for this module.booleanDeprecated.default booleanregisterCopyOnly(String fileName) Register a config file using a copy-if-missing strategy.voidReload a specific config file.voidReload all registered configs.voidSave a specific config file.voidsaveAll()Save all registered configs.voidSet value in settings.ymlvoidSet value in a specific config file.
-
Method Details
-
register
Register a config file for this module. Creates it from embedded resource if it doesn't exist.- Parameters:
fileName- Config file name (e.g., "settings.yml", "items.yml")- Returns:
- true if registered successfully
-
register
Deprecated.since 3.4, useregister(String). BlueArcade no longer usesfile_version/file-versionmetadata in module files.Register a config with legacy file-version compatibility. Modern platform implementations ignorefileVersion; it is kept only so modules compiled against BlueArcade 3.3 and older continue to load without changes.- Parameters:
fileName- Config file namefileVersion- Legacy version hint- Returns:
- true if registered successfully
-
registerCopyOnly
Register a config file using a copy-if-missing strategy. The bundled resource is copied to disk only when the user file does not exist. After that the file is loaded as-is without merging with bundled defaults, so any entries the admin deliberately removed are never restored.The default implementation falls back to
register(String). Platform core implementations override this with the real copy-if-missing logic.- Parameters:
fileName- Config file name relative to the module data folder (e.g. "kits.yml")- Returns:
- true if the file was registered successfully
- Since:
- 3.3
-
reload
Reload a specific config file.- Parameters:
fileName- Config file name
-
reloadAll
void reloadAll()Reload all registered configs. -
save
Save a specific config file.- Parameters:
fileName- Config file name
-
saveAll
void saveAll()Save all registered configs. -
isRegistered
Check if a config file is registered.- Parameters:
fileName- Config file name- Returns:
- true if registered
-
getDataFolder
File getDataFolder()Get module's data folder.- Returns:
- Module folder (plugins/BlueArcade/modules/{moduleId}/)
-
getRegisteredConfigs
Get list of all registered config file names.- Returns:
- List of registered config files
-
getString
Get string from main settings.yml- Parameters:
path- Config path- Returns:
- String value
-
getString
Get string with default from settings.yml -
getInt
Get int from settings.yml -
getInt
Get int with default from settings.yml -
getDouble
Get double from settings.yml -
getDouble
Get double with default from settings.yml -
getBoolean
Get boolean from settings.yml -
getBoolean
Get boolean with default from settings.yml -
getStringList
Get string list from settings.yml -
contains
Check if path exists in settings.yml -
getStringFrom
Get string from a specific config file.- Parameters:
fileName- Config file namepath- Config path- Returns:
- String value
-
getStringFrom
Get string with default from a specific config file. -
getIntFrom
Get int from a specific config file. -
getIntFrom
Get int with default from a specific config file. -
getDoubleFrom
Get double from a specific config file. -
getDoubleFrom
Get double with default from a specific config file. -
getBooleanFrom
Get boolean from a specific config file. -
getBooleanFrom
Get boolean with default from a specific config file. -
getStringListFrom
Get list from a specific config file. -
containsFrom
Check if path exists in a specific config file. -
getTranslation
Look up a translated string for this module using the runtime language API when available.The default implementation preserves legacy behavior by reading from the module's single
language.ymlfile.- Parameters:
player- platform player, ornullto use the server default localekey- translation key- Returns:
- translated value or the raw key when missing
- Since:
- 3.4
-
getTranslation
Look up a translated string and replace MiniMessage placeholder tokens. Placeholders are passed as pairs:"{name}", "value".- Parameters:
player- platform player, ornullto use the server default localekey- translation keyplaceholders- placeholder pairs- Returns:
- translated value or the raw key when missing
- Since:
- 3.4
-
getTranslation
Look up a translated string and replace MiniMessage placeholder tokens. Placeholder keys are used exactly as supplied, e.g."{name}".- Parameters:
player- platform player, ornullto use the server default localekey- translation keyplaceholders- placeholder map- Returns:
- translated value or the raw key when missing
- Since:
- 3.4
-
getTranslationOrDefault
Look up a translated string and return a caller-provided fallback when missing.- Parameters:
player- platform player, ornullto use the server default localekey- translation keydefaultValue- fallback returned when the translation is missing- Returns:
- translated value or
defaultValue - Since:
- 3.4
-
getTranslationOrDefault
-
getTranslationOrDefault
-
getTranslationList
Look up a translated string list for this module using the runtime language API when available. This is intended for scoreboards, menu lore, multi-line result messages, and other localized lists.The default implementation preserves legacy behavior by reading from the module's single
language.ymlfile.- Parameters:
player- platform player, ornullto use the server default localekey- translation key- Returns:
- translated list, or an empty list when missing
- Since:
- 3.4
-
getTranslationList
Look up a translated string list and replace MiniMessage placeholder tokens. Placeholders are passed as pairs:"{name}", "value".- Parameters:
player- platform player, ornullto use the server default localekey- translation keyplaceholders- placeholder pairs- Returns:
- translated list, or an empty list when missing
- Since:
- 3.4
-
getTranslationList
-
getTranslationListOrDefault
-
getTranslationListOrDefault
-
getTranslationListOrDefault
-
set
Set value in settings.yml -
setIn
Set value in a specific config file.
-
register(String).