io.github.nucleuspowered.nucleus.api.module.playerinfo

Interface NucleusSeenService.SeenInformationProvider

Enclosing interface:

NucleusSeenService

public static interface NucleusSeenService.SeenInformationProvider

A NucleusSeenService.SeenInformationProvider object can hook into the seen command and provide extra information on a player.

This must be registered with the NucleusSeenService

Method Summary

Modifier and Type	Method and Description
java.util.Collection<org.spongepowered.api.text.Text>	getInformation(org.spongepowered.api.command.CommandSource source, org.spongepowered.api.entity.living.player.User user) Gets the information to display to the CommandSource about the User
boolean	hasPermission(org.spongepowered.api.command.CommandSource source, org.spongepowered.api.entity.living.player.User user) Gets whether the requesting CommandSource has permission to request the provided information for the requested User.

Method Detail

hasPermission

boolean hasPermission(@Nonnull
                      org.spongepowered.api.command.CommandSource source,
                      @Nonnull
                      org.spongepowered.api.entity.living.player.User user)

Gets whether the requesting CommandSource has permission to request the provided information for the requested User.

Parameters:

source - The CommandSource who ran the seen command.

user - The User that information has been requested about.

Returns:

true if the command should show the user this information.

getInformation

@Nullable
java.util.Collection<org.spongepowered.api.text.Text> getInformation(@Nonnull
                                                                                org.spongepowered.api.command.CommandSource source,
                                                                                @Nonnull
                                                                                org.spongepowered.api.entity.living.player.User user)

Gets the information to display to the CommandSource about the User

Parameters:

source - The CommandSource who ran the seen command.

user - The User that information has been requested about.

Returns:

The Collection containing the Text to display to the user, or an empty iterable. It is recommended, for obvious reasons, that this is ordered! May return null if there is nothing to return.