Add in an exclusion list tag for @Mod. The backend code isn't yet implemented, but shows the basic idea.

This commit is contained in:
Christian 2012-10-27 15:13:28 -04:00
parent 5115306e76
commit 463514fbbe

View file

@ -69,6 +69,21 @@ public @interface Mod
* @return The name of the plugin to load for this mod * @return The name of the plugin to load for this mod
*/ */
String bukkitPlugin() default ""; String bukkitPlugin() default "";
/**
* Mods that this mod will <strong>not</strong> load with.
* An optional comma separated string of modid[@value], or the value - which specify mods that
* this mod will refuse to load with, resulting in the game failing to start. The special value - is
* interpreted as meaning <strong>all</strong> mods, except FML and MCP. The special value -f is
* interpreted as meaning <strong>all</strong> mods except FML, MCP and MinecraftForge.
*
* If a mod is present on the excluded list, the game will stop and show an error screen. If the
* class containing the {@link Mod} annotation has a "getCustomErrorException" method, it will be
* called to retrieve a custom error message for display in this case. If two mods have a declared
* exclusion which screen is shown is indeterminate.
*
* @return A string listing modids to exclude from loading with this mod.
*/
String modExclusionList() default "";
/** /**
* Mark the designated method as being called at the "pre-initialization" phase * Mark the designated method as being called at the "pre-initialization" phase
* @author cpw * @author cpw