- getAfk() - Method in interface io.github.nucleuspowered.nucleus.api.module.afk.NucleusAFKService
-
Returns a collection of players who are currently AFK.
- getAFKService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getAllWarps() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.NucleusWarpService
-
Gets all the warps available.
- getAuthor() - Method in interface io.github.nucleuspowered.nucleus.api.module.note.event.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
-
- getBody(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
.
- getBody(CommandSource, 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
.
- getBody(CommandSource, Map<String, Function<CommandSource, Optional<Text>>>) - 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
.
- getCancelMessage() - Method in interface io.github.nucleuspowered.nucleus.api.util.CancelMessageEvent
-
The message to send to the player if the event is cancelled, if any.
- getCategory() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.data.Warp
-
Gets the category for this warp, if it exists.
- getChannel() - Method in interface io.github.nucleuspowered.nucleus.api.module.afk.event.NucleusAFKEvent
-
Gets the channel to send the message to
- getCommands() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.Kit
-
Gets the commands associated with this kit.
- getCommandSourceReplyTo(T) - Method in interface io.github.nucleuspowered.nucleus.api.module.message.NucleusPrivateMessagingService
-
Gets the CommandSource
that the specified T
will reply to if /r
is used, if any.
- getCommandsToExecute() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.event.NucleusKitEvent.Redeem
-
Gets the commands that the kit will run, if a plugin has set them.
- getConsoleReplyTo() - Method in interface io.github.nucleuspowered.nucleus.api.module.message.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.core.exception.PluginAlreadyRegisteredException
-
The PluginContainer
that could not be registered.
- getCooldown() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.Kit
-
Gets the cooldown time for the kit.
- getCooldownDuration() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.KitRedeemResult
-
- getCooldownExpiry() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.KitRedeemResult
-
Specifies when the next redemption opportunity is.
- getCooldownExpiry(Kit, User) - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.NucleusKitService
-
If a
Player
is unable to redeem the given
Kit
as
they have previously redeemed it and that the cooldown has not
expired, will return the
Instant
the
User
may
redeem the kit again.
- getCost() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.Kit
-
The cost for claiming the kit.
- getCost() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.data.Warp
-
Gets the cost of this warp, if the warp has a cost.
- getCreationInstant() - Method in interface io.github.nucleuspowered.nucleus.api.module.jail.data.Jailing
-
Gets the Instant
this inmate was jailed, if this information was recorded.
- getCreationInstant() - Method in interface io.github.nucleuspowered.nucleus.api.module.mute.data.Mute
-
Gets the Instant
this player was muted, if this information was recorded.
- getCustomTargetLevel() - Method in interface io.github.nucleuspowered.nucleus.api.module.message.NucleusPrivateMessagingService
-
- getDate() - Method in interface io.github.nucleuspowered.nucleus.api.module.mail.data.MailMessage
-
The time the message was sent.
- getDate() - Method in interface io.github.nucleuspowered.nucleus.api.module.note.data.Note
-
The Instant
the note was placed.
- getDate() - Method in interface io.github.nucleuspowered.nucleus.api.module.note.event.NucleusNoteEvent
-
Gets the Instant
the note was created.
- getDate() - Method in interface io.github.nucleuspowered.nucleus.api.module.warning.data.Warning
-
Deprecated.
When the warning was issued.
- getDefaultKernel() - Method in interface io.github.nucleuspowered.nucleus.api.module.rtp.NucleusRTPService
-
Gets the
RTPKernel
that Nucleus' RTP will use.
- getDefaultValue() - Method in interface io.github.nucleuspowered.nucleus.api.core.NucleusUserPreferenceService.PreferenceKey
-
The default value for a preference, if any.
- getDescription(NucleusUserPreferenceService.PreferenceKey<?>) - Method in interface io.github.nucleuspowered.nucleus.api.core.NucleusUserPreferenceService
-
The description of the preference.
- getDescription() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.data.Warp
-
Gets the description for the warp.
- getDescription() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.data.WarpCategory
-
Gets the defined description of the category, if available.
- getDisplayName() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.data.WarpCategory
-
Gets the display name of the category.
- getDuration() - Method in interface io.github.nucleuspowered.nucleus.api.module.jail.event.NucleusJailEvent.Jailed
-
How long the player is jailed for.
- getDuration() - Method in interface io.github.nucleuspowered.nucleus.api.module.mute.event.NucleusMuteEvent.Muted
-
Gets the duration of the mute, if any.
- getEntry() - Method in interface io.github.nucleuspowered.nucleus.api.module.nameban.event.NucleusNameBanEvent
-
The entry that was affected.
- 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, 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>>>) - 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
-
- getHome() - Method in interface io.github.nucleuspowered.nucleus.api.module.home.event.NucleusHomeEvent.Delete
-
Gets the existing home.
- getHome() - Method in interface io.github.nucleuspowered.nucleus.api.module.home.event.NucleusHomeEvent.Modify
-
Gets the existing home.
- getHome() - Method in interface io.github.nucleuspowered.nucleus.api.module.home.event.NucleusHomeEvent.Use
-
Gets the existing home.
- getHome(UUID, String) - Method in interface io.github.nucleuspowered.nucleus.api.module.home.NucleusHomeService
-
Gets a specified home of the user, if it exists.
- getHome(User, String) - Method in interface io.github.nucleuspowered.nucleus.api.module.home.NucleusHomeService
-
- getHomeCount(UUID) - Method in interface io.github.nucleuspowered.nucleus.api.module.home.NucleusHomeService
-
Gets the number of homes the player currently has.
- getHomeCount(User) - Method in interface io.github.nucleuspowered.nucleus.api.module.home.NucleusHomeService
-
Gets the number of homes the player currently has.
- getHomes(UUID) - Method in interface io.github.nucleuspowered.nucleus.api.module.home.NucleusHomeService
-
Gets the
Home
s for the specified user, identified by their UUID.
- getHomes(User) - Method in interface io.github.nucleuspowered.nucleus.api.module.home.NucleusHomeService
-
Gets the
Home
s for the specified user, identified by their UUID.
- getHomeService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getID() - Method in interface io.github.nucleuspowered.nucleus.api.core.NucleusUserPreferenceService.PreferenceKey
-
The ID of the key.
- getId() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.data.WarpCategory
-
Gets the ID of the category.
- getInformation(CommandSource, User) - Method in interface io.github.nucleuspowered.nucleus.api.module.playerinfo.NucleusSeenService.SeenInformationProvider
-
Gets the information to display to the CommandSource
about the User
- getInterval() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.Kit
-
- getInvulnerabilityService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getItemsForPlayer(Player) - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.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.module.kit.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.module.jail.NucleusJailService
-
Gets the location of a jail, if it exists.
- getJailer() - Method in interface io.github.nucleuspowered.nucleus.api.module.jail.data.Jailing
-
The UUID
of the jailer, or Optional.empty()
if it was the console.
- getJailName() - Method in interface io.github.nucleuspowered.nucleus.api.module.jail.data.Jailing
-
The jail the player is jailed in.
- getJailName() - Method in interface io.github.nucleuspowered.nucleus.api.module.jail.event.NucleusJailEvent.Jailed
-
The name of the jail the player is sent to.
- getJails() - Method in interface io.github.nucleuspowered.nucleus.api.module.jail.NucleusJailService
-
Gets the name of the jails on the server.
- getJailService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getKernel(WorldProperties) - Method in interface io.github.nucleuspowered.nucleus.api.module.rtp.NucleusRTPService
-
Gets the default
RTPKernel
used when executing
a random teleport
- getKernel(String) - Method in interface io.github.nucleuspowered.nucleus.api.module.rtp.NucleusRTPService
-
Gets the default
RTPKernel
used when executing
a random teleport
- getKit(String) - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.NucleusKitService
-
Gets the requested kit if it exists.
- getKitNames() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.NucleusKitService
-
Gets the names of all the kits currently in NucleusPlugin.
- getKitService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getLastIP() - Method in interface io.github.nucleuspowered.nucleus.api.core.NucleusPlayerMetadataService.Result
-
Gets the last known IP address of the user.
- getLastLocation() - Method in interface io.github.nucleuspowered.nucleus.api.core.NucleusPlayerMetadataService.Result
-
Gets the last known location of the user.
- getLastLocation(User) - Method in interface io.github.nucleuspowered.nucleus.api.module.back.NucleusBackService
-
Gets the location of the subject before they executed the last warp that was marked as Returnable.
- getLastLogin() - Method in interface io.github.nucleuspowered.nucleus.api.core.NucleusPlayerMetadataService.Result
-
The Instant
that the player last logged in.
- getLastLogout() - Method in interface io.github.nucleuspowered.nucleus.api.core.NucleusPlayerMetadataService.Result
-
The Instant
that the player last logged out.
- getLastRedeemedTime() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.event.NucleusKitEvent.Redeem
-
Gets the last time the kit was redeemed, if any.
- getLocation() - Method in interface io.github.nucleuspowered.nucleus.api.module.home.event.NucleusHomeEvent
-
Gets the Location
of the home.
- getLocation() - Method in interface io.github.nucleuspowered.nucleus.api.module.rtp.event.NucleusRTPEvent.SelectedLocation
-
Gets the proposed location
- getLocation(Location<World>, World, NucleusRTPService.RTPOptions) - Method in interface io.github.nucleuspowered.nucleus.api.module.rtp.kernel.RTPKernel
-
Gets a new location.
- getLocation(Location<World>, World, NucleusRTPService.RTPOptions) - Method in interface io.github.nucleuspowered.nucleus.api.module.rtp.NucleusRTPService
-
- getLocation() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.event.NucleusWarpEvent.Create
-
Gets the proposed Location
of the warp.
- getLocation() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.event.NucleusWarpEvent.Delete
-
Gets the Location
of the warp.
- getLocation() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.event.NucleusWarpEvent.Use
-
Gets the Location
of the warp.
- getLocation() - Method in interface io.github.nucleuspowered.nucleus.api.util.data.NamedLocation
-
Gets the Location
if the world is loaded.
- getMail(User, NucleusMailService.MailFilter...) - Method in interface io.github.nucleuspowered.nucleus.api.module.mail.NucleusMailService
-
Gets mail for a specific player, optionally including a list of filters.
- getMailService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getMappedUUID(UUID) - Method in interface io.github.nucleuspowered.nucleus.api.core.NucleusWorldUUIDChangeService
-
Gets the new UUID
as specified in the config file.
- getMaximumHomes(UUID) - Method in interface io.github.nucleuspowered.nucleus.api.module.home.NucleusHomeService
-
Returns the maximum number of homes the player can have.
- getMaximumHomes(User) - Method in interface io.github.nucleuspowered.nucleus.api.module.home.NucleusHomeService
-
Returns the maximum number of homes the player can have.
- getMessage() - Method in interface io.github.nucleuspowered.nucleus.api.module.afk.event.NucleusAFKEvent
-
Gets the message to send to players
- getMessage() - Method in interface io.github.nucleuspowered.nucleus.api.module.afk.event.NucleusAFKEvent.NotifyCommand
-
Gets the message to send to the command invoker
- getMessage() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.KitRedeemResult
-
If the redemption was cancelled by an event, gets the associated message.
- getMessage() - Method in interface io.github.nucleuspowered.nucleus.api.module.mail.data.MailMessage
-
The message that was sent.
- getMessage() - Method in interface io.github.nucleuspowered.nucleus.api.module.mail.event.NucleusMailEvent
-
The message that was sent.
- getMessage() - Method in interface io.github.nucleuspowered.nucleus.api.module.message.event.NucleusMessageEvent
-
The message that was sent.
- getMessage() - Method in interface io.github.nucleuspowered.nucleus.api.text.event.NucleusTextTemplateEvent
-
- getMessageFor(CommandSource) - Method in interface io.github.nucleuspowered.nucleus.api.text.event.NucleusTextTemplateEvent
-
Gets the message that would be sent to the specified
CommandSource
.
- 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.core.event.NucleusModuleEvent
-
- getMuter() - Method in interface io.github.nucleuspowered.nucleus.api.module.mute.data.Mute
-
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
-
- getName() - Method in interface io.github.nucleuspowered.nucleus.api.module.home.event.NucleusHomeEvent
-
Gets the name of the home.
- getName() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.Kit
-
Gets the name of the kit.
- getName() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.event.NucleusKitEvent.Redeem
-
Gets the name of the kit.
- getName() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.event.NucleusWarpEvent
-
Get the name of the warp.
- getName() - Method in interface io.github.nucleuspowered.nucleus.api.util.data.NamedLocation
-
Gets the name of the location.
- getNameBanService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getNickname() - Method in interface io.github.nucleuspowered.nucleus.api.module.nickname.event.NucleusChangeNicknameEvent
-
- getNickname(User) - Method in interface io.github.nucleuspowered.nucleus.api.module.nickname.NucleusNicknameService
-
Gets the current nickname for a user, if it exists.
- getNickname(UUID) - Method in interface io.github.nucleuspowered.nucleus.api.module.nickname.NucleusNicknameService
-
Gets the current nickname for a user, if it exists.
- getNicknameService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getNicknameWithPrefix(UUID) - Method in interface io.github.nucleuspowered.nucleus.api.module.nickname.NucleusNicknameService
-
Gets the current nickname for a user with a given UUID
,
including the prefix, if it exists.
- getNicknameWithPrefix(User) - Method in interface io.github.nucleuspowered.nucleus.api.module.nickname.NucleusNicknameService
-
Gets the current nickname for a user with prefix, if it exists.
- getNote() - Method in interface io.github.nucleuspowered.nucleus.api.module.note.data.Note
-
The contents of the note.
- getNote() - Method in interface io.github.nucleuspowered.nucleus.api.module.note.event.NucleusNoteEvent
-
The note.
- getNoter() - Method in interface io.github.nucleuspowered.nucleus.api.module.note.data.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.module.note.NucleusNoteService
-
Gets all notes for a specific user
- getNoteService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getOriginalChannel() - Method in interface io.github.nucleuspowered.nucleus.api.module.afk.event.NucleusAFKEvent
-
Gets the original message channel to send the message to
- getOriginalCommandsToExecute() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.event.NucleusKitEvent.Redeem
-
Gets the commands that the kit will run.
- getOriginalLocation() - Method in interface io.github.nucleuspowered.nucleus.api.module.home.event.NucleusHomeEvent.Modify
-
Gets the original Location
of the home.
- getOriginalMessage() - Method in interface io.github.nucleuspowered.nucleus.api.module.afk.event.NucleusAFKEvent
-
Gets the original message that would have been sent to players, if any.
- getOriginalMessage() - Method in interface io.github.nucleuspowered.nucleus.api.module.afk.event.NucleusAFKEvent.NotifyCommand
-
Gets the original message that would have been sent to players, if any.
- getOriginalMessage() - Method in interface io.github.nucleuspowered.nucleus.api.text.event.NucleusTextTemplateEvent
-
- getOriginalRecipients() - Method in interface io.github.nucleuspowered.nucleus.api.text.event.NucleusTextTemplateEvent
-
Get the original recipients to send the message to.
- getOriginalStacksToRedeem() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.event.NucleusKitEvent.Redeem
-
Gets the ItemStackSnapshot
s that the kit contains.
- getOriginalTransformTo() - Method in interface io.github.nucleuspowered.nucleus.api.module.spawn.event.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.module.home.data.Home
-
The UUID
of the user.
- getParser(String) - Method in interface io.github.nucleuspowered.nucleus.api.placeholder.NucleusPlaceholderService
-
Gets the parser associated with the provided token name, if any,
prefixing un-namespaced tokens with the Nucleus prefix.
- getPlaceholderService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getPlayerJailData(User) - Method in interface io.github.nucleuspowered.nucleus.api.module.jail.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.module.mute.NucleusMuteService
-
Gets the
Mute
about a player.
- getPosition() - Method in interface io.github.nucleuspowered.nucleus.api.util.data.NamedLocation
-
Gets the position.
- getPreferenceFor(User, NucleusUserPreferenceService.PreferenceKey<T>) - Method in interface io.github.nucleuspowered.nucleus.api.core.NucleusUserPreferenceService
-
- 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.module.jail.data.Jailing
-
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.module.nickname.event.NucleusChangeNicknameEvent
-
- getPrivateMessagingService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getReason() - Method in exception io.github.nucleuspowered.nucleus.api.module.home.exception.HomeException
-
- getReason() - Method in interface io.github.nucleuspowered.nucleus.api.module.jail.data.Jailing
-
The reason a player was jailed.
- getReason() - Method in interface io.github.nucleuspowered.nucleus.api.module.jail.event.NucleusJailEvent.Jailed
-
The reason for the jailing.
- getReason() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.event.NucleusKitEvent.Redeem.Failed
-
Gets the KitRedeemResult.Status
that will be thrown by the routine.
- getReason() - Method in interface io.github.nucleuspowered.nucleus.api.module.mute.data.Mute
-
The reason for the mute.
- getReason() - Method in interface io.github.nucleuspowered.nucleus.api.module.mute.event.NucleusMuteEvent.Muted
-
The reason given for the mute.
- getReason() - Method in interface io.github.nucleuspowered.nucleus.api.module.nameban.event.NucleusNameBanEvent
-
The reason for the ban.
- getReason() - Method in exception io.github.nucleuspowered.nucleus.api.module.nameban.exception.NameBanException
-
- getReason() - Method in interface io.github.nucleuspowered.nucleus.api.module.warning.data.Warning
-
Deprecated.
The reason for the warning.
- getReasonForBan(String) - Method in interface io.github.nucleuspowered.nucleus.api.module.nameban.NucleusNameBanService
-
If a name is banned, returns the reason.
- getRecipient() - Method in interface io.github.nucleuspowered.nucleus.api.module.mail.event.NucleusMailEvent
-
The recipient of the mail.
- getRecipient() - Method in interface io.github.nucleuspowered.nucleus.api.module.message.event.NucleusMessageEvent
-
The recipient.
- getRecipients() - Method in interface io.github.nucleuspowered.nucleus.api.text.event.NucleusTextTemplateEvent
-
Get the recipients to send the message to.
- getRedeemedKit() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.event.NucleusKitEvent.Redeem
-
Gets the kit that has been redeemed.
- getRemainingTime() - Method in interface io.github.nucleuspowered.nucleus.api.util.data.TimedEntry
-
The amount of time remaining before this entry expires, if applicable.
- getReplyTo(User) - Method in interface io.github.nucleuspowered.nucleus.api.module.message.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.util.data.NamedLocation
-
Gets the rotation.
- getRTPService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getSafeLocation(Location<World>, TeleportScanner, TeleportHelperFilter, TeleportHelperFilter...) - Method in interface io.github.nucleuspowered.nucleus.api.teleport.NucleusSafeTeleportService
-
Find a safe location around the given location, subject to the
given
TeleportScanner
or
TeleportHelperFilter
.
- getSafeTransform(Location<World>, Vector3d, TeleportScanner, TeleportHelperFilter, TeleportHelperFilter...) - Method in interface io.github.nucleuspowered.nucleus.api.teleport.NucleusSafeTeleportService
-
Find a safe location around the given location, subject to the
given
TeleportScanner
or
TeleportHelperFilter
.
- getSeenService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getSender() - Method in interface io.github.nucleuspowered.nucleus.api.module.mail.data.MailMessage
-
The sender of the message, or Optional.empty()
if it wasn't a player.
- getSender() - Method in interface io.github.nucleuspowered.nucleus.api.module.mail.event.NucleusMailEvent
-
The sender of the mail.
- getSender() - Method in interface io.github.nucleuspowered.nucleus.api.module.message.event.NucleusMessageEvent
-
The sender.
- getServerLevel() - Method in interface io.github.nucleuspowered.nucleus.api.module.message.NucleusPrivateMessagingService
-
Gets the social spy level the server is assigned.
- getSocialSpyLevel(User) - Method in interface io.github.nucleuspowered.nucleus.api.module.message.NucleusPrivateMessagingService
-
Gets the social spy level the user is assigned.
- getStacks() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.Kit
-
Gets the stacks that would be given out by this kit.
- getStacksToRedeem() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.event.NucleusKitEvent.Redeem
-
Gets the ItemStackSnapshot
s that will be redeemed, if a
plugin has altered it.
- getStaffChannelMembers() - Method in interface io.github.nucleuspowered.nucleus.api.module.staffchat.NucleusStaffChatService
-
Gets the memebers of the Staff Chat channel.
- getStaffChatService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getStatus() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.KitRedeemResult
-
Gets the status of this result.
- 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.teleport.event.NucleusTeleportEvent.AboutToTeleport
-
The Player
to be teleported.
- getTargetEntity() - Method in interface io.github.nucleuspowered.nucleus.api.teleport.event.NucleusTeleportEvent.Request
-
The recipient of the request.
- getTargetUser() - Method in interface io.github.nucleuspowered.nucleus.api.module.note.event.NucleusNoteEvent
-
The subject of the note.
- getTargetUser() - Method in interface io.github.nucleuspowered.nucleus.api.module.spawn.event.NucleusSendToSpawnEvent
-
The User
being spawned.
- getTextMessage() - Method in exception io.github.nucleuspowered.nucleus.api.module.nickname.exception.NicknameException
-
- getTextTemplate() - Method in interface io.github.nucleuspowered.nucleus.api.text.NucleusTextTemplate
-
Gets the underlying TextTemplate
- getTextTemplateFactory() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getToTransform() - Method in interface io.github.nucleuspowered.nucleus.api.teleport.event.NucleusTeleportEvent.AboutToTeleport
-
Gets the proposed location of the entity that will be teleported.
- getTransform() - Method in interface io.github.nucleuspowered.nucleus.api.util.data.NamedLocation
-
Gets the Transform
if the world is loaded.
- getTransformTo() - Method in interface io.github.nucleuspowered.nucleus.api.module.spawn.event.NucleusSendToSpawnEvent
-
The Transform
to send the User
to.
- getType() - Method in exception io.github.nucleuspowered.nucleus.api.module.nickname.exception.NicknameException
-
- getUncategorisedWarps() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.NucleusWarpService
-
Get all warps that have not been given a category.
- getUser() - Method in interface io.github.nucleuspowered.nucleus.api.module.home.data.Home
-
Gets the User
who owns this home.
- getUser() - Method in interface io.github.nucleuspowered.nucleus.api.module.home.event.NucleusHomeEvent
-
Gets the owner of the house
- getUser() - Method in interface io.github.nucleuspowered.nucleus.api.module.nickname.event.NucleusChangeNicknameEvent
-
The user whose nickname was changed.
- getUserData(UUID) - Method in interface io.github.nucleuspowered.nucleus.api.core.NucleusPlayerMetadataService
-
Gets the user metadata for a player with the specified UUID.
- getUserData(User) - Method in interface io.github.nucleuspowered.nucleus.api.core.NucleusPlayerMetadataService
-
Gets the user metadata for a player with the specified User
.
- getUserPreferenceService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getValueClass() - Method in interface io.github.nucleuspowered.nucleus.api.core.NucleusUserPreferenceService.PreferenceKey
-
The type of value.
- getWarmupManagerService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getWarner() - Method in interface io.github.nucleuspowered.nucleus.api.module.warning.data.Warning
-
Deprecated.
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.module.warning.NucleusWarningService
-
Deprecated.
- getWarningService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getWarp() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.event.NucleusWarpEvent.Delete
-
- getWarp() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.event.NucleusWarpEvent.Use
-
- getWarp(String) - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.NucleusWarpService
-
Gets the location for the specified warp.
- getWarpCategory(String) - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.NucleusWarpService
-
Gets the data associated with a warp category.
- getWarpNames() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.NucleusWarpService
-
Gets the names of all the warp that are available.
- getWarps() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.data.WarpCategory
-
Gets the warps associated with this category.
- getWarpService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- getWarpsForCategory(String) - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.NucleusWarpService
-
Gets all warps that hae been given the specified category.
- getWarpsWithCategories() - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.NucleusWarpService
-
Gets all warps that have categories.
- getWarpsWithCategories(Predicate<Warp>) - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.NucleusWarpService
-
Gets all warps that have categories.
- getWorldProperties() - Method in interface io.github.nucleuspowered.nucleus.api.util.data.NamedLocation
-
Gets the WorldProperties
that this location points to, if the world exists.
- getWorldUUID() - Method in interface io.github.nucleuspowered.nucleus.api.util.data.NamedLocation
-
Gets the world UUID
that this location targets
- getWorldUUIDChangeService() - Static method in class io.github.nucleuspowered.nucleus.api.NucleusAPI
-
- NameBanException - Exception in io.github.nucleuspowered.nucleus.api.module.nameban.exception
-
- NameBanException(Text, NameBanException.Reason) - Constructor for exception io.github.nucleuspowered.nucleus.api.module.nameban.exception.NameBanException
-
- NameBanException.Reason - Enum in io.github.nucleuspowered.nucleus.api.module.nameban.exception
-
- NamedLocation - Interface in io.github.nucleuspowered.nucleus.api.util.data
-
Represents a location that has a name attached to it.
- NicknameException - Exception in io.github.nucleuspowered.nucleus.api.module.nickname.exception
-
- NicknameException(Text, NicknameException.Type) - Constructor for exception io.github.nucleuspowered.nucleus.api.module.nickname.exception.NicknameException
-
- NicknameException.Type - Enum in io.github.nucleuspowered.nucleus.api.module.nickname.exception
-
- NO_CHECK - Static variable in class io.github.nucleuspowered.nucleus.api.teleport.data.NucleusTeleportHelperFilters
-
Returns the location that is passed into the filter.
- NO_SCAN - Static variable in class io.github.nucleuspowered.nucleus.api.teleport.data.TeleportScanners
-
- 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.core.exception
-
- NoModuleException() - Constructor for exception io.github.nucleuspowered.nucleus.api.core.exception.NoModuleException
-
- NoSuchLocationException - Exception in io.github.nucleuspowered.nucleus.api.core.exception
-
Indicates that a location does not exist.
- NoSuchLocationException() - Constructor for exception io.github.nucleuspowered.nucleus.api.core.exception.NoSuchLocationException
-
- NoSuchPlayerException - Exception in io.github.nucleuspowered.nucleus.api.core.exception
-
- NoSuchPlayerException() - Constructor for exception io.github.nucleuspowered.nucleus.api.core.exception.NoSuchPlayerException
-
- NoSuchWorldException - Exception in io.github.nucleuspowered.nucleus.api.core.exception
-
- NoSuchWorldException() - Constructor for exception io.github.nucleuspowered.nucleus.api.core.exception.NoSuchWorldException
-
- Note - Interface in io.github.nucleuspowered.nucleus.api.module.note.data
-
Represents a note on a user's account.
- NucleusAFKEvent - Interface in io.github.nucleuspowered.nucleus.api.module.afk.event
-
- NucleusAFKEvent.GoingAFK - Interface in io.github.nucleuspowered.nucleus.api.module.afk.event
-
Fired when a player goes AFK.
- NucleusAFKEvent.Kick - Interface in io.github.nucleuspowered.nucleus.api.module.afk.event
-
Fired when a player is about to be kicked due to inactivity.
- NucleusAFKEvent.NotifyCommand - Interface in io.github.nucleuspowered.nucleus.api.module.afk.event
-
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.module.afk.event
-
Fired when a player returns from AFK.
- NucleusAFKService - Interface in io.github.nucleuspowered.nucleus.api.module.afk
-
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.core
-
This service provides information about the API itself.
- NucleusAPIMetaService(String) - Constructor for class io.github.nucleuspowered.nucleus.api.core.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.module.back
-
A service that handles the subject's last location before a warp, that is, the location they will warp to if they
run /back.
- NucleusChangeNicknameEvent - Interface in io.github.nucleuspowered.nucleus.api.module.nickname.event
-
Fired when a player requests or deletes a nickname.
- NucleusChangeNicknameEvent.Post - Interface in io.github.nucleuspowered.nucleus.api.module.nickname.event
-
- NucleusChangeNicknameEvent.Pre - Interface in io.github.nucleuspowered.nucleus.api.module.nickname.event
-
- NucleusClearInventoryEvent - Interface in io.github.nucleuspowered.nucleus.api.module.inventory
-
Fired when a player's inventory is cleared.
- NucleusClearInventoryEvent.Post - Interface in io.github.nucleuspowered.nucleus.api.module.inventory
-
Called when standard inventories have been cleared and should be used to clear other
inventories.
- NucleusClearInventoryEvent.Pre - Interface in io.github.nucleuspowered.nucleus.api.module.inventory
-
Called before any clearing takes effect.
- NucleusFirstJoinEvent - Interface in io.github.nucleuspowered.nucleus.api.core.event
-
Fired on a player's first time on the server.
- NucleusFreezePlayerService - Interface in io.github.nucleuspowered.nucleus.api.module.freezeplayer
-
A service that controls whether a player is frozen.
- NucleusHomeEvent - Interface in io.github.nucleuspowered.nucleus.api.module.home.event
-
Events when a player's home changes.
- NucleusHomeEvent.Create - Interface in io.github.nucleuspowered.nucleus.api.module.home.event
-
Fired when a home is created.
- NucleusHomeEvent.Delete - Interface in io.github.nucleuspowered.nucleus.api.module.home.event
-
Fired when a home is deleted.
- NucleusHomeEvent.Modify - Interface in io.github.nucleuspowered.nucleus.api.module.home.event
-
Fired when a home is moved.
- NucleusHomeEvent.Use - Interface in io.github.nucleuspowered.nucleus.api.module.home.event
-
Fired when a User
is warped to a home.
- NucleusHomeService - Interface in io.github.nucleuspowered.nucleus.api.module.home
-
Provides information about user homes.
- NucleusInvulnerabilityService - Interface in io.github.nucleuspowered.nucleus.api.module.invulnerability
-
A service that handles Nucleus invulnerability
- NucleusJailEvent - Interface in io.github.nucleuspowered.nucleus.api.module.jail.event
-
Called when a User
is jailed or unjailed.
- NucleusJailEvent.Jailed - Interface in io.github.nucleuspowered.nucleus.api.module.jail.event
-
Fired when a player is jailed.
- NucleusJailEvent.Unjailed - Interface in io.github.nucleuspowered.nucleus.api.module.jail.event
-
Fired when a player is unjailed.
- NucleusJailService - Interface in io.github.nucleuspowered.nucleus.api.module.jail
-
A service that handles subject jailing.
- NucleusKitEvent - Interface in io.github.nucleuspowered.nucleus.api.module.kit.event
-
Events that are related about kits.
- NucleusKitEvent.Redeem - Interface in io.github.nucleuspowered.nucleus.api.module.kit.event
-
Fired when a kit is redeemed.
- NucleusKitEvent.Redeem.Failed - Interface in io.github.nucleuspowered.nucleus.api.module.kit.event
-
Fired when a player's kit could not be updated.
- NucleusKitEvent.Redeem.Post - Interface in io.github.nucleuspowered.nucleus.api.module.kit.event
-
Fired when a player's kit has been updated.
- NucleusKitEvent.Redeem.Pre - Interface in io.github.nucleuspowered.nucleus.api.module.kit.event
-
Fired when a player is redeeming a kit.
- NucleusKitService - Interface in io.github.nucleuspowered.nucleus.api.module.kit
-
A service for getting and setting kits.
- NucleusMailEvent - Interface in io.github.nucleuspowered.nucleus.api.module.mail.event
-
An event that is posted when a player uses /mail in NucleusPlugin
- NucleusMailService - Interface in io.github.nucleuspowered.nucleus.api.module.mail
-
A service that handles sending and retrieving mail.
- NucleusMailService.MailFilter - Interface in io.github.nucleuspowered.nucleus.api.module.mail
-
- NucleusMessageEvent - Interface in io.github.nucleuspowered.nucleus.api.module.message.event
-
An event that is posted when a player sends a private message.
- NucleusModuleEvent - Interface in io.github.nucleuspowered.nucleus.api.core.event
-
A set of events that fire at various points of the NucleusPlugin lifecycle.
- NucleusModuleEvent.AboutToConstruct - Interface in io.github.nucleuspowered.nucleus.api.core.event
-
Fired just before modules are loaded.
- NucleusModuleEvent.AboutToEnable - Interface in io.github.nucleuspowered.nucleus.api.core.event
-
Fires when the Pre-Enable state of a module is about to be fired.
- NucleusModuleEvent.Complete - Interface in io.github.nucleuspowered.nucleus.api.core.event
-
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.core.event
-
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.core.event
-
- NucleusModuleEvent.PreEnable - Interface in io.github.nucleuspowered.nucleus.api.core.event
-
Fires when the Pre-Enable state of a module has completed, but is yet to be declared enabled.
- NucleusMuteEvent - Interface in io.github.nucleuspowered.nucleus.api.module.mute.event
-
Events that occur whilst muted.
- NucleusMuteEvent.Muted - Interface in io.github.nucleuspowered.nucleus.api.module.mute.event
-
Fired when a player is muted.
- NucleusMuteEvent.Unmuted - Interface in io.github.nucleuspowered.nucleus.api.module.mute.event
-
Fired when a player is unmuted.
- NucleusMuteService - Interface in io.github.nucleuspowered.nucleus.api.module.mute
-
Provides methods for managing mutes within Nucleus
- NucleusNameBanEvent - Interface in io.github.nucleuspowered.nucleus.api.module.nameban.event
-
An event fired when a name is added or removed from the name ban list.
- NucleusNameBanEvent.Banned - Interface in io.github.nucleuspowered.nucleus.api.module.nameban.event
-
Fired when a regular expression is banned.
- NucleusNameBanEvent.Unbanned - Interface in io.github.nucleuspowered.nucleus.api.module.nameban.event
-
Fired when a regular expression is unbanned.
- NucleusNameBanService - Interface in io.github.nucleuspowered.nucleus.api.module.nameban
-
Manages player names that are prohibited from joining a server.
- NucleusNicknameService - Interface in io.github.nucleuspowered.nucleus.api.module.nickname
-
Allows plugins to set and inspect a User
's current nickname.
- NucleusNoteEvent - Interface in io.github.nucleuspowered.nucleus.api.module.note.event
-
Events for when notes are added to users.
- NucleusNoteEvent.Created - Interface in io.github.nucleuspowered.nucleus.api.module.note.event
-
Event that is fired when a note is created.
- NucleusNoteService - Interface in io.github.nucleuspowered.nucleus.api.module.note
-
A service that determines whether a subject has notes.
- NucleusPlaceholderService - Interface in io.github.nucleuspowered.nucleus.api.placeholder
-
Provides a way to determine how Nucleus uses placeholders.
- NucleusPlayerMetadataService - Interface in io.github.nucleuspowered.nucleus.api.core
-
Retrieves Nucleus and general metadata about a User
- NucleusPlayerMetadataService.Result - Interface in io.github.nucleuspowered.nucleus.api.core
-
Represents the metadata for a player.
- NucleusPrivateMessagingService - Interface in io.github.nucleuspowered.nucleus.api.module.message
-
A service that contains message related APIs.
- NucleusRTPEvent - Interface in io.github.nucleuspowered.nucleus.api.module.rtp.event
-
Events for RTP
- NucleusRTPEvent.SelectedLocation - Interface in io.github.nucleuspowered.nucleus.api.module.rtp.event
-
Fired when the RTP system has selected a location
- NucleusRTPService - Interface in io.github.nucleuspowered.nucleus.api.module.rtp
-
Allows for the customisation of RTP selection routines.
- NucleusRTPService.RTPOptions - Interface in io.github.nucleuspowered.nucleus.api.module.rtp
-
The RTP options to pass to the routines
- NucleusRTPService.RTPOptions.Builder - Interface in io.github.nucleuspowered.nucleus.api.module.rtp
-
- NucleusSafeTeleportService - Interface in io.github.nucleuspowered.nucleus.api.teleport
-
Contains routines that support Nucleus safe teleports
- NucleusSeenService - Interface in io.github.nucleuspowered.nucleus.api.module.playerinfo
-
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.module.playerinfo
-
- NucleusSendToSpawnEvent - Interface in io.github.nucleuspowered.nucleus.api.module.spawn.event
-
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.module.spawn.event
-
The type of the spawn event.
- NucleusStaffChatChannel - Interface in io.github.nucleuspowered.nucleus.api.module.staffchat
-
Indicates that the chat event is a staff chat message.
- NucleusStaffChatService - Interface in io.github.nucleuspowered.nucleus.api.module.staffchat
-
Provides a way to get the Staff Chat message channel instance.
- NucleusTeleportEvent - Interface in io.github.nucleuspowered.nucleus.api.teleport.event
-
These events are fired before teleportation actually happens.
- NucleusTeleportEvent.AboutToTeleport - Interface in io.github.nucleuspowered.nucleus.api.teleport.event
-
Called when a player is about to be teleported through the Nucleus system.
- NucleusTeleportEvent.Request - Interface in io.github.nucleuspowered.nucleus.api.teleport.event
-
Indicates that a teleport request (such as through /tpa
) is being sent.
- NucleusTeleportEvent.Request.CauseToPlayer - Interface in io.github.nucleuspowered.nucleus.api.teleport.event
-
Called when the root cause wants to teleport to the target player (like /tpa).
- NucleusTeleportEvent.Request.PlayerToCause - Interface in io.github.nucleuspowered.nucleus.api.teleport.event
-
Called when the root cause wants the target player to teleport to them (like /tpahere).
- NucleusTeleportHelperFilters - Class in io.github.nucleuspowered.nucleus.api.teleport.data
-
Do not access before Pre-Init
- NucleusTeleportHelperFilters() - Constructor for class io.github.nucleuspowered.nucleus.api.teleport.data.NucleusTeleportHelperFilters
-
- 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.text.event
-
- NucleusTextTemplateEvent.Broadcast - Interface in io.github.nucleuspowered.nucleus.api.text.event
-
Raised when the text being sent originated as a broadcast.
- NucleusTextTemplateFactory - Interface in io.github.nucleuspowered.nucleus.api.text
-
- NucleusUserPreferenceService - Interface in io.github.nucleuspowered.nucleus.api.core
-
- NucleusUserPreferenceService.Keys - Interface in io.github.nucleuspowered.nucleus.api.core
-
- NucleusUserPreferenceService.PreferenceKey<T> - Interface in io.github.nucleuspowered.nucleus.api.core
-
- NucleusWarmupManagerService - Interface in io.github.nucleuspowered.nucleus.api.core
-
Manages the warmups.
- NucleusWarmupManagerService.WarmupTask - Interface in io.github.nucleuspowered.nucleus.api.core
-
Represents a task that will execute after some time.
- NucleusWarningService - Interface in io.github.nucleuspowered.nucleus.api.module.warning
-
Deprecated.
- NucleusWarpEvent - Interface in io.github.nucleuspowered.nucleus.api.module.warp.event
-
Events when a server warp changes.
- NucleusWarpEvent.Create - Interface in io.github.nucleuspowered.nucleus.api.module.warp.event
-
Fired when a warp is created.
- NucleusWarpEvent.Delete - Interface in io.github.nucleuspowered.nucleus.api.module.warp.event
-
Fired when a warp is deleted.
- NucleusWarpEvent.Use - Interface in io.github.nucleuspowered.nucleus.api.module.warp.event
-
Fired when a User
tries to teleport to a warp.
- NucleusWarpService - Interface in io.github.nucleuspowered.nucleus.api.module.warp
-
Gets a service that allows users to warp about using defined warp.
- NucleusWorldUUIDChangeService - Interface in io.github.nucleuspowered.nucleus.api.core
-
Gets the specified world UUID
mapping.
- save() - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.Kit
-
Saves this current kit's state.
- saveKit(Kit) - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.NucleusKitService
-
Saves a kit.
- scanFrom(World, Vector3i, TeleportHelperFilter, TeleportHelperFilter...) - Method in interface io.github.nucleuspowered.nucleus.api.teleport.data.TeleportScanner
-
- scanFrom(World, Vector3i, int, int, int, TeleportHelperFilter, TeleportHelperFilter...) - Method in interface io.github.nucleuspowered.nucleus.api.teleport.data.TeleportScanner
-
- semanticVersion() - Method in class io.github.nucleuspowered.nucleus.api.core.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.module.mail.NucleusMailService
-
Sends mail to a subject, addressed from another subject.
- sendMailFromConsole(User, String) - Method in interface io.github.nucleuspowered.nucleus.api.module.mail.NucleusMailService
-
Sends mail to a player, addressed from the console.
- sendMessage(CommandSource, CommandSource, String) - Method in interface io.github.nucleuspowered.nucleus.api.module.message.NucleusPrivateMessagingService
-
Sends a message as the sender to the receiver.
- sendMessageFrom(CommandSource, Text) - Method in interface io.github.nucleuspowered.nucleus.api.module.staffchat.NucleusStaffChatService
-
Sends a message to the Staff Chat channel.
- sendToAll() - Method in interface io.github.nucleuspowered.nucleus.api.text.event.NucleusTextTemplateEvent.Broadcast
-
Resets the the broadcast to the original recipients - all players
- setAFK(Cause, Player, boolean) - Method in interface io.github.nucleuspowered.nucleus.api.module.afk.NucleusAFKService
-
Sets a player's AFK status, if the player can go AFK.
- setAutoRedeem(boolean) - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.Kit
-
Sets whether the kit is automatically redeemed on login.
- setCancelMessage(Text) - Method in interface io.github.nucleuspowered.nucleus.api.util.CancelMessageEvent
-
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.module.spawn.event.NucleusSendToSpawnEvent
-
If cancelled, the reason to return to the requestee.
- setChannel(MessageChannel) - Method in interface io.github.nucleuspowered.nucleus.api.module.afk.event.NucleusAFKEvent
-
Sets the message channel to send the message to
- setCommands(List<String>) - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.Kit
-
Sets the commands associated with this kit.
- setCommandSourceReplyTo(T, CommandSource) - Method in interface io.github.nucleuspowered.nucleus.api.module.message.NucleusPrivateMessagingService
-
Sets the CommandSource
that the specified CommandSource
will reply to if /r
is used.
- setCommandsToExecute(Collection<String>) - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.event.NucleusKitEvent.Redeem.Pre
-
Override the commands run by this kit for this redemption only.
- setConsoleReplyTo(CommandSource) - Method in interface io.github.nucleuspowered.nucleus.api.module.message.NucleusPrivateMessagingService
-
Sets the CommandSource
that the console will reply to if /r
is used.
- setCooldown(Duration) - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.Kit
-
Sets the cooldown time for the kit.
- setCost(double) - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.Kit
-
Set the cost for this kit.
- setDisplayMessageOnRedeem(boolean) - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.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.module.kit.data.Kit
-
Sets whether this kit will be redeemed on first join.
- setFrozen(UUID, boolean) - Method in interface io.github.nucleuspowered.nucleus.api.module.freezeplayer.NucleusFreezePlayerService
-
Sets whether a player is frozen.
- setFrozen(User, boolean) - Method in interface io.github.nucleuspowered.nucleus.api.module.freezeplayer.NucleusFreezePlayerService
-
Sets whether a player is frozen.
- setHiddenFromList(boolean) - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.Kit
-
Sets whether this kit is hidden from /kits
- setIgnoresPermission(boolean) - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.Kit
-
Sets whether redeeming this kit ignores permission checks.
- setInterval(Duration) - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.Kit
-
- setInvulnerable(User, boolean) - Method in interface io.github.nucleuspowered.nucleus.api.module.invulnerability.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.module.jail.NucleusJailService
-
Sets a jail location in the world.
- setLastLocation(User, Transform<World>) - Method in interface io.github.nucleuspowered.nucleus.api.module.back.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.module.back.NucleusBackService
-
Sets whether the user will have their last location logged.
- setMaxHeight(int) - Method in interface io.github.nucleuspowered.nucleus.api.module.rtp.NucleusRTPService.RTPOptions.Builder
-
Sets the maximum height for the RTP.
- setMaxRadius(int) - Method in interface io.github.nucleuspowered.nucleus.api.module.rtp.NucleusRTPService.RTPOptions.Builder
-
Sets the maximum radius for the RTP.
- setMessage(Text) - Method in interface io.github.nucleuspowered.nucleus.api.module.afk.event.NucleusAFKEvent.NotifyCommand
-
Sets the message to send to the command invoker, if any.
- setMessage(Text) - Method in interface io.github.nucleuspowered.nucleus.api.module.afk.event.NucleusAFKEvent
-
Sets the message to send to players, if any.
- setMessage(NucleusTextTemplate) - Method in interface io.github.nucleuspowered.nucleus.api.text.event.NucleusTextTemplateEvent
-
- setMessage(String) - Method in interface io.github.nucleuspowered.nucleus.api.text.event.NucleusTextTemplateEvent
-
Attempts to set the NucleusTextTemplate message using a string.
- setMinHeight(int) - Method in interface io.github.nucleuspowered.nucleus.api.module.rtp.NucleusRTPService.RTPOptions.Builder
-
Sets the minimum height for the RTP.
- setMinRadius(int) - Method in interface io.github.nucleuspowered.nucleus.api.module.rtp.NucleusRTPService.RTPOptions.Builder
-
Sets the minimum radius for the RTP.
- setNickname(User, Text) - Method in interface io.github.nucleuspowered.nucleus.api.module.nickname.NucleusNicknameService
-
Sets a user's nickname.
- setNickname(User, Text, boolean) - Method in interface io.github.nucleuspowered.nucleus.api.module.nickname.NucleusNicknameService
-
Sets a user's nickname.
- setOneTime(boolean) - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.data.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.core.NucleusUserPreferenceService
-
- setRecipients(Collection<? extends CommandSource>) - Method in interface io.github.nucleuspowered.nucleus.api.text.event.NucleusTextTemplateEvent
-
Set the recipients to send the message to.
- setReplyTo(User, CommandSource) - Method in interface io.github.nucleuspowered.nucleus.api.module.message.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.module.message.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.module.kit.data.Kit
-
Set the stacks that would be given out by this kit.
- setStacksToRedeem(Collection<ItemStackSnapshot>) - Method in interface io.github.nucleuspowered.nucleus.api.module.kit.event.NucleusKitEvent.Redeem.Pre
-
Override the content of the kit for this redemption only.
- setTransformTo(Transform<World>) - Method in interface io.github.nucleuspowered.nucleus.api.module.spawn.event.NucleusSendToSpawnEvent
-
The Transform
to redirect the User
to.
- setWarp(String, Location<World>, Vector3d) - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.NucleusWarpService
-
Sets a warp, will not overwrite current warp.
- setWarpCategory(String, String) - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.NucleusWarpService
-
Sets a warp's category
- setWarpCategoryDescription(String, Text) - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.NucleusWarpService
-
Sets the description of a warp category.
- setWarpCategoryDisplayName(String, Text) - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.NucleusWarpService
-
Sets the display name of a warp category.
- setWarpCost(String, double) - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.NucleusWarpService
-
Sets the cost of a warp.
- setWarpDescription(String, Text) - Method in interface io.github.nucleuspowered.nucleus.api.module.warp.NucleusWarpService
-
Sets a warp's description.
- SHOULD_FORMAT_CHANNEL - Static variable in class io.github.nucleuspowered.nucleus.api.EventContexts.Identifiers
-
- 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.core.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
-
- 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.
- supply(Class<T>, String) - Static method in class io.github.nucleuspowered.nucleus.api.util.RegistrySupplier
-
Gets a Supplier
- SURFACE_ONLY - Static variable in class io.github.nucleuspowered.nucleus.api.module.rtp.kernel.RTPKernels.Identifiers
-
- SURFACE_ONLY - Static variable in class io.github.nucleuspowered.nucleus.api.module.rtp.kernel.RTPKernels
-
The default Nucleus RTP kernel, adjusted to ensure locations are surface only.