io.github.nucleuspowered.nucleus.api.service

Interface NucleusSeenService

public interface NucleusSeenService

This service allows plugins to register handlers that will display information when a player runs the /seen command.

Plugins are expected to only register one NucleusSeenService.SeenInformationProvider.

Consumers of this API should also note that this might run asynchronously. No methods that would require the use of a synchronous API should be used here.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NucleusSeenService.SeenInformationProvider A NucleusSeenService.SeenInformationProvider object can hook into the seen command and provide extra information on a player.

Method Summary

Modifier and Type	Method and Description
void	register(Object plugin, NucleusSeenService.SeenInformationProvider seenInformationProvider) Registers a NucleusSeenService.SeenInformationProvider with Nucleus.
void	register(Object plugin, Predicate<org.spongepowered.api.command.CommandSource> permissionCheck, BiFunction<org.spongepowered.api.command.CommandSource,org.spongepowered.api.entity.living.player.User,Collection<org.spongepowered.api.text.Text>> informationGetter) Registers a NucleusSeenService.SeenInformationProvider with Nucleus that can be constructed using a functional programming style.

Method Detail

register

void register(Object plugin,
              NucleusSeenService.SeenInformationProvider seenInformationProvider)
       throws IllegalArgumentException

Registers a NucleusSeenService.SeenInformationProvider with Nucleus.

Parameters:

plugin - The plugin registering the service.

seenInformationProvider - The NucleusSeenService.SeenInformationProvider

Throws:

IllegalArgumentException - Thrown if the plugin has either

• Registered a NucleusSeenService.SeenInformationProvider already
• Not provided the Plugin annotated class

register

void register(Object plugin,
              Predicate<org.spongepowered.api.command.CommandSource> permissionCheck,
              BiFunction<org.spongepowered.api.command.CommandSource,org.spongepowered.api.entity.living.player.User,Collection<org.spongepowered.api.text.Text>> informationGetter)
       throws IllegalArgumentException

Registers a NucleusSeenService.SeenInformationProvider with Nucleus that can be constructed using a functional programming style.

Parameters:

plugin - The plugin registering the service.

permissionCheck - A Predicate that checks that the CommandSource has permission to view the information provided.

informationGetter - A BiFunction that accepts a CommandSource that wants to view information about a User and returns a Collection of Text to view.

Throws:

IllegalArgumentException - Thrown if the plugin has either

• Registered a NucleusSeenService.SeenInformationProvider already
• Not provided the Plugin annotated class