NucleusAPI (nucleus-api 2.4.0 API)

java.lang.Object
- io.github.nucleuspowered.nucleus.api.NucleusAPI

```
public class NucleusAPI
extends java.lang.Object
```
Contains static methods as an alternative way from using the Sponge Service manager.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.util.Optional<NucleusAFKService>`	`getAFKService()` Gets the `NucleusAFKService`, if it exists.
`static java.util.Optional<NucleusBackService>`	`getBackService()` Gets the `NucleusBackService`, if it exists.
`static java.util.Optional<NucleusFreezePlayerService>`	`getFreezePlayerService()` Gets the `NucleusFreezePlayerService`, if it exists.
`static java.util.Optional<NucleusHomeService>`	`getHomeService()` Gets the `NucleusHomeService`, if it exists.
`static java.util.Optional<NucleusInvulnerabilityService>`	`getInvulnerabilityService()` Gets the `NucleusInvulnerabilityService`, if it exists.
`static java.util.Optional<NucleusJailService>`	`getJailService()` Gets the `NucleusJailService`, if it exists.
`static java.util.Optional<NucleusKitService>`	`getKitService()` Gets the `NucleusKitService`, if it exists.
`static java.util.Optional<NucleusMailService>`	`getMailService()` Gets the `NucleusMailService`, if it exists.
`static NucleusAPIMetaService`	`getMetaService()` Gets the API Meta service, which contains the version information.
`static java.util.Optional<NucleusMuteService>`	`getMuteService()` Gets the `NucleusMuteService`, if it exists.
`static java.util.Optional<NucleusNameBanService>`	`getNameBanService()` Gets the `NucleusNameBanService`, if it exists.
`static java.util.Optional<NucleusNicknameService>`	`getNicknameService()` Gets the `NucleusNicknameService`, if it exists.
`static java.util.Optional<NucleusNoteService>`	`getNoteService()` Gets the `NucleusNoteService`, if it exists.
`static NucleusPlaceholderService`	`getPlaceholderService()` Gets the `NucleusPlaceholderService` service, which allows plugins to register message placeholders.
`static NucleusPlayerMetadataService`	`getPlayerMetadataService()` Gets the API Player Metadata service, which contains the player metadata information.
`static java.util.Optional<NucleusPrivateMessagingService>`	`getPrivateMessagingService()` Gets the `NucleusPrivateMessagingService`, if it exists.
`static java.util.Optional<NucleusRTPService>`	`getRTPService()` Gets the `NucleusRTPService`, if it exists.
`static java.util.Optional<NucleusSeenService>`	`getSeenService()` Gets the `NucleusSeenService`, if it exists.
`static java.util.Optional<NucleusStaffChatService>`	`getStaffChatService()` Gets the `NucleusStaffChatService`, if it exists.
`static NucleusTextTemplateFactory`	`getTextTemplateFactory()` Gets the `NucleusTextTemplateFactory` service, which allows plugins to create `NucleusTextTemplate`s.
`static NucleusUserPreferenceService`	`getUserPreferenceService()` Gets the `NucleusUserPreferenceService` service, which allows plugins to read and set user preferences.
`static NucleusWarmupManagerService`	`getWarmupManagerService()` Gets the `NucleusWarmupManagerService` service, which allows plugins to use Nucleus to manage their warmups.
`static java.util.Optional<NucleusWarningService>`	`getWarningService()` Gets the `NucleusWarningService`, if it exists.
`static java.util.Optional<NucleusWarpService>`	`getWarpService()` Gets the `NucleusWarpService`, if it exists.
`static NucleusWorldUUIDChangeService`	`getWorldUUIDChangeService()` Gets the `NucleusWorldUUIDChangeService` service, which allows plugins to check if the admin has created a world UUID mapping.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getMetaService
```
public static NucleusAPIMetaService getMetaService()
```
    Gets the API Meta service, which contains the version information.
    
    Returns:
    
    The NucleusAPIMetaService
    
    Throws:
    
    java.lang.IllegalStateException - if Nucleus hasn't completed pre init yet.
  - getPlayerMetadataService
```
public static NucleusPlayerMetadataService getPlayerMetadataService()
```
    Gets the API Player Metadata service, which contains the player metadata information.
    
    Returns:
    
    The NucleusPlayerMetadataService
    
    Throws:
    
    java.lang.IllegalStateException - if Nucleus hasn't completed post init yet.
  - getWarmupManagerService
```
public static NucleusWarmupManagerService getWarmupManagerService()
```
    Gets the NucleusWarmupManagerService service, which allows plugins to use Nucleus to manage their warmups.
    
    Returns:
    
    The NucleusWarmupManagerService
    
    Throws:
    
    java.lang.IllegalStateException - if Nucleus hasn't completed pre init yet.
  - getPlaceholderService
```
public static NucleusPlaceholderService getPlaceholderService()
```
    Gets the NucleusPlaceholderService service, which allows plugins to register message placeholders.
    
    Returns:
    
    The NucleusPlaceholderService
    
    Throws:
    
    java.lang.IllegalStateException - if Nucleus hasn't completed pre init yet.
  - getTextTemplateFactory
```
public static NucleusTextTemplateFactory getTextTemplateFactory()
```
    Gets the NucleusTextTemplateFactory service, which allows plugins to create NucleusTextTemplates.
    
    Returns:
    
    The NucleusTextTemplateFactory
    
    Throws:
    
    java.lang.IllegalStateException - if Nucleus hasn't completed pre init yet.
  - getWorldUUIDChangeService
```
public static NucleusWorldUUIDChangeService getWorldUUIDChangeService()
```
    Gets the NucleusWorldUUIDChangeService service, which allows plugins to check if the admin has created a world UUID mapping.
    For proper verification, this will not contain any mappings until after the GameStartingServerEvent on default ordering
    
    Returns:
    
    The NucleusWorldUUIDChangeService
    
    Throws:
    
    java.lang.IllegalStateException - if Nucleus hasn't completed postinit.
  - getUserPreferenceService
```
public static NucleusUserPreferenceService getUserPreferenceService()
```
    Gets the NucleusUserPreferenceService service, which allows plugins to read and set user preferences.
    
    Returns:
    
    The NucleusUserPreferenceService
    
    Throws:
    
    java.lang.IllegalStateException - if Nucleus hasn't completed pre init yet.
  - getAFKService
```
public static java.util.Optional<NucleusAFKService> getAFKService()
```
    Gets the NucleusAFKService, if it exists.
    Requires the "afk" module.
    
    Returns:
    
    The NucleusAFKService
  - getBackService
```
public static java.util.Optional<NucleusBackService> getBackService()
```
    Gets the NucleusBackService, if it exists.
    Requires the "back" module.
    
    Returns:
    
    The NucleusBackService
  - getFreezePlayerService
```
public static java.util.Optional<NucleusFreezePlayerService> getFreezePlayerService()
```
    Gets the NucleusFreezePlayerService, if it exists.
    Requires the "freeze-player" module.
    
    Returns:
    
    The NucleusFreezePlayerService
  - getHomeService
```
public static java.util.Optional<NucleusHomeService> getHomeService()
```
    Gets the NucleusHomeService, if it exists.
    Requires the "home" module.
    
    Returns:
    
    The NucleusHomeService
  - getInvulnerabilityService
```
public static java.util.Optional<NucleusInvulnerabilityService> getInvulnerabilityService()
```
    Gets the NucleusInvulnerabilityService, if it exists.
    Requires the "misc" module.
    
    Returns:
    
    The NucleusInvulnerabilityService
  - getJailService
```
public static java.util.Optional<NucleusJailService> getJailService()
```
    Gets the NucleusJailService, if it exists.
    Requires the "jail" module.
    
    Returns:
    
    The NucleusJailService
  - getKitService
```
public static java.util.Optional<NucleusKitService> getKitService()
```
    Gets the NucleusKitService, if it exists.
    Requires the "kit" module.
    
    Returns:
    
    The NucleusKitService
  - getMailService
```
public static java.util.Optional<NucleusMailService> getMailService()
```
    Gets the NucleusMailService, if it exists.
    Requires the "mail" module.
    
    Returns:
    
    The NucleusMailService
  - getMuteService
```
public static java.util.Optional<NucleusMuteService> getMuteService()
```
    Gets the NucleusMuteService, if it exists.
    Requires the "mute" module.
    
    Returns:
    
    The NucleusMuteService
  - getNameBanService
```
public static java.util.Optional<NucleusNameBanService> getNameBanService()
```
    Gets the NucleusNameBanService, if it exists.
    Requires the "nameban" module.
    
    Returns:
    
    The NucleusNameBanService
  - getNicknameService
```
public static java.util.Optional<NucleusNicknameService> getNicknameService()
```
    Gets the NucleusNicknameService, if it exists.
    Requires the "nickname" module.
    
    Returns:
    
    The NucleusNicknameService
  - getNoteService
```
public static java.util.Optional<NucleusNoteService> getNoteService()
```
    Gets the NucleusNoteService, if it exists.
    Requires the "note" module.
    
    Returns:
    
    The NucleusNoteService
  - getPrivateMessagingService
```
public static java.util.Optional<NucleusPrivateMessagingService> getPrivateMessagingService()
```
    Gets the NucleusPrivateMessagingService, if it exists.
    Requires the "message" module.
    
    Returns:
    
    The NucleusPrivateMessagingService
  - getRTPService
```
public static java.util.Optional<NucleusRTPService> getRTPService()
```
    Gets the NucleusRTPService, if it exists.
    Requires the "rtp" module.
    
    Returns:
    
    The NucleusRTPService
  - getSeenService
```
public static java.util.Optional<NucleusSeenService> getSeenService()
```
    Gets the NucleusSeenService, if it exists.
    Requires the "playerinfo" module.
    
    Returns:
    
    The NucleusSeenService
  - getStaffChatService
```
public static java.util.Optional<NucleusStaffChatService> getStaffChatService()
```
    Gets the NucleusStaffChatService, if it exists.
    Requires the "staff-chat" module.
    
    Returns:
    
    The NucleusStaffChatService
  - getWarningService
```
public static java.util.Optional<NucleusWarningService> getWarningService()
```
    Gets the NucleusWarningService, if it exists.
    Requires the "warning" module.
    
    Returns:
    
    The NucleusWarningService
  - getWarpService
```
public static java.util.Optional<NucleusWarpService> getWarpService()
```
    Gets the NucleusWarpService, if it exists.
    Requires the "warp" module.
    
    Returns:
    
    The NucleusWarpService

Class NucleusAPI

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getMetaService

getPlayerMetadataService

getWarmupManagerService

getPlaceholderService

getTextTemplateFactory

getWorldUUIDChangeService

getUserPreferenceService

getAFKService

getBackService

getFreezePlayerService

getHomeService

getInvulnerabilityService

getJailService

getKitService

getMailService

getMuteService

getNameBanService

getNicknameService

getNoteService

getPrivateMessagingService

getRTPService

getSeenService

getStaffChatService

getWarningService

getWarpService