diff --git a/eco-api/src/main/java/com/willfp/eco/core/EcoPluginProps.java b/eco-api/src/main/java/com/willfp/eco/core/EcoPluginProps.java index 18334a8c..275d06e2 100644 --- a/eco-api/src/main/java/com/willfp/eco/core/EcoPluginProps.java +++ b/eco-api/src/main/java/com/willfp/eco/core/EcoPluginProps.java @@ -4,6 +4,17 @@ import com.willfp.eco.core.config.interfaces.Config; import org.jetbrains.annotations.ApiStatus; import org.jetbrains.annotations.NotNull; +/** + * Plugin props are the arguments related to the plugin that are required on start-up. + * Marked as internal as the props may change / update, which will cause problems if + * you create props objects. + * + * @param resourceId The ID of the plugin on polymart. + * @param bStatsId The ID of the plugin on bStats. + * @param proxyPackage The package where proxies can be found. + * @param color The primary color of the plugin. + * @param supportingExtensions If the plugin should attempt to look for extensions. + */ @ApiStatus.Internal public record EcoPluginProps(int resourceId, int bStatsId,