Package com.github.crashdemons.playerheads.compatibility.plugins

Class HeadPluginCompatibility

java.lang.Object

com.github.crashdemons.playerheads.compatibility.plugins.CompatiblePlugin

com.github.crashdemons.playerheads.compatibility.plugins.HeadPluginCompatibility

public class HeadPluginCompatibility
extends CompatiblePlugin

Compatibility class providing detection of special-case (configured) custom heads from other plugins. Currently, this only allows detection of blacklisted head names/IDs in plugins.

Author:

crashdemons (crashenator at gmail.com)

Field Summary

Fields inherited from class com.github.crashdemons.playerheads.compatibility.plugins.CompatiblePlugin

config, parentPlugin

Constructor Summary

Constructors

Constructor	Description
HeadPluginCompatibility(Plugin parentPlugin)	Constructs the head compatibility object
HeadPluginCompatibility(Plugin parentPlugin, ConfigurationSection config)	Constructs the head compatibility object

Method Summary

Modifier and Type	Method	Description
HeadModificationHandling	getExternalHeadHandling(String ownerName, UUID ownerID)	Gets the acceptable head modifiability of considering the provided name and ID of the head.
HeadModificationHandling	getExternalHeadHandling(BlockState state)	Gets the acceptable head modifiability of considering the provided name and ID of the head.
HeadModificationHandling	getExternalHeadHandling(ItemStack stack)	Gets the acceptable head modifiability of considering the provided name and ID of the head.
void	reloadConfig()

Methods inherited from class com.github.crashdemons.playerheads.compatibility.plugins.CompatiblePlugin

get, getName, getPlugin, isPresent, isReady

Methods inherited from class java.lang.Object

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

Constructor Detail

HeadPluginCompatibility

public HeadPluginCompatibility(Plugin parentPlugin)

Constructs the head compatibility object

Parameters:

parentPlugin - the plugin requesting compatibility support

HeadPluginCompatibility

public HeadPluginCompatibility(Plugin parentPlugin,
                               ConfigurationSection config)

Constructs the head compatibility object

Parameters:

parentPlugin - the plugin requesting compatibility support

config - the configuration section to use for this class' settings.

Method Detail

reloadConfig

public void reloadConfig()

Overrides:

reloadConfig in class CompatiblePlugin

getExternalHeadHandling

@NotNull
public HeadModificationHandling getExternalHeadHandling(String ownerName,
                                                        UUID ownerID)

Gets the acceptable head modifiability of considering the provided name and ID of the head. In short, this determines whether the head has been blacklisted (NO_INTERACTION) or not (NORMAL).

Parameters:

ownerName - the name associated with the head

ownerID - the UUID associated with the head

Returns:

the recommended handling for the head

getExternalHeadHandling

@NotNull
public HeadModificationHandling getExternalHeadHandling(BlockState state)

Gets the acceptable head modifiability of considering the provided name and ID of the head. In short, this determines whether the head has been blacklisted (NO_INTERACTION) or not (NORMAL).

Parameters:

state - the blockstate of the head to retrieve username/UUID from.

Returns:

the recommended handling for the head

getExternalHeadHandling

@NotNull
public HeadModificationHandling getExternalHeadHandling(ItemStack stack)

Gets the acceptable head modifiability of considering the provided name and ID of the head. In short, this determines whether the head has been blacklisted (NO_INTERACTION) or not (NORMAL).

Parameters:

stack - the itemstack of the head to retrieve username/UUID from.

Returns:

the recommended handling for the head