cpw.mods.fml.common

Annotation Type BukkitPluginRef

@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface BukkitPluginRef

Declare a variable to be populated by a Bukkit Plugin proxy instance if the bukkit coremod is available. It can only be applied to field typed as BukkitProxy Generally it should be used in conjunction with Mod.bukkitPlugin() specifying the plugin to load.

Author:

cpw

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value A reference (possibly version specific) to a Bukkit Plugin by name, using the name@versionbound specification.

Element Detail

value

public abstract String value

A reference (possibly version specific) to a Bukkit Plugin by name, using the name@versionbound specification. If this is a bukkit enabled environment the field annotated by this will be populated with a BukkitProxy instance if possible. This proxy will be gotten by reflectively calling the "getModProxy" method on the bukkit plugin instance.

Returns:

The name of the plugin which we will inject into this field