com.elmakers.mine.bukkit.api.requirements

Interface RequirementsProcessor

All Known Subinterfaces:

RequirementsProvider

public interface RequirementsProcessor

Implement this and register in PreLoadEvent to provide custom requirements. Use RequirementsProvider instead for simpler registration.

Method Summary

Modifier and Type	Method and Description
boolean	checkRequirement(MageContext context, Requirement requirement) Check if a player fulfills the target requirement.
String	getRequirementDescription(MageContext context, Requirement requirement) This will be called when a requirement check has failed, in order to display to the player what they are missing.

Method Detail

checkRequirement

boolean checkRequirement(@Nonnull
                         MageContext context,
                         @Nonnull
                         Requirement requirement)

Check if a player fulfills the target requirement. Requirements are defined ad-hoc on spell configurations, Selector configurations and perhaps other configurations in the future.

There is no central definition of all known requirements, and processors need not register them in advance.

Parameters:

context - The context under which this query is taking place

requirement - The requirement being checked

Returns:

true if the player has the requirement

getRequirementDescription

@Nullable
String getRequirementDescription(@Nonnull
                                           MageContext context,
                                           @Nonnull
                                           Requirement requirement)

This will be called when a requirement check has failed, in order to display to the player what they are missing. This will generally be added to item lore for display in a GUI.

Parameters:

context - The context under which this requirement failed

requirement - The requirement that failed

Returns:

a player-readable description of what this requirement represents.