Package com.github.crashdemons.playerheads.compatibility

Class CompatiblePlugins

java.lang.Object

com.github.crashdemons.playerheads.compatibility.CompatiblePlugins

public final class CompatiblePlugins
extends Object

Class providing methods and information for inter-plugin compatibility. This class may attempt to load some present configuration values. You can avoid this using your plugin's config directly by using the init(plugin,config) method.

Author:

crashdemons (crashenator at gmail.com)

Field Summary

Fields

Modifier and Type	Field	Description
static HeadPluginCompatibility	heads	Generic head support class that determines handling of detected plugin-heads (eg: being able to ignore them)
static NoCheatPlusCompatibility	nocheatplus	NoCheatPlus compatibility class instance
static ProtectionPluginCompatibility	protection	Generic protection-plugin compatibility class instance

Method Summary

Modifier and Type	Method	Description
static void	init(Plugin parentPluginInstance)	Initialize plugin support classes.
static void	init(Plugin parentPluginInstance, ConfigurationSection config)	Initialize plugin support classes.
static boolean	isReady()	Checks whether the plugin compatibility classes are ready for use.
static void	reloadConfig()	Reloads config for plugin-support modules.
static boolean	testBlockBreak(Block block, Player player)	Test of a simulated block break succeeds (considering all applicable plugin support classes).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nocheatplus

public static NoCheatPlusCompatibility nocheatplus

NoCheatPlus compatibility class instance

See Also:

NoCheatPlusCompatibility

protection

public static ProtectionPluginCompatibility protection

Generic protection-plugin compatibility class instance

See Also:

ProtectionPluginCompatibility

heads

public static HeadPluginCompatibility heads

Generic head support class that determines handling of detected plugin-heads (eg: being able to ignore them)

Method Detail

init

public static void init(Plugin parentPluginInstance)

Initialize plugin support classes. This should be done during plugin Enable or afterwards - you may need to add a SoftDepend entry for the plugin to be detected in onEnable.

Note: it's recommended to call this *after* Compatibility.init so that supported plugin classes have access to other compatibility methods.

If this method is used, the top level parent plugin config section is used for plugin-support config entries.

Parameters:

parentPluginInstance - the plugin requesting compatibility support

init

public static void init(Plugin parentPluginInstance,
                        ConfigurationSection config)

Initialize plugin support classes. This should be done during plugin Enable or afterwards - you may need to add a SoftDepend entry for the plugin to be detected in onEnable.

Note: it's recommended to call this *after* Compatibility.init so that supported plugin classes have access to other compatibility methods.

Parameters:

parentPluginInstance - the plugin requesting compatibility support

config - the configuration section to use for plugin-support entries

reloadConfig

public static void reloadConfig()

Reloads config for plugin-support modules. Uses the config specified in init().

testBlockBreak

public static boolean testBlockBreak(Block block,
                                     Player player)

Test of a simulated block break succeeds (considering all applicable plugin support classes). This method includes exempting fastbreak in NCP before testing.

Parameters:

block - the block being broken

player - the player doing the breaking

Returns:

whether the block break succeeded or failed (was cancelled).

isReady

public static boolean isReady()

Checks whether the plugin compatibility classes are ready for use. (whether the class init completed without exception)

Returns:

whether the class is ready