Package net.blueva.arcade.api.module
Interface ModuleInfo
public interface ModuleInfo
Read-only access to module metadata from module.yml.
Automatically provided to modules through ModuleAPI.
-
Method Summary
Modifier and TypeMethodDescriptionGet the module's API version.Get the module's authors.Get the module's description.default StringGet the minimum server version this module supports, as declared by thegame-versionfield inmodule.yml.getId()Get the module's unique identifier.getName()Get the module's display name.default PlatformTypeGet the target platform declared inmodule.yml.Get the module's soft dependencies.getType()Get the module's type.Get the module's version.Get the module's website.
-
Method Details
-
getId
String getId()Get the module's unique identifier.- Returns:
- Module ID (e.g., "race")
-
getName
String getName()Get the module's display name.- Returns:
- Module name (e.g., "Race")
-
getVersion
String getVersion()Get the module's version.- Returns:
- Version string (e.g., "1.0.0")
-
getType
ModuleType getType()Get the module's type.- Returns:
- Module type (MINIGAME or MICROGAME)
-
getAuthors
Get the module's authors.- Returns:
- List of author names
-
getDescription
String getDescription()Get the module's description.- Returns:
- Description or empty string
-
getWebsite
String getWebsite()Get the module's website.- Returns:
- Website URL or null
-
getApiVersion
String getApiVersion()Get the module's API version.- Returns:
- API version string
-
getSoftDepend
Get the module's soft dependencies.- Returns:
- List of soft dependency module IDs
-
getPlatform
Get the target platform declared inmodule.yml.When the
platformfield is absent from the descriptor the module is considered cross-platform and this method returnsnull.- Returns:
- the target platform, or
nullif not declared (cross-platform) - Since:
- 3.2
-
getGameVersion
Get the minimum server version this module supports, as declared by thegame-versionfield inmodule.yml.The value is a plain version string of the target platform's own versioning scheme (e.g.
"1.16"on Minecraft) and means "this module runs on that version and any newer one" - there is no upper bound. A module that omits the field declares no minimum and this method returnsnull.- Returns:
- the minimum supported server version, or
nullif not declared - Since:
- 3.5
-