io.github.nucleuspowered.nucleus.api.service

Interface NucleusUserPreferenceService.Keys

Enclosing interface:

NucleusUserPreferenceService

public static interface NucleusUserPreferenceService.Keys

Contains NucleusUserPreferenceService.PreferenceKeys

Method Summary

Modifier and Type	Method and Description
Optional<NucleusUserPreferenceService.PreferenceKey<Boolean>>	commandSpyEnabled() If the command spy module is enabled, gets a preference key that indicates whether the user is receiving messages that indicate commands that are being run by other players.
Optional<NucleusUserPreferenceService.PreferenceKey<Boolean>>	messageReceivingEnabled() If the message module is enabled, gets a preference key that indicates whether the user has is receiving private messages.
Optional<NucleusUserPreferenceService.PreferenceKey<Boolean>>	powertoolsEnabled() If the powertool module is enabled, gets a preference key that indicates whether the user has enabled powertools by attempting to use an object that is assigned to a powertool.
Optional<NucleusUserPreferenceService.PreferenceKey<Boolean>>	socialSpyEnabled() If the message module is enabled, gets a preference key that indicates whether the user has enabled social spy.
Optional<NucleusUserPreferenceService.PreferenceKey<Boolean>>	teleportTarget() If the teleport module is enabled, gets a preference key that indicates whether the user allows players to teleport to them.
Optional<NucleusUserPreferenceService.PreferenceKey<Boolean>>	vanishOnLogin() If the vanish module is enabled, gets a preference key that indicates whether the user will vanish on login.
Optional<NucleusUserPreferenceService.PreferenceKey<Boolean>>	viewStaffChat() If the staff chat module is enabled, gets a preference key that indicates whether the user is receiving messages on the staff chat channel.

Method Detail

vanishOnLogin

Optional<NucleusUserPreferenceService.PreferenceKey<Boolean>> vanishOnLogin()

If the vanish module is enabled, gets a preference key that indicates whether the user will vanish on login.

Returns:

The NucleusUserPreferenceService.PreferenceKey, if the module is loaded.

teleportTarget

Optional<NucleusUserPreferenceService.PreferenceKey<Boolean>> teleportTarget()

If the teleport module is enabled, gets a preference key that indicates whether the user allows players to teleport to them.

Returns:

The NucleusUserPreferenceService.PreferenceKey, if the module is loaded.

powertoolsEnabled

Optional<NucleusUserPreferenceService.PreferenceKey<Boolean>> powertoolsEnabled()

If the powertool module is enabled, gets a preference key that indicates whether the user has enabled powertools by attempting to use an object that is assigned to a powertool.

Returns:

The NucleusUserPreferenceService.PreferenceKey, if the module is loaded.

socialSpyEnabled

Optional<NucleusUserPreferenceService.PreferenceKey<Boolean>> socialSpyEnabled()

If the message module is enabled, gets a preference key that indicates whether the user has enabled social spy. This may be overriden by a force permission.

Returns:

The NucleusUserPreferenceService.PreferenceKey, if the module is loaded.

messageReceivingEnabled

Optional<NucleusUserPreferenceService.PreferenceKey<Boolean>> messageReceivingEnabled()

If the message module is enabled, gets a preference key that indicates whether the user has is receiving private messages.

Returns:

The NucleusUserPreferenceService.PreferenceKey, if the module is loaded.

commandSpyEnabled

Optional<NucleusUserPreferenceService.PreferenceKey<Boolean>> commandSpyEnabled()

If the command spy module is enabled, gets a preference key that indicates whether the user is receiving messages that indicate commands that are being run by other players.

Returns:

The NucleusUserPreferenceService.PreferenceKey, if the module is loaded.

viewStaffChat

Optional<NucleusUserPreferenceService.PreferenceKey<Boolean>> viewStaffChat()

If the staff chat module is enabled, gets a preference key that indicates whether the user is receiving messages on the staff chat channel.

Returns:

The NucleusUserPreferenceService.PreferenceKey, if the module is loaded.