Index (nucleus-api 1.13.2-S7.1 API)

A B C D E F G H I J K L M N O P R S T U V W

A

addCommand(String) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Adds a command to the Kit
addName(String, String, Cause) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusNameBanService
addNote(User, CommandSource, String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusNoteService: Adds a note to a subject.
addWarmup(UUID, Task) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarmupManagerService: Adds a warmup to the warmup manager
addWarning(User, CommandSource, String, Duration) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarningService: Adds a warning to a player.
ALTERNATIVE_HOME_COUNT_OPTION - Static variable in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: Deprecated.
Use NucleusHomeService.HOME_COUNT_OPTION as the permission option to set home counts, as that will override this one.
applyPrimaryToken(String, CommandSource) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMessageTokenService: Gets the result of a primary token's registered NucleusMessageTokenService.TokenParser on a CommandSource
applyPrimaryToken(String, CommandSource, Map<String, Object>) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMessageTokenService: Gets the result of a primary token's registered NucleusMessageTokenService.TokenParser on a CommandSource
applyToken(String, String, CommandSource) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMessageTokenService: Gets the result of a token's registered NucleusMessageTokenService.TokenParser on a CommandSource
applyToken(String, String, CommandSource, Map<String, Object>) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMessageTokenService: Gets the result of a token's registered NucleusMessageTokenService.TokenParser on a CommandSource
AROUND_PLAYER - Static variable in class io.github.nucleuspowered.nucleus.api.rtp.RTPKernels: The default Nucleus RTP kernel, adjusted to centre around the player, not the world border centre.
AROUND_PLAYER_SURFACE - Static variable in class io.github.nucleuspowered.nucleus.api.rtp.RTPKernels: The default Nucleus RTP kernel, adjusted to centre around the player, not the world border centre, and surface only

B

build() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService.RTPOptions.Builder: Creates a NucleusRTPService.RTPOptions from the state of this builder.

C

canAccess(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusUserPreferenceService.PreferenceKey: Tests whether a user can change their preference.
canBeKicked(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusAFKService: Returns whether a User can be kicked for inactivity.
CancelMessage - Interface in io.github.nucleuspowered.nucleus.api.events
canDisableModules() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusModuleService: Returns whether modules can be disabled.
canGoAFK(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusAFKService: Returns whether the User in question can go AFK.
canSpyOn(User, CommandSource...) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Returns whether the specified user can spy on all of the specified sources.
canSpySameLevel() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: If using social spy levels, this returns whether those on the same social spy level as the participants of a message can read a message.
cleanup() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarmupManagerService: Removes warmups that have completed.
clearCommandSourceReplyTo(T) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Removes the CommandSource that the specified CommandSource will reply to if /r is used.
clearConsoleReplyTo() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Removes the CommandSource that the console will reply to if /r is used.
clearNotes(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusNoteService: Clears all notes from a subject.
clearReplyTo(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Removes the CommandSource that the specified User will reply to if /r is used.
clearUserMail(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMailService: Clears the player's mail.
close() - Method in interface io.github.nucleuspowered.nucleus.api.util.NoExceptionAutoClosable: Closes resources associated with this closable
commandSpyEnabled() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusUserPreferenceService.Keys: 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.
containsTokens() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusTextTemplateEvent: Whether the message contains tokens that may be replaced.
containsTokens() - Method in interface io.github.nucleuspowered.nucleus.api.text.NucleusTextTemplate: Returns whether there are tokens to parse.
Cooldown(String, Duration) - Constructor for exception io.github.nucleuspowered.nucleus.api.exceptions.KitRedeemException.Cooldown
createDateFilter(Instant, Instant) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMailService: Create a filter that restricts the mail to a certain time period.
createFromString(String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMessageTokenService: Creates a NucleusTextTemplate from a string, which could be either Json or Ampersand formatted.
createHome(Cause, User, String, Location<World>, Vector3d) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: Creates a home.
createHome(Cause, UUID, String, Location<World>, Vector3d) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService
createKit(String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusKitService: Gets a new kit object for use with the Kit service.
createMessageFilter(boolean, String...) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMailService: Create a filter that restricts the messages returned to the provided substring.
createMessageFilter(boolean, Collection<String>) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMailService: Create a filter that restricts the messages returned to the provided substring.
createSenderFilter(boolean, UUID...) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMailService: Create a filter that restricts the mail to the senders provided.
createSenderFilter(boolean, Collection<UUID>) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMailService: Create a filter that restricts the mail to the senders provided.

D

DEFAULT - Static variable in class io.github.nucleuspowered.nucleus.api.rtp.RTPKernels: The default Nucleus RTP kernel.
DEFAULT_HOME_NAME - Static variable in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: The default home name.
disableModule(String, Object) - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusModuleEvent.AboutToConstruct: Disables the named module.
disableTrackingFor(Player) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusAFKService: Deprecated.
Use NucleusAFKService.disableTrackingForPlayer(Player, int) instead.
disableTrackingFor(Player, int) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusAFKService: Deprecated.
Use NucleusAFKService.disableTrackingForPlayer(Player, int) instead.
disableTrackingForPlayer(Player) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusAFKService: Disables activity tracking for the specified Player for the next tick.
disableTrackingForPlayer(Player, int) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusAFKService: Disables activity tracking for the specified Player for up to the number of ticks specified.

E

environment() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusBlacklistMigrationService.Result: Deprecated.

If true, Nucleus blocked this type from being placed/broken.
EventContexts - Class in io.github.nucleuspowered.nucleus.api: Contexts that may appear in the Cause of some events.
EventContexts.Identifiers - Class in io.github.nucleuspowered.nucleus.api
expired() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusMuteEvent.Unmuted: Whether the mute simply expired.
expired() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.TimedEntry: Returns whether this entry can be considered expired.
expireWarning(User, Warning, Cause) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarningService: Expires (or removes) a warning.

F

forcedSocialSpyState(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Returns whether the specified user can toggle social spy Tristate.UNDEFINED, or whether they are forced to use social spy Tristate.TRUE, or do not have permission to do so Tristate.FALSE.
formatMessages() - Method in interface io.github.nucleuspowered.nucleus.api.chat.NucleusNoFormatChannel: Determines whether Nucleus should try to format the message.
from(NucleusRTPService.RTPOptions) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService.RTPOptions.Builder: Sets this builder state from the specified NucleusRTPService.RTPOptions

G

getAfk() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusAFKService: Returns a collection of players who are currently AFK.
getAFKService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusAFKService, if it exists.
getAllWarps() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Gets all the warps available.
getAuthor() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusNoteEvent: Gets the UUID of the player who added the note, or an Optional.empty() if it was not a player.
getBackService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusBackService, if it exists.
getBlacklistedBlockstates() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusBlacklistMigrationService: Deprecated.

Gets all the BlockStates that had a restriction on them.
getBlacklistedItemtypes() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusBlacklistMigrationService: Deprecated.

Gets all the ItemTypes that had a restriction on them.
getBuyPrice(ItemType) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusServerShopService: Gets the buy price of an item (that is, how much a server will sell an item to a player for).
getBuyPrice(BlockState) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusServerShopService: Gets the buy price of an item (that is, how much a server will sell an item to a player for).
getBuyPrice(ItemStack) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusServerShopService: Gets the buy price of an item (that is, how much a server will sell an item to a player for).
getBuyPrice(ItemStackSnapshot) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusServerShopService: Gets the buy price of an item (that is, how much a server will sell an item to a player for).
getBuyPrices() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusServerShopService: Gets all the server buy prices.
getCancelMessage() - Method in interface io.github.nucleuspowered.nucleus.api.events.CancelMessage: The message to send to the player if the event is cancelled, if any.
getCancelMessage() - Method in exception io.github.nucleuspowered.nucleus.api.exceptions.KitRedeemException.PreCancelled
getCategory() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Warp: Gets the category for this warp, if it exists.
getChannel() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusAFKEvent: Gets the channel to send the message to
getCommands() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Gets the commands associated with this kit.
getCommandSourceReplyTo(T) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Gets the CommandSource that the specified T will reply to if /r is used, if any.
getConsoleReplyTo() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Gets the CommandSource that the console will reply to if /r is used, if any.
getContainer() - Method in exception io.github.nucleuspowered.nucleus.api.exceptions.PluginAlreadyRegisteredException: The PluginContainer that could not be registered.
getCooldown() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Gets the cooldown time for the kit.
getCost() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: The cost for claiming the kit.
getCost() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Warp: Gets the cost of this warp, if the warp has a cost.
getCreationInstant() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Inmate: Gets the Instant this inmate was jailed, if this information was recorded.
getCreationInstant() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.MuteInfo: Gets the Instant this player was muted, if this information was recorded.
getCustomTargetLevel() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Gets the social spy level for any message targets registered using NucleusPrivateMessagingService.registerMessageTarget(UUID, String, Text, Supplier).
getDate() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusNoteEvent: Gets the Instant the note was created.
getDate() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.MailMessage: The time the message was sent.
getDate() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Note: The Instant the note was placed.
getDate() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Warning: When the warning was issued.
getDefaultKernel() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService: Gets the RTPKernel that Nucleus' RTP will use.
getDefaultValue() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusUserPreferenceService.PreferenceKey: The default value for a preference, if any.
getDescription() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Warp: Gets the description for the warp.
getDescription() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.WarpCategory: Gets the defined description of the category, if available.
getDescription() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusUserPreferenceService.PreferenceKey: The description of the preference.
getDisplayName() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.WarpCategory: Gets the display name of the category.
getDuration() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusJailEvent.Jailed: How long the player is jailed for.
getDuration() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusMuteEvent.Muted: Gets the duration of the mute, if any.
getEntry() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusNameBanEvent: The entry that was affected.
getExceptionType() - Method in exception io.github.nucleuspowered.nucleus.api.exceptions.NucleusException: Gets the basic reason for the issue.
getForCommandSource(CommandSource) - Method in interface io.github.nucleuspowered.nucleus.api.text.NucleusTextTemplate: Gets the Text where the tokens have been parsed from the viewpoint of the supplied CommandSource.
getForCommandSource(CommandSource, Map<String, Function<CommandSource, Optional<Text>>>, Map<String, Object>) - Method in interface io.github.nucleuspowered.nucleus.api.text.NucleusTextTemplate: Gets the Text where the tokens have been parsed from the viewpoint of the supplied CommandSource.
getFreezePlayerService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusFreezePlayerService, if it exists.
getHome() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusHomeEvent.Delete: Gets the existing home.
getHome() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusHomeEvent.Modify: Gets the existing home.
getHome() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusHomeEvent.Use: Gets the existing home.
getHome(UUID, String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: Gets a specified home of the user, if it exists.
getHome(User, String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService
getHomeCount(UUID) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: Gets the number of homes the player currently has.
getHomeCount(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: Gets the number of homes the player currently has.
getHomes(UUID) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: Gets the Homes for the specified user, identified by their UUID.
getHomes(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: Gets the Homes for the specified user, identified by their UUID.
getHomeService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusHomeService, if it exists.
getId() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.WarpCategory: Gets the ID of the category.
getID() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusUserPreferenceService.PreferenceKey: The ID of the key.
getInformation(CommandSource, User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusSeenService.SeenInformationProvider: Gets the information to display to the CommandSource about the User
getInterval() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Deprecated.
Use Kit.getCooldown()
getInvulnerabilityService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusInvulnerabilityService, if it exists.
getItemsForPlayer(Player) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Obtains a collection of items that a player would obtain when redeeming the kit.
getItemsForPlayer(Kit, Player) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusKitService: Returns the items for a kit that the target player would redeem (that is, with token replacements if applicable).
getJail(String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusJailService: Gets the location of a jail, if it exists.
getJailer() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Inmate: The UUID of the jailer, or Optional.empty() if it was the console.
getJailName() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusJailEvent.Jailed: The name of the jail the player is sent to.
getJailName() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Inmate: The jail the player is jailed in.
getJails() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusJailService: Gets the name of the jails on the server.
getJailService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusJailService, if it exists.
getKit(String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusKitService: Gets the requested kit if it exists.
getKitNames() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusKitService: Gets the names of all the kits currently in NucleusPlugin.
getKitService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusKitService, if it exists.
getLastIP() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPlayerMetadataService.Result: Gets the last known IP address of the user.
getLastLocation(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusBackService: Gets the location of the subject before they executed the last warp that was marked as Returnable.
getLastLocation() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPlayerMetadataService.Result: Gets the last known location of the user.
getLastLogin() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPlayerMetadataService.Result: The Instant that the player last logged in.
getLastLogout() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPlayerMetadataService.Result: The Instant that the player last logged out.
getLastRedeemedTime() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusKitEvent.Redeem: Gets the last time the kit was redeemed, if any.
getLocation() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusHomeEvent: Gets the Location of the home.
getLocation() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusRTPEvent.SelectedLocation: Gets the proposed location
getLocation() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusWarpEvent.Create: Gets the proposed Location of the warp.
getLocation() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusWarpEvent.Delete: Gets the Location of the warp.
getLocation() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusWarpEvent.Use: Gets the Location of the warp.
getLocation() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.NamedLocation: Gets the Location if the world is loaded.
getLocation(Location<World>, World, NucleusRTPService.RTPOptions) - Method in interface io.github.nucleuspowered.nucleus.api.rtp.RTPKernel: Gets a new location.
getLocation(Location<World>, World, NucleusRTPService.RTPOptions) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService: Uses the default RTP kernel (from NucleusRTPService.getDefaultKernel() to find a random location, given the provided NucleusRTPService.RTPOptions.
getMail(User, NucleusMailService.MailFilter...) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMailService: Gets mail for a specific player, optionally including a list of filters.
getMailService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusMailService, if it exists.
getMappedUUID(UUID) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWorldUUIDChangeService
getMaximumHomes(UUID) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: Returns the maximum number of homes the player can have.
getMaximumHomes(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: Returns the maximum number of homes the player can have.
getMessage() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusAFKEvent: Gets the message to send to players
getMessage() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusAFKEvent.NotifyCommand: Gets the message to send to the command invoker
getMessage() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusMailEvent: The message that was sent.
getMessage() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusMessageEvent: The message that was sent.
getMessage() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusTextTemplateEvent: Get the NucleusTextTemplate that will be parsed and sent to players.
getMessage() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.MailMessage: The message that was sent.
getMessageFor(CommandSource) - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusTextTemplateEvent: Gets the message that would be sent to the specified CommandSource.
getMessageTokenService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusMessageTokenService service, which allows plugins to register message tokens/placeholders.
getMetaService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the API Meta service, which contains the version information.
getModuleList() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusModuleEvent: Gets the module list, along with the NucleusModuleEvent.ModuleEnableState
getModuleService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusModuleService service, which contains the module information, as well as a way to disable the modules during pre-init or init.
getModulesToLoad() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusModuleService: Gets the ids of the modules to load, or the modules that have been loaded.
getMuter() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.MuteInfo: The UUID of the muter, or Optional.empty() if the muter was not a player.
getMuteService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusMuteService, if it exists.
getName() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusHomeEvent: Gets the name of the home.
getName() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusKitEvent.Redeem: Gets the name of the kit.
getName() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusWarpEvent: Get the name of the warp.
getName() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Gets the name of the kit.
getName() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.NamedLocation: Gets the name of the location.
getNameBanService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusNameBanService, if it exists.
getNewNickname() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusChangeNicknameEvent: Deprecated.
Use NucleusChangeNicknameEvent.getNickname() instead
getNickname() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusChangeNicknameEvent: Deprecated.

The new nickname, if any, for the TargetUserEvent.getTargetUser()
getNickname() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusChangeNicknameEvent.Post: Deprecated.

The new nickname, if any, for the NucleusChangeNicknameEvent.Post.getTargetUser()
getNickname() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusChangeNicknameEvent.Pre: Deprecated.

The new nickname, if any, for the NucleusChangeNicknameEvent.Pre.getTargetUser()
getNickname(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusNicknameService: Gets the current nickname for a user, if it exists.
getNicknameService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusNicknameService, if it exists.
getNicknameWithPrefix(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusNicknameService: Gets the current nickname for a user with prefix, if it exists.
getNote() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusNoteEvent: The note.
getNote() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Note: The contents of the note.
getNoter() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Note: The UUID of the player who added the note, or Optional.empty() if this was the console.
getNotes(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusNoteService: Gets all notes for a specific user
getNoteService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusNoteService, if it exists.
getOriginalChannel() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusAFKEvent: Gets the original message channel to send the message to
getOriginalLocation() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusHomeEvent.Modify: Gets the original Location of the home.
getOriginalMessage() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusAFKEvent: Gets the original message that would have been sent to players, if any.
getOriginalMessage() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusAFKEvent.NotifyCommand: Gets the original message that would have been sent to players, if any.
getOriginalMessage() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusTextTemplateEvent: Get the original NucleusTextTemplate.
getOriginalRecipients() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusTextTemplateEvent: Get the original recipients to send the message to.
getOriginalTransformTo() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusSendToSpawnEvent: The original Transform Nucleus was going to send the User to, in the event it's changed.
getOwnersUniqueId() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Home: The UUID of the user.
getPlayerJailData(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusJailService: Returns information about why a subject is jailed, if they are indeed jailed.
getPlayerMetadataService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the API Player Metadata service, which contains the player metadata information.
getPlayerMuteInfo(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMuteService: Gets the MuteInfo about a player.
getPosition() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.NamedLocation: Gets the position.
getPreferenceFor(User, NucleusUserPreferenceService.PreferenceKey<T>) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusUserPreferenceService: Gets the preference associated with the NucleusUserPreferenceService.PreferenceKey for the supplied User, if any is set.
getPrefix() - Method in interface io.github.nucleuspowered.nucleus.api.text.NucleusTextTemplate: Gets the static Text this message will be prefixed with, if any.
getPreviousLocation() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Inmate: The previous location of the player - which is where they will be sent to upon unjailing.
getPreviousNickname() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusChangeNicknameEvent: Deprecated.

The previous nickname for the TargetUserEvent.getTargetUser()
getPreviousNickname() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusChangeNicknameEvent.Post: Deprecated.

The previous nickname for the NucleusChangeNicknameEvent.Post.getTargetUser()
getPreviousNickname() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusChangeNicknameEvent.Pre: Deprecated.

The previous nickname for the NucleusChangeNicknameEvent.Pre.getTargetUser()
getPrimaryTokenParserAndIdentifier(String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMessageTokenService: Gets the NucleusMessageTokenService.TokenParser and specific token identifier for a primary token.
getPrimaryTokens() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMessageTokenService: Gets the currently registered primary tokens.
getPrivateMessagingService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusPrivateMessagingService, if it exists.
getReason() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusJailEvent.Jailed: The reason for the jailing.
getReason() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusMuteEvent.Muted: The reason given for the mute.
getReason() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusNameBanEvent: The reason for the ban.
getReason() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusWarnEvent: The reason for the warning.
getReason() - Method in exception io.github.nucleuspowered.nucleus.api.exceptions.KitRedeemException: The reason supplied by the redeeming system.
getReason() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Inmate: The reason a player was jailed.
getReason() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.MuteInfo: The reason for the mute.
getReason() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Warning: The reason for the warning.
getReasonForBan(String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusNameBanService
getRecipient() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusMailEvent: The recipient of the mail.
getRecipient() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusMessageEvent: The recipient.
getRecipients() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusTextTemplateEvent: Get the recipients to send the message to.
getRedeemedKit() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusKitEvent.Redeem: Gets the kit that has been redeemed.
getRemainingTime() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.TimedEntry: The amount of time remaining before this entry expires, if applicable.
getReplyTo(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Gets the CommandSource that the specified User will reply to if /r is used, if any.
getRotation() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.NamedLocation: Gets the rotation.
getRTPService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusRTPService, if it exists.
getSeenService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusSeenService, if it exists.
getSellPrice(ItemType) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusServerShopService: Gets the sell price of an item (that is, how much a server will buy an item from a player for).
getSellPrice(BlockState) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusServerShopService: Gets the sell price of an item (that is, how much a server will buy an item from a player for).
getSellPrice(ItemStack) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusServerShopService: Gets the sell price of an item (that is, how much a server will buy an item from a player for).
getSellPrice(ItemStackSnapshot) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusServerShopService: Gets the sell price of an item (that is, how much a server will buy an item from a player for).
getSellPrices() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusServerShopService: Gets all the server sell prices.
getSender() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusMailEvent: The sender of the mail.
getSender() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusMessageEvent: The sender.
getSender() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.MailMessage: The sender of the message, or Optional.empty() if it wasn't a player.
getServerLevel() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Gets the social spy level the server is assigned.
getServerShopService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusServerShopService, if it exists.
getSocialSpyLevel(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Gets the social spy level the user is assigned.
getStacks() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Gets the stacks that would be given out by this kit.
getStaffChat() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusStaffChatService: Gets the staff chat message channel.
getStaffChatService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusStaffChatService, if it exists.
getSuffix() - Method in interface io.github.nucleuspowered.nucleus.api.text.NucleusTextTemplate: Gets the static Text this message will be suffixed with, if any.
getTargetEntity() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusTeleportEvent.AboutToTeleport: The Player to be teleported.
getTargetEntity() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusTeleportEvent.Request: The recipient of the request.
getTargetUser() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusChangeNicknameEvent.Post: Deprecated.

The use whose nickname was changed.
getTargetUser() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusChangeNicknameEvent.Pre: Deprecated.

The use whose nickname was changed.
getTargetUser() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusNoteEvent: The subject of the note.
getTargetUser() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusSendToSpawnEvent: The User being spawned.
getTextMessage() - Method in exception io.github.nucleuspowered.nucleus.api.exceptions.NicknameException
getTextTemplate() - Method in interface io.github.nucleuspowered.nucleus.api.text.NucleusTextTemplate: Gets the underlying TextTemplate
getTimeLeft() - Method in exception io.github.nucleuspowered.nucleus.api.exceptions.KitRedeemException.Cooldown
getTimeUntilExpiration() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusWarnEvent.Warned: If applicable, how long until the warning expires.
getTokenParser(PluginContainer) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMessageTokenService: Gets the NucleusMessageTokenService.TokenParser for the specified PluginContainer, if it exists.
getTokenParser(String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMessageTokenService: Gets the NucleusMessageTokenService.TokenParser for the specified plugin id, if it exists.
getToTransform() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusTeleportEvent.AboutToTeleport: Gets the proposed location of the entity that will be teleported.
getTransform() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.NamedLocation: Gets the Transform if the world is loaded.
getTransformTo() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusSendToSpawnEvent: The Transform to send the User to.
getType() - Method in exception io.github.nucleuspowered.nucleus.api.exceptions.NicknameException
getUncategorisedWarps() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Get all warps that have not been given a category.
getUser() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusHomeEvent: Gets the owner of the house
getUser() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Home: Gets the User who owns this home.
getUserData(UUID) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPlayerMetadataService: Gets the user metadata for a player with the specified UUID.
getUserData(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPlayerMetadataService: Gets the user metadata for a player with the specified User.
getUserPreferenceService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusUserPreferenceService service, which allows plugins to read and set user preferences.
getValueClass() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusUserPreferenceService.PreferenceKey: The type of value.
getWarmupManagerService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusWarmupManagerService service, which allows plugins to use Nucleus to manage their warmups.
getWarner() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusWarnEvent.Expired: The UUID of the entity that originally warned the user, or Optional.empty() if the console warned the user.
getWarner() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Warning: The UUID of the player who issued the warning, or Optional.empty() if it was the console.
getWarnings(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarningService: Gets all warnings (active and expired) for a User
getWarningService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusWarningService, if it exists.
getWarp() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusWarpEvent.Delete: Gets the Warp
getWarp() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusWarpEvent.Use: Gets the Warp
getWarp(String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Gets the location for the specified warp.
getWarpCategory(String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Gets the data associated with a warp category.
getWarpNames() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Gets the names of all the warp that are available.
getWarps() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.WarpCategory: Gets the warps associated with this category.
getWarpService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusWarpService, if it exists.
getWarpsForCategory(String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Gets all warps that hae been given the specified category.
getWarpsWithCategories() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Gets all warps that have categories.
getWarpsWithCategories(Predicate<Warp>) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Gets all warps that have categories.
getWorldProperties() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.NamedLocation: Gets the WorldProperties that this location points to, if the world exists.
getWorldUUIDChangeService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI: Gets the NucleusWorldUUIDChangeService service, which allows plugins to check if the admin has created a world UUID mapping.

H

hasPermission(CommandSource, User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusSeenService.SeenInformationProvider: Gets whether the requesting CommandSource has permission to request the provided information for the requested User.
Home - Interface in io.github.nucleuspowered.nucleus.api.nucleusdata: Represents a home in Nucleus.
HOME_COUNT_OPTION - Static variable in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: The name of the permission option that will contain the number of homes a player may have.
HOME_NAME_PATTERN - Static variable in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: The pattern that all home names must follow.

I

ignoresPermission() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Gets whether redeeming this kit will ignore the permission checks.
Inmate - Interface in io.github.nucleuspowered.nucleus.api.nucleusdata: Represents information about a player's jailing.
invalidateCachedPermissions() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusAFKService: Invalidates cached permissions, used to resync a player's exemption status.
INVULNERABLE_CONTEXT - Static variable in interface io.github.nucleuspowered.nucleus.api.service.NucleusInvulnerabilityService: The permission context key that indicates a player is invulnerable.
io.github.nucleuspowered.nucleus.api - package io.github.nucleuspowered.nucleus.api
io.github.nucleuspowered.nucleus.api.annotations - package io.github.nucleuspowered.nucleus.api.annotations
io.github.nucleuspowered.nucleus.api.chat - package io.github.nucleuspowered.nucleus.api.chat
io.github.nucleuspowered.nucleus.api.events - package io.github.nucleuspowered.nucleus.api.events
io.github.nucleuspowered.nucleus.api.exceptions - package io.github.nucleuspowered.nucleus.api.exceptions
io.github.nucleuspowered.nucleus.api.nucleusdata - package io.github.nucleuspowered.nucleus.api.nucleusdata
io.github.nucleuspowered.nucleus.api.rtp - package io.github.nucleuspowered.nucleus.api.rtp
io.github.nucleuspowered.nucleus.api.service - package io.github.nucleuspowered.nucleus.api.service
io.github.nucleuspowered.nucleus.api.text - package io.github.nucleuspowered.nucleus.api.text
io.github.nucleuspowered.nucleus.api.util - package io.github.nucleuspowered.nucleus.api.util
isAFK(Player) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusAFKService: Returns whether a player is AFK
isAutoRedeem() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Gets whether the kit is automatically redeemed on login.
isClearingAll() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusClearInventoryEvent: Gets whether the entire inventory is being cleared, or the MainPlayerInventory only.
isCurrentlyTicking() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.TimedEntry: Denotes whether the timer is currently ticking down (that is, if TimedEntry.getRemainingTime() should be decreasing with each call.
isDisplayMessageOnRedeem() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Gets whether a message is displayed to the player when a kit is redeemed.
isEmpty() - Method in interface io.github.nucleuspowered.nucleus.api.text.NucleusTextTemplate: Whether the text is empty.
isExpired() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Warning: Whether the warning has expired.
isFirstJoinKit() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Returns whether this kit acts like a First Join Kit.
isFrozen(UUID) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusFreezePlayerService: Gets whether a player is frozen.
isFrozen(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusFreezePlayerService: Gets whether a player is frozen.
isHiddenFromList() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Gets whether this kit is hidden from the /kits list (except for those with permission to view it).
isInvulnerable(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusInvulnerabilityService: Returns whether a player is invulnerable as far as Nucleus is concerned.
isLoggingLastLocation(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusBackService: Gets a value indicating whether the user will have their last location logged.
isMuted(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMuteService: Gets whether a User is muted.
isOneTime() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Gets whether the kit is only allowed to be used one time, ever.
isPlayerJailed(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusJailService: Returns whether a subject is jailed.
isRelease() - Method in class io.github.nucleuspowered.nucleus.api.service.NucleusAPIMetaService: Returns whether this is a release version.
isSocialSpy(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Returns whether the user is able to see all private messages sent on the server.
isUsingSocialSpyLevels() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Returns whether the server is using social spy levels.

J

JAIL_CONTEXT - Static variable in interface io.github.nucleuspowered.nucleus.api.service.NucleusJailService: The permission context key that indicates which jail a player is in.
JAILED_CONTEXT - Static variable in interface io.github.nucleuspowered.nucleus.api.service.NucleusJailService: The permission context key that indicates a player is jailed.
jailPlayer(User, String, CommandSource, String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusJailService: Jails a subject if they are not currently jailed.

K

keys() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusUserPreferenceService: Gets the user preference keys available for this user.
Kit - Interface in io.github.nucleuspowered.nucleus.api.nucleusdata: Represents a kit in Nucleus.
KitRedeemException - Exception in io.github.nucleuspowered.nucleus.api.exceptions: Indicates that a kit could not be redeemed.
KitRedeemException(String, KitRedeemException.Reason) - Constructor for exception io.github.nucleuspowered.nucleus.api.exceptions.KitRedeemException
KitRedeemException.Cooldown - Exception in io.github.nucleuspowered.nucleus.api.exceptions
KitRedeemException.PreCancelled - Exception in io.github.nucleuspowered.nucleus.api.exceptions
KitRedeemException.Reason - Enum in io.github.nucleuspowered.nucleus.api.exceptions

L

lastActivity(Player) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusAFKService: Returns the last recorded active moment of the player.

M

MailMessage - Interface in io.github.nucleuspowered.nucleus.api.nucleusdata: Represents a mail message.
major() - Method in class io.github.nucleuspowered.nucleus.api.service.NucleusAPIMetaService: The major component of the version number.
maxHeight() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService.RTPOptions: The maximum height for the RTP.
maxRadius() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService.RTPOptions: The maximum radius for the RTP.
messageReceivingEnabled() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusUserPreferenceService.Keys: If the message module is enabled, gets a preference key that indicates whether the user has is receiving private messages.
MightOccurAsync - Annotation Type in io.github.nucleuspowered.nucleus.api.annotations: Indicates that an event might happen off the main thread.
minHeight() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService.RTPOptions: The minimum height for the RTP.
minor() - Method in class io.github.nucleuspowered.nucleus.api.service.NucleusAPIMetaService: The minor component of the version number.
minRadius() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService.RTPOptions: The minimum radius for the RTP.
modifyHome(Cause, UUID, String, Location<World>, Vector3d) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: Modifies a home's location.
modifyHome(Cause, Home, Location<World>, Vector3d) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: Modifies a home's location.
modifyHome(Cause, User, String, Location<World>, Vector3d) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService
modifyOrCreateHome(Cause, User, String, Location<World>, Vector3d) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: Modifies a home's location, if it exists, otherwise creates a home.
modifyOrCreateHome(Cause, UUID, String, Location<World>, Vector3d) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: Modifies a home's location, if it exists, otherwise creates a home.
ModulesLoadedException - Exception in io.github.nucleuspowered.nucleus.api.exceptions: Exception that indicates that the modules have already been loaded and can no longer be altered.
ModulesLoadedException() - Constructor for exception io.github.nucleuspowered.nucleus.api.exceptions.ModulesLoadedException
MUTED_CONTEXT - Static variable in interface io.github.nucleuspowered.nucleus.api.service.NucleusMuteService: The permission context key that indicates a player is muted.
MuteInfo - Interface in io.github.nucleuspowered.nucleus.api.nucleusdata: Provides information about a player's mute.
mutePlayer(User, String, Duration, Cause) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMuteService: Mutes a player.

N

NamedLocation - Interface in io.github.nucleuspowered.nucleus.api.nucleusdata: Represents a location that has a name attached to it.
NicknameException - Exception in io.github.nucleuspowered.nucleus.api.exceptions
NicknameException(Text, NicknameException.Type) - Constructor for exception io.github.nucleuspowered.nucleus.api.exceptions.NicknameException
NicknameException.Type - Enum in io.github.nucleuspowered.nucleus.api.exceptions
NoExceptionAutoClosable - Interface in io.github.nucleuspowered.nucleus.api.util: A variant of AutoCloseable with no exception to catch
NoModuleException - Exception in io.github.nucleuspowered.nucleus.api.exceptions
NoModuleException() - Constructor for exception io.github.nucleuspowered.nucleus.api.exceptions.NoModuleException
NoSuchLocationException - Exception in io.github.nucleuspowered.nucleus.api.exceptions: Indicates that a location does not exist.
NoSuchLocationException() - Constructor for exception io.github.nucleuspowered.nucleus.api.exceptions.NoSuchLocationException
NoSuchPlayerException - Exception in io.github.nucleuspowered.nucleus.api.exceptions
NoSuchPlayerException() - Constructor for exception io.github.nucleuspowered.nucleus.api.exceptions.NoSuchPlayerException
NoSuchWorldException - Exception in io.github.nucleuspowered.nucleus.api.exceptions
NoSuchWorldException() - Constructor for exception io.github.nucleuspowered.nucleus.api.exceptions.NoSuchWorldException
Note - Interface in io.github.nucleuspowered.nucleus.api.nucleusdata: Represents a note on a user's account.
NucleusAFKEvent - Interface in io.github.nucleuspowered.nucleus.api.events
NucleusAFKEvent.GoingAFK - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a player goes AFK.
NucleusAFKEvent.Kick - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a player is about to be kicked due to inactivity.
NucleusAFKEvent.NotifyCommand - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when the target of a command is AFK and the command is marked as one that should notify the sender.
NucleusAFKEvent.ReturningFromAFK - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a player returns from AFK.
NucleusAFKService - Interface in io.github.nucleuspowered.nucleus.api.service: Allows plugins to see a player's AFK status.
NucleusAPI - Class in io.github.nucleuspowered.nucleus.api: Contains static methods as an alternative way from using the Sponge Service manager.
NucleusAPIMetaService - Class in io.github.nucleuspowered.nucleus.api.service: This service provides information about the API itself.
NucleusAPIMetaService(String, String, boolean) - Constructor for class io.github.nucleuspowered.nucleus.api.service.NucleusAPIMetaService
NucleusAPIMod - Class in io.github.nucleuspowered.nucleus.api
NucleusAPIMod(Logger) - Constructor for class io.github.nucleuspowered.nucleus.api.NucleusAPIMod
NucleusAPITokens - Class in io.github.nucleuspowered.nucleus.api
NucleusBackService - Interface in io.github.nucleuspowered.nucleus.api.service: A service that handles the subject's last location before a warp, that is, the location they will warp to if they run /back.
NucleusBlacklistMigrationService - Interface in io.github.nucleuspowered.nucleus.api.service: Deprecated.
The Blacklist has been removed. Will be removed in a future version of Nucleus.
NucleusBlacklistMigrationService.Result - Interface in io.github.nucleuspowered.nucleus.api.service: Deprecated.
NucleusChangeNicknameEvent - Interface in io.github.nucleuspowered.nucleus.api.events: Deprecated.
Use NucleusChangeNicknameEvent.Pre instead, this will become a common interface to include Post in v2.0.
NucleusChangeNicknameEvent.Post - Interface in io.github.nucleuspowered.nucleus.api.events: Deprecated.
NucleusChangeNicknameEvent.Pre - Interface in io.github.nucleuspowered.nucleus.api.events: Deprecated.
NucleusChatChannel - Interface in io.github.nucleuspowered.nucleus.api.chat: This interface holds chat channels that Nucleus uses.
NucleusChatChannel.ActionMessage - Interface in io.github.nucleuspowered.nucleus.api.chat: Indicates that the channel is a /me message.
NucleusChatChannel.HelpOp - Interface in io.github.nucleuspowered.nucleus.api.chat: Indicates that the channel is a /helpop messages
NucleusChatChannel.StaffChat - Interface in io.github.nucleuspowered.nucleus.api.chat: Indicates that the channel is Staff Chat.
NucleusClearInventoryEvent - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a player's inventory is cleared.
NucleusClearInventoryEvent.Post - Interface in io.github.nucleuspowered.nucleus.api.events: Called when standard inventories have been cleared and should be used to clear other inventories.
NucleusClearInventoryEvent.Pre - Interface in io.github.nucleuspowered.nucleus.api.events: Called before any clearing takes effect.
NucleusException - Exception in io.github.nucleuspowered.nucleus.api.exceptions
NucleusException(Text, NucleusException.ExceptionType) - Constructor for exception io.github.nucleuspowered.nucleus.api.exceptions.NucleusException
NucleusException(Text, Throwable, NucleusException.ExceptionType) - Constructor for exception io.github.nucleuspowered.nucleus.api.exceptions.NucleusException
NucleusException.ExceptionType - Enum in io.github.nucleuspowered.nucleus.api.exceptions
NucleusFirstJoinEvent - Interface in io.github.nucleuspowered.nucleus.api.events: Fired on a player's first time on the server.
NucleusFreezePlayerService - Interface in io.github.nucleuspowered.nucleus.api.service: A service that controls whether a player is frozen.
NucleusHomeEvent - Interface in io.github.nucleuspowered.nucleus.api.events: Events when a player's home changes.
NucleusHomeEvent.Create - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a home is created.
NucleusHomeEvent.Delete - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a home is deleted.
NucleusHomeEvent.Modify - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a home is moved.
NucleusHomeEvent.Use - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a User is warped to a home.
NucleusHomeService - Interface in io.github.nucleuspowered.nucleus.api.service: Provides information about user homes.
NucleusInvulnerabilityService - Interface in io.github.nucleuspowered.nucleus.api.service: A service that handles Nucleus invulnerability
NucleusJailEvent - Interface in io.github.nucleuspowered.nucleus.api.events: Called when a User is jailed or unjailed.
NucleusJailEvent.Jailed - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a player is jailed.
NucleusJailEvent.Unjailed - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a player is unjailed.
NucleusJailService - Interface in io.github.nucleuspowered.nucleus.api.service: A service that handles subject jailing.
NucleusKitEvent - Interface in io.github.nucleuspowered.nucleus.api.events: Events that are related about kits.
NucleusKitEvent.Redeem - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a kit is redeemed.
NucleusKitEvent.Redeem.Failed - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a player's kit could not be updated.
NucleusKitEvent.Redeem.Post - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a player's kit has been updated.
NucleusKitEvent.Redeem.Pre - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a player has redeemed a kit.
NucleusKitService - Interface in io.github.nucleuspowered.nucleus.api.service: A service for getting and setting kits.
NucleusKitService.RedeemResult - Interface in io.github.nucleuspowered.nucleus.api.service: The result for a successful redemption.
NucleusMailEvent - Interface in io.github.nucleuspowered.nucleus.api.events: An event that is posted when a player uses /mail in NucleusPlugin
NucleusMailService - Interface in io.github.nucleuspowered.nucleus.api.service: A service that handles sending and retrieving mail.
NucleusMailService.MailFilter - Interface in io.github.nucleuspowered.nucleus.api.service: This NucleusMailService.MailFilter is simply to prevent compiler warnings with varargs, and is functionally the same as a Predicate
NucleusMessageEvent - Interface in io.github.nucleuspowered.nucleus.api.events: An event that is posted when a player uses /m in NucleusPlugin
NucleusMessageTokenService - Interface in io.github.nucleuspowered.nucleus.api.service: Allows plugins to register their own tokens for use in templated messages, and to obtain NucleusTextTemplate instances.
NucleusMessageTokenService.TokenParser - Interface in io.github.nucleuspowered.nucleus.api.service: A parser for tokens directed at a plugin.
NucleusModuleEvent - Interface in io.github.nucleuspowered.nucleus.api.events: A set of events that fire at various points of the NucleusPlugin lifecycle.
NucleusModuleEvent.AboutToConstruct - Interface in io.github.nucleuspowered.nucleus.api.events: Fired just before modules are loaded.
NucleusModuleEvent.AboutToEnable - Interface in io.github.nucleuspowered.nucleus.api.events: Fires when the Pre-Enable state of a module is about to be fired.
NucleusModuleEvent.Complete - Interface in io.github.nucleuspowered.nucleus.api.events: Fires when all modules have fully loaded and the module loader has nothing more to do.
NucleusModuleEvent.Enabled - Interface in io.github.nucleuspowered.nucleus.api.events: Fires when the Enable state of a module has completed, and the module is declared enabled.
NucleusModuleEvent.ModuleEnableState - Enum in io.github.nucleuspowered.nucleus.api.events
NucleusModuleEvent.PreEnable - Interface in io.github.nucleuspowered.nucleus.api.events: Fires when the Pre-Enable state of a module has completed, but is yet to be declared enabled.
NucleusModuleService - Interface in io.github.nucleuspowered.nucleus.api.service: A service that allows plugins to request certain modules are not loaded.
NucleusMuteEvent - Interface in io.github.nucleuspowered.nucleus.api.events: Events that occur whilst muted.
NucleusMuteEvent.Muted - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a player is muted.
NucleusMuteEvent.Unmuted - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a player is unmuted.
NucleusMuteService - Interface in io.github.nucleuspowered.nucleus.api.service: Provides methods for managing mutes within Nucleus
NucleusNameBanEvent - Interface in io.github.nucleuspowered.nucleus.api.events: An event fired when a name is added or removed from the name ban list.
NucleusNameBanEvent.Banned - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a regular expression is banned.
NucleusNameBanEvent.Unbanned - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a regular expression is unbanned.
NucleusNameBanService - Interface in io.github.nucleuspowered.nucleus.api.service: Created by Daniel on 26/02/2017.
NucleusNicknameService - Interface in io.github.nucleuspowered.nucleus.api.service: Allows plugins to set and inspect a User's current nickname.
NucleusNoFormatChannel - Interface in io.github.nucleuspowered.nucleus.api.chat: This interface is a marker to indicate to the Chat module that messages through this channel might not be formatted.
NucleusNoIgnoreChannel - Interface in io.github.nucleuspowered.nucleus.api.chat: Indicates that the chat channel should not be processed by the ignore module.
NucleusNoteEvent - Interface in io.github.nucleuspowered.nucleus.api.events: Events for when notes are added to users.
NucleusNoteEvent.Created - Interface in io.github.nucleuspowered.nucleus.api.events: Event that is fired when a note is created.
NucleusNoteService - Interface in io.github.nucleuspowered.nucleus.api.service: A service that determines whether a subject has notes.
NucleusPlayerMetadataService - Interface in io.github.nucleuspowered.nucleus.api.service: Retrieves Nucleus and general metadata about a User
NucleusPlayerMetadataService.Result - Interface in io.github.nucleuspowered.nucleus.api.service: Represents the metadata for a player.
NucleusPrivateMessagingService - Interface in io.github.nucleuspowered.nucleus.api.service: A service that contains message related APIs.
NucleusRTPEvent - Interface in io.github.nucleuspowered.nucleus.api.events: Events for RTP
NucleusRTPEvent.SelectedLocation - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when the RTP system has selected a location
NucleusRTPService - Interface in io.github.nucleuspowered.nucleus.api.service: Allows for the customisation of RTP selection routines.
NucleusRTPService.RTPOptions - Interface in io.github.nucleuspowered.nucleus.api.service: The RTP options to pass to the routines
NucleusRTPService.RTPOptions.Builder - Interface in io.github.nucleuspowered.nucleus.api.service
NucleusSeenService - Interface in io.github.nucleuspowered.nucleus.api.service: This service allows plugins to register handlers that will display information when a player runs the /seen command.
NucleusSeenService.SeenInformationProvider - Interface in io.github.nucleuspowered.nucleus.api.service: A NucleusSeenService.SeenInformationProvider object can hook into the seen command and provide extra information on a player.
NucleusSendToSpawnEvent - Interface in io.github.nucleuspowered.nucleus.api.events: Called when Nucleus has been requested to send a User to spawn, either now, or on their next login.
NucleusSendToSpawnEvent.Type - Enum in io.github.nucleuspowered.nucleus.api.events: The type of the spawn event.
NucleusServerShopService - Interface in io.github.nucleuspowered.nucleus.api.service: A service to get the current prices of an item.
NucleusStaffChatService - Interface in io.github.nucleuspowered.nucleus.api.service: Provides a way to get the Staff Chat message channel instance.
NucleusTeleportEvent - Interface in io.github.nucleuspowered.nucleus.api.events: These events are fired before teleportation actually happens.
NucleusTeleportEvent.AboutToTeleport - Interface in io.github.nucleuspowered.nucleus.api.events: Called when a player is about to be teleported through the Nucleus system.
NucleusTeleportEvent.Request - Interface in io.github.nucleuspowered.nucleus.api.events: Indicates that a teleport request (such as through /tpa) is being sent.
NucleusTeleportEvent.Request.CauseToPlayer - Interface in io.github.nucleuspowered.nucleus.api.events: Called when the root cause wants to teleport to the target player (like /tpa).
NucleusTeleportEvent.Request.PlayerToCause - Interface in io.github.nucleuspowered.nucleus.api.events: Called when the root cause wants the target player to teleport to them (like /tpahere).
NucleusTextTemplate - Interface in io.github.nucleuspowered.nucleus.api.text: Represents a wrapped TextTemplate that Nucleus uses to create texts from templates.
NucleusTextTemplateEvent - Interface in io.github.nucleuspowered.nucleus.api.events: Event when messages are sent using NucleusTextTemplates.
NucleusTextTemplateEvent.Broadcast - Interface in io.github.nucleuspowered.nucleus.api.events: Raised when the text being sent originated as a broadcast.
NucleusUserPreferenceService - Interface in io.github.nucleuspowered.nucleus.api.service
NucleusUserPreferenceService.Keys - Interface in io.github.nucleuspowered.nucleus.api.service: Contains NucleusUserPreferenceService.PreferenceKeys
NucleusUserPreferenceService.PreferenceKey<T> - Interface in io.github.nucleuspowered.nucleus.api.service: Represents a NucleusUserPreferenceService.PreferenceKey
NucleusWarmupManagerService - Interface in io.github.nucleuspowered.nucleus.api.service: Manages the warmups.
NucleusWarnEvent - Interface in io.github.nucleuspowered.nucleus.api.events: Events for when players are warned.
NucleusWarnEvent.Expired - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a warning expires.
NucleusWarnEvent.Warned - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a player has been warned.
NucleusWarningService - Interface in io.github.nucleuspowered.nucleus.api.service: A service that allows plugins to obtain information about user warnings.
NucleusWarpEvent - Interface in io.github.nucleuspowered.nucleus.api.events: Events when a server warp changes.
NucleusWarpEvent.Create - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a warp is created.
NucleusWarpEvent.Delete - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a warp is deleted.
NucleusWarpEvent.Use - Interface in io.github.nucleuspowered.nucleus.api.events: Fired when a User tries to teleport to a warp.
NucleusWarpService - Interface in io.github.nucleuspowered.nucleus.api.service: Gets a service that allows users to warp about using defined warp.
NucleusWorldUUIDChangeService - Interface in io.github.nucleuspowered.nucleus.api.service

O

onlinePlayersCanSpyOn(boolean, CommandSource...) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Returns the CommandSources that are online and can spy on all of the specified sources.
onPreInit(GamePreInitializationEvent) - Method in class io.github.nucleuspowered.nucleus.api.NucleusAPIMod
onPreInit(Object) - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPITokens
options() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService: Gets the NucleusRTPService.RTPOptions that contains the current rtp configuration for a default world.
options(WorldProperties) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService: Gets the NucleusRTPService.RTPOptions that contains the current rtp configuration for the specified world.
optionsBuilder() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService: Gets the NucleusRTPService.RTPOptions that contains the current rtp configuration, but in builder format.

P

parse(String, CommandSource, Map<String, Object>) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMessageTokenService.TokenParser: Parses a plugin's token and returns Text, if any.
parseToken(String, CommandSource) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMessageTokenService: Parses a token that might be either a primary token or a standard token.
parseToken(String, CommandSource, Map<String, Object>) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMessageTokenService: Parses a token that might be either a primary token or a standard token.
patch() - Method in class io.github.nucleuspowered.nucleus.api.service.NucleusAPIMetaService: The patch component of the version number.
PluginAlreadyRegisteredException - Exception in io.github.nucleuspowered.nucleus.api.exceptions
PluginAlreadyRegisteredException(PluginContainer) - Constructor for exception io.github.nucleuspowered.nucleus.api.exceptions.PluginAlreadyRegisteredException
possession() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusBlacklistMigrationService.Result: Deprecated.

If true, Nucleus blocked this item type from being possessed.
powertoolsEnabled() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusUserPreferenceService.Keys: 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.
PreCancelled(Text) - Constructor for exception io.github.nucleuspowered.nucleus.api.exceptions.KitRedeemException.PreCancelled
previousInventory() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusKitService.RedeemResult: The player's previous inventory.
prohibitedBiome(BiomeType) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService.RTPOptions.Builder: Adds a BiomeType to the prohibited biomes set.
prohibitedBiomes() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService.RTPOptions: A set of biomes that RTP should not teleport a player into.

R

redeem(Player) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Attempts to redeem this kit, saving it beforehand.
redeemKit(Kit, Player, boolean) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusKitService: Redeems a kit on a player.
redeemKit(Kit, Player, boolean, boolean) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusKitService: Redeems a kit on a player.
redeemKitCommands(Player) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Redeems the commands in the kit, without redeeming the items.
register(PluginContainer, NucleusMessageTokenService.TokenParser) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMessageTokenService: Registers a NucleusMessageTokenService.TokenParser for the specified PluginContainer.
register(Object, NucleusSeenService.SeenInformationProvider) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusSeenService: Registers a NucleusSeenService.SeenInformationProvider with Nucleus.
register(Object, Predicate<CommandSource>, BiFunction<CommandSource, User, Collection<Text>>) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusSeenService: Registers a NucleusSeenService.SeenInformationProvider with Nucleus that can be constructed using a functional programming style.
registerKernel(RTPKernel) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService: Registers a kernel for use in Nucleus.
registerMessageTarget(UUID, String, Text, Supplier<T>) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Registers a message target.
registerPrimaryToken(String, PluginContainer, String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMessageTokenService: A primary token is a token that does not have a plugin identifier - such as {{prefix}}.
registerTokenFormat(String, String, String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMessageTokenService: Allows users to register additional token delimiter formats.
rejected() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusKitService.RedeemResult: The items that didn't make it into the inventory.
removeHome(Cause, UUID, String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: Removes a home.
removeHome(Cause, Home) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusHomeService: Removes a home.
removeJail(String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusJailService: Removes a jail location from the list.
removeKit(String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusKitService: Removes the requested kit.
removeLastLocation(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusBackService: Removes the last location from the subject, so that /back will not work for them.
removeMail(User, MailMessage) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMailService: Removes a specific mail for a specific player.
removeModule(String, Object) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusModuleService: Removes a module from NucleusPlugin programmatically, so plugins can override the behaviour if required.
removeName(String, Cause) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusNameBanService
removeNickname(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusNicknameService: Removes the nickname for the specified user.
removeNote(User, Note) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusNoteService: Removes a note from a subject.
removePreferenceFor(User, NucleusUserPreferenceService.PreferenceKey<?>) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusUserPreferenceService: Removes a preference associated with a user, reverting it to a default value as determined by the consumer of the preference (which will usually take the value of NucleusUserPreferenceService.PreferenceKey.getDefaultValue(), if any is supplied).
removePrefix() - Method in interface io.github.nucleuspowered.nucleus.api.chat.NucleusNoFormatChannel: Determines whether Nucleus should remove the prefix from the message.
removeWarmup(UUID) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarmupManagerService: Removes a user's warmup.
removeWarp(String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Removes a warp.
removeWarpCost(String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Removes the cost of a warp.
renameKit(String, String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusKitService: Renames a kit.
reset() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService.RTPOptions.Builder: Resets this builder to the default state.
RTPKernel - Interface in io.github.nucleuspowered.nucleus.api.rtp: An RTPKernel provides the instructions for how to select a location when using RTP.
RTPKernels - Class in io.github.nucleuspowered.nucleus.api.rtp: Nucleus supplied RTPKernels.

S

save() - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Saves this current kit's state.
saveKit(String, Kit) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusKitService: Deprecated.
kitName is now ignored.
saveKit(Kit) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusKitService: Saves a kit.
semanticVersion() - Method in class io.github.nucleuspowered.nucleus.api.service.NucleusAPIMetaService: The version of the Nucleus API this is, or will be, if this is a snapshot.
sendMail(User, User, String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMailService: Sends mail to a subject, addressed from another subject.
sendMailFromConsole(User, String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMailService: Sends mail to a player, addressed from the console.
sendMessage(CommandSource, CommandSource, String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Sends a message as the sender to the receiver.
sendToAll() - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusTextTemplateEvent.Broadcast: Resets the the broadcast to the original recipients - all players
setAFK(Cause, Player, boolean) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusAFKService: Sets a player's AFK status, if the player can go AFK.
setAutoRedeem(boolean) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Sets whether the kit is automatically redeemed on login.
setCancelMessage(Text) - Method in interface io.github.nucleuspowered.nucleus.api.events.CancelMessage: The message to display to the user if the event is cancelled, or null to clear.
setCancelReason(String) - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusSendToSpawnEvent: If cancelled, the reason to return to the requestee.
setChannel(MessageChannel) - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusAFKEvent: Sets the message channel to send the message to
setCommands(List<String>) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Sets the commands associated with this kit.
setCommandSourceReplyTo(T, CommandSource) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Sets the CommandSource that the specified CommandSource will reply to if /r is used.
setConsoleReplyTo(CommandSource) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Sets the CommandSource that the console will reply to if /r is used.
setCooldown(Duration) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Sets the cooldown time for the kit.
setCost(double) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Set the cost for this kit.
setDisplayMessageOnRedeem(boolean) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Sets whether a message is displayed to the player when a kit is redeemed.
setFirstJoinKit(boolean) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Sets whether this kit will be redeemed on first join.
setFrozen(UUID, boolean) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusFreezePlayerService: Sets whether a player is frozen.
setFrozen(User, boolean) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusFreezePlayerService: Sets whether a player is frozen.
setHiddenFromList(boolean) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Sets whether this kit is hidden from /kits
setIgnoresPermission(boolean) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Sets whether redeeming this kit ignores permission checks.
setInterval(Duration) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Deprecated.
Use Kit.setCooldown(Duration) instead.
setInvulnerable(User, boolean) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusInvulnerabilityService: Sets whether a player is invulnerable as far as Nucleus is concerned.
setJail(String, Location<World>, Vector3d) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusJailService: Sets a jail location in the world.
setLastLocation(User, Transform<World>) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusBackService: Sets the location that the subject will be warped to if they execute /back
setLoggingLastLocation(User, boolean) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusBackService: Sets whether the user will have their last location logged.
setMaxHeight(int) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService.RTPOptions.Builder: Sets the maximum height for the RTP.
setMaxRadius(int) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService.RTPOptions.Builder: Sets the maximum radius for the RTP.
setMessage(Text) - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusAFKEvent.NotifyCommand: Sets the message to send to the command invoker, if any.
setMessage(Text) - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusAFKEvent: Sets the message to send to players, if any.
setMessage(NucleusTextTemplate) - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusTextTemplateEvent: Sets the message to send to the users NucleusTextTemplateEvent.getRecipients()
setMessage(String) - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusTextTemplateEvent: Attempts to set the NucleusTextTemplate message using a string.
setMinHeight(int) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService.RTPOptions.Builder: Sets the minimum height for the RTP.
setMinRadius(int) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusRTPService.RTPOptions.Builder: Sets the minimum radius for the RTP.
setNickname(User, Text) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusNicknameService: Sets a user's nickname.
setNickname(User, Text, boolean) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusNicknameService: Sets a user's nickname.
setOneTime(boolean) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Sets whether the kit is only allowed to be used one time, ever.
setPreferenceFor(User, NucleusUserPreferenceService.PreferenceKey<T>, T) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusUserPreferenceService: Sets the preference associated with the NucleusUserPreferenceService.PreferenceKey for the supplied User.
setRecipients(Collection<? extends CommandSource>) - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusTextTemplateEvent: Set the recipients to send the message to.
setReplyTo(User, CommandSource) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Sets the CommandSource that the specified User will reply to if /r is used.
setSocialSpy(User, boolean) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusPrivateMessagingService: Sets whether the user is able to see all private messages on the server.
setStacks(List<ItemStackSnapshot>) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Set the stacks that would be given out by this kit.
setTransformTo(Transform<World>) - Method in interface io.github.nucleuspowered.nucleus.api.events.NucleusSendToSpawnEvent: The Transform to redirect the User to.
setWarp(String, Location<World>, Vector3d) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Sets a warp, will not overwrite current warp.
setWarpCategory(String, String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Sets a warp's category
setWarpCategoryDescription(String, Text) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Sets the description of a warp category.
setWarpCategoryDisplayName(String, Text) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Sets the display name of a warp category.
setWarpCost(String, double) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Sets the cost of a warp.
setWarpDescription(String, Text) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Sets a warp's description.
SHOULD_FORMAT_CHANNEL - Static variable in class io.github.nucleuspowered.nucleus.api.EventContexts.Identifiers: ID for EventContexts.SHOULD_FORMAT_CHANNEL
SHOULD_FORMAT_CHANNEL - Static variable in class io.github.nucleuspowered.nucleus.api.EventContexts: A context that indicates whether the Nucleus chat events will perform its own formatting.
socialSpyEnabled() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusUserPreferenceService.Keys: If the message module is enabled, gets a preference key that indicates whether the user has enabled social spy.
SPAWN_EVENT_TYPE - Static variable in class io.github.nucleuspowered.nucleus.api.EventContexts.Identifiers: ID for EventContexts.SPAWN_EVENT_TYPE
SPAWN_EVENT_TYPE - Static variable in class io.github.nucleuspowered.nucleus.api.EventContexts: A context that indicates the source of the Nucleus redirectable spawn events.
SURFACE_ONLY - Static variable in class io.github.nucleuspowered.nucleus.api.rtp.RTPKernels: The default Nucleus RTP kernel, adjusted to ensure locations are surface only.

T

teleportTarget() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusUserPreferenceService.Keys: If the teleport module is enabled, gets a preference key that indicates whether the user allows players to teleport to them.
TimedEntry - Interface in io.github.nucleuspowered.nucleus.api.nucleusdata: Indicates that there might be a time limit on this entry.
timeForInactivity(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusAFKService: Returns how long the specified User has to be inactive before going AFK.
timeForKick(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusAFKService: Returns how long the specified User has to be inactive before being kicked.
timeSinceLastActivity(Player) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusAFKService: Returns the Duration since last recorded active moment of the player.

U

unjailPlayer(User) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusJailService: Unjails a subject if they are currently jailed.
unmutePlayer(User, Cause) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMuteService: Unmutes a player.
unregister(PluginContainer) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusMessageTokenService: Unregisters the NucleusMessageTokenService.TokenParser for a plugin.
UnremovableModuleException - Class in io.github.nucleuspowered.nucleus.api.exceptions
UnremovableModuleException() - Constructor for class io.github.nucleuspowered.nucleus.api.exceptions.UnremovableModuleException
updateActivityForUser(Player) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusAFKService: Forces an activity tracking update for a Player, such that Nucleus thinks that the player has recently been active and resets their AFK timer.
updateKitInventory(Inventory) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Convenience method for updating the kit with the contents of the player's inventory.
updateKitInventory(Player) - Method in interface io.github.nucleuspowered.nucleus.api.nucleusdata.Kit: Convenience method for updating the kit with the contents of the player's inventory.
use() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusBlacklistMigrationService.Result: Deprecated.

If true, Nucleus blocked this item type from being used.

V

valueOf(String) - Static method in enum io.github.nucleuspowered.nucleus.api.events.NucleusModuleEvent.ModuleEnableState: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.nucleuspowered.nucleus.api.events.NucleusSendToSpawnEvent.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.nucleuspowered.nucleus.api.exceptions.KitRedeemException.Reason: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.nucleuspowered.nucleus.api.exceptions.NicknameException.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.nucleuspowered.nucleus.api.exceptions.NucleusException.ExceptionType: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.github.nucleuspowered.nucleus.api.events.NucleusModuleEvent.ModuleEnableState: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.nucleuspowered.nucleus.api.events.NucleusSendToSpawnEvent.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.nucleuspowered.nucleus.api.exceptions.KitRedeemException.Reason: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.nucleuspowered.nucleus.api.exceptions.NicknameException.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.nucleuspowered.nucleus.api.exceptions.NucleusException.ExceptionType: Returns an array containing the constants of this enum type, in the order they are declared.
vanishOnLogin() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusUserPreferenceService.Keys: If the vanish module is enabled, gets a preference key that indicates whether the user will vanish on login.
version() - Method in class io.github.nucleuspowered.nucleus.api.service.NucleusAPIMetaService: The version of the Nucleus API this is.
viewStaffChat() - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusUserPreferenceService.Keys: If the staff chat module is enabled, gets a preference key that indicates whether the user is receiving messages on the staff chat channel.

W

Warning - Interface in io.github.nucleuspowered.nucleus.api.nucleusdata: Information about a player's warning.
Warp - Interface in io.github.nucleuspowered.nucleus.api.nucleusdata: Represents a warp.
WarpCategory - Interface in io.github.nucleuspowered.nucleus.api.nucleusdata: Defines a warp category.
warpExists(String) - Method in interface io.github.nucleuspowered.nucleus.api.service.NucleusWarpService: Gets whether a warp exists.

A B C D E F G H I J K L M N O P R S T U V W