nLogin API

https://jd.nickuc.com/nlogin
Admin
JavaDoc API documentation for nLogin, a Minecraft server login and authentication plugin with...
Tokens:40,388
Snippets:586
Trust Score:6.4
Update:5 months ago
Show doc for...
Tokens:
Raw
### getApi

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Returns the nLogin API instance. This method is static and should be called to get the main entry point for the API.

```APIDOC
## getApi

### Description
Returns the nLogin API instance. This method is static and should be called to get the main entry point for the API.

### Method
`static nLoginAPI getApi()`

### Throws
`nLoginNotLoadedException` - if the api has not yet been instantiated
```

--------------------------------

### init(nLoginAPI)

Source: https://jd.nickuc.com/nlogin/index-all.html

Initializes the nLogin API using a provided nLoginAPI instance.

```APIDOC
## init(nLoginAPI)

### Description
Initializes the nLogin API. This is a static method that should be called to set up the API.

### Method
`init`

### Parameters
- **nLoginAPI** (nLoginAPI) - Required - An instance of the nLoginAPI to be initialized.
```

--------------------------------

### init

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPIHolder.html

Initializes the nLoginAPIHolder with a provided nLoginAPI instance. This method is static and should be called to set up the API holder.

```APIDOC
## init

### Description
Initializes the nLoginAPIHolder with a provided nLoginAPI instance. This method is static and should be called to set up the API holder.

### Method
`static void init(nLoginAPI api)`

### Parameters
* **api** (nLoginAPI) - The nLoginAPI instance to be held by the holder.
```

--------------------------------

### getSettings()

Source: https://jd.nickuc.com/nlogin/index-all.html

Returns the settings of this account. This method is available in AccountData and AccountDataImpl.

```APIDOC
## getSettings()

### Description
Returns the settings of this account.

### Method
Method call on `AccountData` or `AccountDataImpl` instance

### Parameters
None

### Response
- **settings** (SettingsObject) - The account settings.
```

--------------------------------

### getCommand

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/velocity/command/PreCommandExecuteEvent.html

Returns the command that was entered by the player.

```APIDOC
## getCommand

### Description
Returns the command entered by the player.

### Method
GET

### Endpoint
N/A (Method within an event object)

### Returns
- **command** (String) - The command string.
```

--------------------------------

### PremiumLoginEvent Constructor

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/velocity/auth/PremiumLoginEvent.html

Constructs a new PremiumLoginEvent with the specified player.

```APIDOC
## PremiumLoginEvent(Player player)

### Description
Constructs a new PremiumLoginEvent with the specified player.

### Parameters
#### Path Parameters
- **player** (com.velocitypowered.api.proxy.Player) - Required - The player instance.

### Constructor Example
```java
PremiumLoginEvent event = new PremiumLoginEvent(player);
```
```

--------------------------------

### LoginEvent Constructor

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/bungee/auth/LoginEvent.html

Constructs a new LoginEvent with the player and password.

```APIDOC
## LoginEvent Constructor

### Description

Constructs a new `LoginEvent` instance.

### Parameters

- **player** (net.md_5.bungee.api.connection.ProxiedPlayer) - The player initiating the login.
- **password** (String) - The password used for authentication. Can be null.
```

--------------------------------

### isAvailable()

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Checks if the nLogin API is ready and available for use.

```APIDOC
## isAvailable()

### Description
It checks if the api is ready to be used.

### Method
This is an instance method.

### Response
#### Success Response (boolean)
- Returns `true` if the API is available, `false` otherwise.
```

--------------------------------

### BukkitEvent Constructors

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/internal/bukkit/BukkitEvent.html

Provides details on how to instantiate BukkitEvent objects, with options for asynchronous events.

```APIDOC
## BukkitEvent()

### Description
Constructs a new BukkitEvent.

### Constructor
`BukkitEvent()`

## BukkitEvent(boolean async)

### Description
Constructs a new BukkitEvent, specifying whether it is asynchronous.

### Constructor
`BukkitEvent(boolean async)`
- **async** (boolean) - Required - Whether the event is asynchronous.
```

--------------------------------

### LoginEvent Methods

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/bungee/auth/LoginEvent.html

Provides methods to access player information and the password used during login.

```APIDOC
## LoginEvent Methods

### getPlayer

Returns the player instance associated with this event.

- **Returns**: (net.md_5.bungee.api.connection.ProxiedPlayer) The player object.

### getPassword

Returns the password used during the login authentication.

- **Returns**: (String) The password, or null if not provided.

### isCancelled

Checks if the event has been cancelled.

- **Returns**: (boolean) True if cancelled, false otherwise.

### setCancelled

Sets the cancellation state of the event.

- **Parameters**:
  - **cancel** (boolean) - True to cancel the event, false otherwise.
```

--------------------------------

### setServer

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/velocity/connection/DefineAuthServerEvent.html

Defines the server that will be used for the connection.

```APIDOC
## setServer(RegisteredServer server)

### Description
Defines the server that will be used for the connection.

### Parameters
* **server** (com.velocitypowered.api.proxy.server.RegisteredServer) - The server to be used for the connection.

### Returns
* **void**
```

--------------------------------

### PreCommandExecuteEvent Constructor

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/velocity/command/PreCommandExecuteEvent.html

Constructs a new PreCommandExecuteEvent. This event is triggered when an nLogin command is entered by a player.

```APIDOC
## PreCommandExecuteEvent Constructor

### Description
Constructs a new `PreCommandExecuteEvent`.

### Parameters
#### Path Parameters
- **player** (com.velocitypowered.api.proxy.Player) - The player who entered the command.
- **type** (CommandType) - The type of the command.
- **command** (String) - The command entered by the player.
- **extraArgs** (String[]) - The arguments provided with the command. Sensitive information will not be included.
```

--------------------------------

### getPlugin()

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/internal/bungee/BungeeLockableNewActionEvent.html

Retrieves the BungeeCord plugin that initiated this action.

```APIDOC
## getPlugin()

### Description
Returns the plugin that owns the action.

### Returns
* **net.md_5.bungee.api.plugin.Plugin** - The plugin instance.
```

--------------------------------

### getServer()

Source: https://jd.nickuc.com/nlogin/index-all.html

Returns the server used to connect. This method is available in connection-related events for Bungee and Velocity.

```APIDOC
## getServer()

### Description
Returns the server used to connect.

### Method
Method call (context-dependent on the event)

### Parameters
None

### Response
- **server** (String) - The name of the server.
```

--------------------------------

### getServer

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/velocity/connection/DefineAuthServerEvent.html

Retrieves the server that will be used for the connection.

```APIDOC
## getServer()

### Description
Returns the server used to connect.

### Returns
* **Optional<com.velocitypowered.api.proxy.server.RegisteredServer>** - An Optional containing the server to be used, or empty if not yet defined.
```

--------------------------------

### BukkitEvent Methods

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/internal/bukkit/BukkitEvent.html

Details the instance and static methods available for BukkitEvent, including handler retrieval.

```APIDOC
## getHandlers()

### Description
Returns the handler list for this event.

### Method
`getHandlers()`

### Returns
- **org.bukkit.event.HandlerList** - The handler list for the event.

## getHandlerList()

### Description
Returns the static handler list for this event.

### Method
`static getHandlerList()`

### Returns
- **org.bukkit.event.HandlerList** - The static handler list for the event.
```

--------------------------------

### BukkitCancellableEvent Constructors

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/internal/bukkit/BukkitCancellableEvent.html

Provides details on how to instantiate a BukkitCancellableEvent.

```APIDOC
## BukkitCancellableEvent()

### Description
Creates a new BukkitCancellableEvent.

### Constructor
`public BukkitCancellableEvent()`
```

```APIDOC
## BukkitCancellableEvent(boolean async)

### Description
Creates a new BukkitCancellableEvent with the specified asynchronous state.

### Constructor
`public BukkitCancellableEvent(boolean async)`
```

--------------------------------

### performRegister(Identity identity, String plainPassword, String ip)

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Registers a player with the provided identity, password, and IP address.

```APIDOC
## performRegister(Identity identity, String plainPassword, String ip)

### Description
Register a player.

### Method
This is an instance method.

### Parameters
#### Path Parameters
- **identity** (Identity) - Required - The identity of the player to register.
- **plainPassword** (String) - Required - The plain text password for the new account.
- **ip** (String) - Required - The IP address associated with the registration.

### Response
#### Success Response (boolean)
- Returns `true` if the registration was successful, `false` otherwise.
```

--------------------------------

### BukkitLockableNewActionEvent Constructor

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/internal/bukkit/BukkitLockableNewActionEvent.html

Initializes a new instance of the BukkitLockableNewActionEvent class.

```APIDOC
## BukkitLockableNewActionEvent Constructor

### Description
Initializes a new instance of the BukkitLockableNewActionEvent class.

### Parameters
* **event** (T) - The lockable event.
* **plugin** (org.bukkit.plugin.Plugin) - The plugin that owns the action.
* **action** (LockableEventAction) - The action performed.
```

--------------------------------

### getPlayer Method

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/bukkit/auth/SessionLoginEvent.html

Returns the player instance associated with this login event.

```APIDOC
## getPlayer Method

### Description
Returns the player instance associated with this login event.

### Method
public org.bukkit.entity.Player getPlayer()

### Returns
- **org.bukkit.entity.Player** - The player instance.
```

--------------------------------

### BungeeCancellableEvent Constructor

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/internal/bungee/BungeeCancellableEvent.html

Initializes a new instance of the BungeeCancellableEvent class.

```APIDOC
## Constructor

### `BungeeCancellableEvent()`

**Description:** Initializes a new instance of the `BungeeCancellableEvent` class.

**Signature:** `public BungeeCancellableEvent()``
```

--------------------------------

### ServerPreConnectEvent Constructor

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/velocity/connection/ServerPreConnectEvent.html

Constructs a new ServerPreConnectEvent.

```APIDOC
## ServerPreConnectEvent Constructor

### Description
Creates a new instance of the ServerPreConnectEvent.

### Parameters
* **player** (com.velocitypowered.api.proxy.Player) - The player initiating the connection.
* **serverConnectType** (ServerConnectType) - The type of server connection.
* **originalServer** (com.velocitypowered.api.proxy.server.RegisteredServer) - The server originally intended for connection.
```

--------------------------------

### getVersion()

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Returns the version of the nLogin plugin.

```APIDOC
## getVersion()

### Description
Returns the version of the plugin.

### Method
This is an instance method.

### Response
#### Success Response (String)
- Returns the plugin version as a `String`.
```

--------------------------------

### performRegister(Identity identity, String plainPassword, String ip)

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Registers a player with the provided identity, plain password, and IP address. Returns true if successful, false if the user is already registered or if there's a database failure.

```APIDOC
## performRegister(Identity identity, String plainPassword, String ip)

### Description
Register a player.

### Method
APIDOC

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **identity** (Identity) - Required - Player identity.
- **plainPassword** (String) - Required - Plain password to be used (not hashed).
- **ip** (String) - Optional - IP address. Can be null.

### Request Example
```json
{
  "identity": { /* Identity object */ },
  "plainPassword": "user_password",
  "ip": "192.168.1.1"
}
```

### Response
#### Success Response (boolean)
- Returns `true` if the registration was successful.
- Returns `false` if the user is already registered or during a database failure.

#### Response Example
```json
{
  "success": true
}
```

### Throws
- `nLoginNotReadyException`: if the plugin is not yet fully loaded.
- `nLoginRequestUnavailableException`: if the implementation type does not support this method at invocation time. @see `ImplementationType`
```

--------------------------------

### getOriginalServer

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/velocity/connection/DefineAuthServerEvent.html

Retrieves the server that was originally used for the connection.

```APIDOC
## getOriginalServer()

### Description
Returns the server originally used to connect.

### Returns
* **Optional<com.velocitypowered.api.proxy.server.RegisteredServer>** - An Optional containing the original server, or empty if none was used.
```

--------------------------------

### BukkitLockableEvent Methods

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/internal/bukkit/BukkitLockableEvent.html

Provides documentation for the public methods available in the BukkitLockableEvent class, including locking, unlocking, and retrieving lock information.

```APIDOC
## BukkitLockableEvent

This class represents a lockable event in the Bukkit environment, extending `BukkitCancellableEvent` and implementing `LockableEvent`.

### Methods

#### `lock(Plugin owner)`

Locks the event.

- **owner** (`Plugin`) - Required - The plugin responsible for this action.

#### `unlock(Plugin owner)`

Unlocks the event.

- **owner** (`Plugin`) - Required - The plugin responsible for this action.

#### `count()`

Returns the lock counter.

- **Returns**: `int` - The current lock counter.

#### `getLock()`

Deprecated. Retrieves the lock status.

- **Returns**: `byte` - The lock status.

#### `callEvt()`

Calls the event. Implements the `callEvt` method from the `LockableEvent` interface.

- **Returns**: `boolean` - Indicates if the event call was successful.
```

--------------------------------

### LoginRequestChangeEvent Constructor

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/velocity/auth/request/LoginRequestChangeEvent.html

Initializes a new instance of the LoginRequestChangeEvent class.

```APIDOC
## LoginRequestChangeEvent(LoginRequestEvent loginRequestEvent, Object plugin, LockableEventAction action)

### Description
Initializes a new instance of the LoginRequestChangeEvent class.

### Parameters
#### Constructor Parameters
- **loginRequestEvent** (LoginRequestEvent) - The login request event.
- **plugin** (Object) - The plugin associated with the event.
- **action** (LockableEventAction) - The lockable event action.
```

--------------------------------

### BukkitLockableNewActionEvent Methods

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/internal/bukkit/BukkitLockableNewActionEvent.html

Provides access to the event, plugin, and action associated with the BukkitLockableNewActionEvent.

```APIDOC
## BukkitLockableNewActionEvent Methods

### getEvent

#### Description
Returns the lockable event.

#### Returns
* **T** - The lockable event.

### getPlugin

#### Description
Returns the plugin that owns the action.

#### Returns
* **org.bukkit.plugin.Plugin** - The plugin that owns the action.

### getAction

#### Description
Returns the action done.

#### Returns
* **LockableEventAction** - The action performed.
```

--------------------------------

### SessionLoginEvent Constructor

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/bukkit/auth/SessionLoginEvent.html

Constructs a new SessionLoginEvent with the specified player.

```APIDOC
## SessionLoginEvent Constructor

### Description
Constructs a new SessionLoginEvent with the specified player.

### Parameters
#### Path Parameters
- **player** (org.bukkit.entity.Player) - Required - The player instance associated with this event.
```

--------------------------------

### Identity.ofPremium

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/types/Identity.html

Returns an instance of a premium player identity with a given Mojang ID.

```APIDOC
## Identity.ofPremium

### Description
Returns an instance of a premium player identity with a given Mojang ID.

### Method
static

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response
- **Identity** (Identity) - An instance of a premium player identity.

#### Response Example
N/A
```

--------------------------------

### RegisterEvent Constructor

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/bungee/auth/RegisterEvent.html

Constructs a new RegisterEvent with the specified player and password.

```APIDOC
## RegisterEvent Constructor

### Description
Constructs a new RegisterEvent with the specified player and password.

### Parameters
#### Path Parameters
- **player** (net.md_5.bungee.api.connection.ProxiedPlayer) - Required - The player instance.
- **password** (String) - Required - The password used for registration.
```

--------------------------------

### LoginRequestEvent Constructor

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/bukkit/auth/request/LoginRequestEvent.html

Constructs a new LoginRequestEvent for the given player.

```APIDOC
## LoginRequestEvent(Player player)

### Description
Constructs a new LoginRequestEvent for the given player.

### Parameters
#### Path Parameters
- **player** (org.bukkit.entity.Player) - Description: The player initiating the login request.
```

--------------------------------

### getExtraArgs

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/velocity/command/PreCommandExecuteEvent.html

Returns the extra arguments provided with the command.

```APIDOC
## getExtraArgs

### Description
Returns the extra arguments provided with the command. Note that sensitive information will not be included.

### Method
GET

### Endpoint
N/A (Method within an event object)

### Returns
- **extraArgs** (String[]) - An array of strings representing the extra arguments.
```

--------------------------------

### isAvailable

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Checks if the nLogin API is ready to be used. This is a basic health check for the API's availability.

```APIDOC
## isAvailable

### Description
Checks if the nLogin API is ready to be used. This is a basic health check for the API's availability.

### Method
`boolean isAvailable()`

### Since
API v1
```

--------------------------------

### performRegister

Source: https://jd.nickuc.com/nlogin/index-all.html

Registers a player with the nLogin system. Overloaded methods allow for registration with or without an Identity object, and with an optional additional string parameter.

```APIDOC
## performRegister(Identity, String)

### Description
Registers a player.

### Method
Not specified (likely a method call in an SDK)

### Parameters
- **identity** (Identity) - Required - The identity of the player.
- **string** (String) - Required - An associated string value.
```

```APIDOC
## performRegister(Identity, String, String)

### Description
Registers a player.

### Method
Not specified (likely a method call in an SDK)

### Parameters
- **identity** (Identity) - Required - The identity of the player.
- **string1** (String) - Required - An associated string value.
- **string2** (String) - Required - An associated string value.
```

```APIDOC
## performRegister(String, String)

### Description
Deprecated. Use `nLoginAPI.performRegister(Identity, String)` instead.
Registers a player.

### Method
Not specified (likely a method call in an SDK)

### Parameters
- **string1** (String) - Required - The first string value.
- **string2** (String) - Required - The second string value.
```

```APIDOC
## performRegister(String, String, String)

### Description
Deprecated. Use `nLoginAPI.performRegister(Identity, String, String)` instead.
Registers a player.

### Method
Not specified (likely a method call in an SDK)

### Parameters
- **string1** (String) - Required - The first string value.
- **string2** (String) - Required - The second string value.
- **string3** (String) - Required - The third string value.
```

--------------------------------

### performRegister(Identity identity, String plainPassword)

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Registers a player with the provided identity and plain password. Returns true if successful, false if the user is already registered or if there's a database failure.

```APIDOC
## performRegister(Identity identity, String plainPassword)

### Description
Register a player.

### Method
APIDOC

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **identity** (Identity) - Required - Player identity.
- **plainPassword** (String) - Required - Plain password to be used (not hashed).

### Request Example
```json
{
  "identity": { /* Identity object */ },
  "plainPassword": "user_password"
}
```

### Response
#### Success Response (boolean)
- Returns `true` if the registration was successful.
- Returns `false` if the user is already registered or during a database failure.

#### Response Example
```json
{
  "success": true
}
```

### Throws
- `nLoginNotReadyException`: if the plugin is not yet fully loaded.
- `nLoginRequestUnavailableException`: if the implementation type does not support this method at invocation time. @see `ImplementationType`
```

--------------------------------

### nLoginAPI Methods

Source: https://jd.nickuc.com/nlogin/index-all.html

Methods available on the nLoginAPI interface for interacting with player accounts and data.

```APIDOC
## getAccount(Identity)

### Description
Returns a player's account.

### Method
getAccount

### Parameters
#### Path Parameters
- **Identity** (Identity) - Required - The identity of the player.

### Response
#### Success Response (200)
- **AccountData** (AccountData) - The account data for the specified player.
```

```APIDOC
## getAccountCount()

### Description
Returns the count of all accounts stored in the database.

### Method
getAccountCount

### Response
#### Success Response (200)
- **int** (int) - The total number of accounts.
```

```APIDOC
## getAccounts()

### Description
Returns all accounts from nLogin.

### Method
getAccounts

### Response
#### Success Response (200)
- **List<AccountData>** (List<AccountData>) - A list of all account data.
```

```APIDOC
## getAccountsByIp(String)

### Description
Returns all nLogin accounts by IP.

### Method
getAccountsByIp

### Parameters
#### Path Parameters
- **String** (String) - Required - The IP address to search for.

### Response
#### Success Response (200)
- **List<AccountData>** (List<AccountData>) - A list of account data associated with the IP address.
```

```APIDOC
## getAddress(String)

### Description
Deprecated. Use `nLoginAPI.getAccount(Identity)` instead.

### Method
getAddress

### Parameters
#### Path Parameters
- **String** (String) - Required - The identifier for the address lookup.
```

```APIDOC
## getApi()

### Description
Returns the nLogin api.

### Method
getApi

### Response
#### Success Response (200)
- **nLoginAPI** (nLoginAPI) - The nLogin API instance.
```

```APIDOC
## getApiVersion()

### Description
Returns the version of the api.

### Method
getApiVersion

### Response
#### Success Response (200)
- **String** (String) - The API version.
```

```APIDOC
## getDatabaseType()

### Description
Returns the type of database being used.

### Method
getDatabaseType

### Response
#### Success Response (200)
- **String** (String) - The type of database.
```

```APIDOC
## getDiscord(String)

### Description
Deprecated. Use `nLoginAPI.getAccount(Identity)` instead.

### Method
getDiscord

### Parameters
#### Path Parameters
- **String** (String) - Required - The identifier for the Discord lookup.
```

```APIDOC
## getEmail(String)

### Description
Deprecated. Use `nLoginAPI.getAccount(Identity)` instead.

### Method
getEmail

### Parameters
#### Path Parameters
- **String** (String) - Required - The identifier for the email lookup.
```

--------------------------------

### Event Methods

Source: https://jd.nickuc.com/nlogin/index-all.html

Methods for retrieving information from various nLogin events.

```APIDOC
## getAccount()

### Description
Returns the twofactor account.

### Method
getAccount

### Response
#### Success Response (200)
- **TwoFactorAccount** (TwoFactorAccount) - The twofactor account object.
```

```APIDOC
## getAction()

### Description
Returns the action done.

### Method
getAction

### Response
#### Success Response (200)
- **ActionType** (ActionType) - The type of action performed.
```

```APIDOC
## getEvent()

### Description
Returns the lockable event.

### Method
getEvent

### Response
#### Success Response (200)
- **LockableEvent** (LockableEvent) - The associated lockable event.
```

```APIDOC
## getCommand()

### Description
Returns the command.

### Method
getCommand

### Response
#### Success Response (200)
- **String** (String) - The command that was executed.
```

--------------------------------

### getPlayer()

Source: https://jd.nickuc.com/nlogin/index-all.html

Retrieves the player instance associated with various events, such as authentication, registration, password updates, and command executions. This method is available across Bukkit and Bungee platforms.

```APIDOC
## getPlayer()

### Description
Returns the player instance associated with the event.

### Method
N/A (Method Call)

### Parameters
None

### Response
- **player** (Player) - The player instance.
```

--------------------------------

### getVersion

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Retrieves the current version of the nLogin plugin.

```APIDOC
## getVersion

### Description
Retrieves the current version of the nLogin plugin.

### Method
`@Nonnull String getVersion()`

### Since
API v1
```

--------------------------------

### AccountDataImpl Methods

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/types/AccountDataImpl.html

This section details the methods available on the AccountDataImpl class for retrieving various account attributes. These methods are primarily for internal use.

```APIDOC
## AccountDataImpl

Implementation of `AccountData` for internal usage only.

### Methods

- **getId()** (Optional<Long>) - Returns the registered ID of this account. It will not be present if the account is not stored in the database yet.
- **getType()** (AccountType) - Returns the type of this account. It will not be present if the account is not registered.
- **getLastName()** (String) - Returns the registered last name of this account.
- **getUniqueId()** (Optional<UUID>) - Returns the registered unique ID of this account.
- **getMojangId()** (Optional<UUID>) - Returns the registered Mojang ID of this account.
- **getBedrockId()** (Optional<UUID>) - Returns the registered bedrock ID of this account.
- **getHashedPassword()** (Optional<String>) - Returns the registered hashed password of this account.
- **getLastIP()** (String) - Returns the registered last IP address of this account.
- **getLastLogin()** (Instant) - Returns the last login of this account.
- **getCreationDate()** (Instant) - Returns the creation date of this account.
- **getEmail()** (Optional<String>) - Returns the registered email of this account.
- **getDiscordId()** (Optional<String>) - Returns the registered discord ID of this account.
- **getSettings()** (Map<String, Object>) - Returns the settings of this account. The returned value is read-only.
```

--------------------------------

### setLanguage

Source: https://jd.nickuc.com/nlogin/index-all.html

Sets the language for a player.

```APIDOC
## setLanguage

### Description
Sets the language for a player.

### Method
`setLanguage(Identity identity, String language)`

### Parameters
- **identity** (Identity) - Required - The identity of the player.
- **language** (String) - Required - The language code to set for the player.
```

--------------------------------

### getType

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/velocity/command/PreCommandExecuteEvent.html

Returns the type of the command.

```APIDOC
## getType

### Description
Returns the command type.

### Method
GET

### Endpoint
N/A (Method within an event object)

### Returns
- **type** (CommandType) - The command type.
```

--------------------------------

### requestLogin(Identity, Object)

Source: https://jd.nickuc.com/nlogin/index-all.html

Sends a login request using an Identity object and an associated Object. This is the recommended method for initiating a login.

```APIDOC
## requestLogin(Identity, Object)

### Description
Sends a login request. This method is part of the nLoginAPI interface.

### Method
(Interface Method)

### Parameters
- **identity** (Identity) - Description not provided in source.
- **object** (Object) - Description not provided in source.

### Request Example
(Not provided in source)

### Response
(Not provided in source)
```

--------------------------------

### createIdentity

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.nLoginInternal.html

Creates a new identity with the provided details. This method requires the user's name, Mojang ID, Bedrock ID, and account type.

```APIDOC
## createIdentity

### Description
Creates a new identity with the provided details. This method requires the user's name, Mojang ID, Bedrock ID, and account type.

### Method Signature
Identity createIdentity(String name, UUID mojangId, UUID bedrockId, AccountType type)

### Parameters
#### Path Parameters
- **name** (String) - Required - The name of the identity.
- **mojangId** (UUID) - Required - The Mojang ID associated with the identity.
- **bedrockId** (UUID) - Required - The Bedrock ID associated with the identity.
- **type** (AccountType) - Required - The type of the account.

### Returns
- **Identity** - The newly created identity object.
```

--------------------------------

### getPlugin

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/internal/velocity/VelocityLockableNewActionEvent.html

Retrieves the plugin that owns this action.

```APIDOC
## getPlugin()

### Description
Returns the plugin that owns the action.

### Returns
- **Object** - The plugin instance.
```

--------------------------------

### internal

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Returns the nLogin internal API, providing access to internal functionalities.

```APIDOC
## internal

### Description
Returns the nLogin internal API, providing access to internal functionalities.

### Method
N/A (SDK method)

### Parameters
None

### Request Example
N/A (SDK method)

### Response
* **nLoginInternal** - An instance of the nLogin internal API.
```

--------------------------------

### forceLogin

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Forces a player's login. Returns true if successful, false otherwise. Can throw exceptions if the plugin is not ready or the implementation does not support the method.

```APIDOC
## forceLogin

### Description
Forces a player's login. Returns true if the operation was successful. If the user is not registered, returns false.

### Method
`boolean forceLogin(@Nonnull Identity identity)`

### Parameters
#### Path Parameters
- `identity` (Identity) - Required - Player identity.

### Throws
- `nLoginNotReadyException` - if the plugin is not yet fully loaded.
- `nLoginRequestUnavailableException` - if the implementation type does not support this method at invocation time.

### Since
API v1
```

```APIDOC
## forceLogin

### Description
Forces a player's login. Sends login messages if the supplied value is true. Returns true if the operation was successful. If the user is not registered, returns false.

### Method
`boolean forceLogin(@Nonnull Identity identity, boolean showMessages)`

### Parameters
#### Path Parameters
- `identity` (Identity) - Required - Player identity.
- `showMessages` (boolean) - Required - Sends login messages if the supplied value is true.

### Throws
- `nLoginNotReadyException` - if the plugin is not yet fully loaded.
- `nLoginRequestUnavailableException` - if the implementation type does not support this method at invocation time.

### Since
API v1
```

--------------------------------

### BedrockLoginEvent

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/bukkit/auth/BedrockLoginEvent.html

Event triggered when a player finishes authentication automatically because it is connecting with a Bedrock account.

```APIDOC
## BedrockLoginEvent

### Description
Event triggered when a player finishes authentication automatically because it is connecting with a Bedrock account.

### Constructor
`BedrockLoginEvent(org.bukkit.entity.Player player)`

### Methods
#### getPlayer
`org.bukkit.entity.Player getPlayer()`
Returns the player instance.

Specified by:
`getPlayer` in interface `EventWithPlayer`
```

--------------------------------

### AccountData Methods

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/types/AccountData.html

This section details the various methods available on the AccountData interface to retrieve specific information about an nLogin account.

```APIDOC
## AccountData Interface

Interface used to encapsulate the data of an nLogin account. An instance can be obtained through the `nLoginAPI.getAccount(Identity)` method.

### Methods

*   **getId()**: `Optional<Long>` - Returns the registered ID of this account. It will not be present if the account is not stored in the database yet.
*   **getType()**: `AccountType` - Returns the type of this account. It will not be present if the account is not registered.
*   **getLastName()**: `String` - Returns the registered last name of this account.
*   **getUniqueId()**: `Optional<UUID>` - Returns the registered unique ID of this account.
*   **getMojangId()**: `Optional<UUID>` - Returns the registered Mojang ID of this account.
*   **getBedrockId()**: `Optional<UUID>` - Returns the registered bedrock ID of this account.
*   **getHashedPassword()**: `Optional<String>` - Returns the registered hashed password of this account.
*   **comparePassword(String plainPassword)**: `boolean` - Checks that the password you provided is valid. Returns true if the password is valid.
*   **getLastAddress()**: `String` - Returns the registered last address of this account.
*   **getLastIP()**: `String` - Returns the registered last IP address of this account.
*   **getLastLogin()**: `Instant` - Returns the last login of this account.
*   **getCreationDate()**: `Instant` - Returns the creation date of this account.
*   **getEmail()**: `Optional<String>` - Returns the registered email of this account.
*   **getDiscordId()**: `Optional<String>` - Returns the registered discord ID of this account.
*   **getSettings()**: `Map<String,Object>` - Returns the settings of this account. The returned value is read-only.
*   **getLanguage()**: `Optional<String>` - Returns the last language of this account.
```

--------------------------------

### forceLogin(Identity identity, boolean showMessages)

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Forces a player's login, with an option to display messages to the player.

```APIDOC
## forceLogin(Identity identity, boolean showMessages)

### Description
Forces a player's login.

### Method
This is an instance method.

### Parameters
#### Path Parameters
- **identity** (Identity) - Required - The identity of the player to force login.
- **showMessages** (boolean) - Required - Whether to show messages to the player during the forced login process.

### Response
#### Success Response (boolean)
- Returns `true` if the forced login was successful, `false` otherwise.
```

--------------------------------

### BungeeLockableNewActionEvent Constructor

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/internal/bungee/BungeeLockableNewActionEvent.html

Constructs a new BungeeLockableNewActionEvent. This constructor is used to create an event instance with the associated event data, the plugin that initiated the action, and the specific action to be performed.

```APIDOC
## BungeeLockableNewActionEvent Constructor

### Description
Initializes a new instance of the `BungeeLockableNewActionEvent` class.

### Parameters
* **event** (T) - The actual event data associated with this action.
* **plugin** (net.md_5.bungee.api.plugin.Plugin) - The plugin that is performing this action.
* **action** (LockableEventAction) - The specific action to be performed on the event.
```

--------------------------------

### PremiumLoginEvent

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/bukkit/auth/PremiumLoginEvent.html

Represents the event triggered upon successful premium account authentication.

```APIDOC
## Class: PremiumLoginEvent

### Description
Event triggered when a player finishes authentication automatically via a premium account.

### Constructor
`PremiumLoginEvent(org.bukkit.entity.Player player)`
- Constructs a new PremiumLoginEvent with the specified player.

### Methods
#### getPlayer
`public org.bukkit.entity.Player getPlayer()`
- Returns the player instance associated with this event.
- Specified by: `getPlayer` in interface `EventWithPlayer`
```

--------------------------------

### getPlayerName

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/velocity/account/PasswordUpdateEvent.html

Returns the name of the player.

```APIDOC
## getPlayerName

### Description

Returns the player name.

### Method

`getPlayerName()`

### Returns

- **String** - The player's name.
```

--------------------------------

### PreCommandExecuteEvent

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/bukkit/command/PreCommandExecuteEvent.html

Represents an event triggered when a player enters an nLogin command. This event is cancellable.

```APIDOC
## Class: PreCommandExecuteEvent

Event triggered when an nLogin command is entered by a player.

### Constructor

`PreCommandExecuteEvent(Player player, CommandType type, String command, String[] extraArgs)`

Constructs a new PreCommandExecuteEvent.

### Methods

#### `getPlayer()`

Returns the player instance that executed the command.

- **Returns**: `Player` - The player who executed the command.

#### `getType()`

Returns the type of the command.

- **Returns**: `CommandType` - The type of the command.

#### `getCommand()`

Returns the command that was entered.

- **Returns**: `String` - The command string.

#### `getExtraArgs()`

Returns the extra arguments passed with the command.

- **Returns**: `String[]` - An array of strings representing the extra arguments. Sensitive information such as passwords will NOT be provided.

#### `isCancelled()`

Checks if the event has been cancelled.

- **Returns**: `boolean` - `true` if the event is cancelled, `false` otherwise.

#### `setCancelled(boolean cancel)`

Sets the cancellation state of the event.

- **Parameters**:
  - `cancel` (boolean) - `true` to cancel the event, `false` to allow it to proceed.
```

--------------------------------

### setEmail

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Sets an email account for a player. Returns true if successful, false otherwise. Can throw exceptions if the plugin is not ready or the implementation does not support the method.

```APIDOC
## setEmail

### Description
Set an email account for a certain player. Returns true if the operation was successful. If the user is not registered, returns false.

### Method
`boolean setEmail(@Nonnull Identity identity, @Nullable String newEmail)`

### Parameters
#### Path Parameters
- `identity` (Identity) - Required - Player identity.
- `newEmail` (String) - Optional - Full email.

### Throws
- `nLoginNotReadyException` - if the plugin is not yet fully loaded.
- `nLoginRequestUnavailableException` - if the implementation type does not support this method at invocation time.

### Since
API v2
```

--------------------------------

### getApiVersion()

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Returns the current version of the nLogin API.

```APIDOC
## getApiVersion()

### Description
Returns the version of the api.

### Method
This is an instance method.

### Response
#### Success Response (int)
- Returns the API version as an `int`.
```

--------------------------------

### SpawnType Enum Constants

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/enums/SpawnType.html

Lists the available constants for the SpawnType enum, representing different spawn positions.

```APIDOC
## Enum Constants

Enum Constant | Description
------------- | ---------
`JOIN`        | Represents a spawn position for joining the game.
`LOGIN`       | Represents a spawn position for logging in.
`REGISTER`    | Represents a spawn position for registration.
`RESPAWN`     | Represents a spawn position for respawning after death.
```

--------------------------------

### getSource()

Source: https://jd.nickuc.com/nlogin/index-all.html

Returns the source of an action, such as password update, change password, or unregister. This method is available across various event types in Bukkit, Bungee, and Velocity.

```APIDOC
## getSource()

### Description
Returns the source of the action.

### Method
Method call (context-dependent on the event)

### Parameters
None

### Response
- **source** (String) - The source of the action.
```

--------------------------------

### forceLogin(Identity)

Source: https://jd.nickuc.com/nlogin/index-all.html

Forces a player's login using their Identity object. This is the recommended method for forcing logins.

```APIDOC
## forceLogin(Identity)

### Description
Forces a player's login using their Identity object.

### Method
[Method Signature]

### Parameters
#### Path Parameters
- **identity** (Identity) - Required - The identity of the player to log in.

### Request Example
```
// Example usage (language-specific, not HTTP)
api.forceLogin(playerIdentity);
```

### Response
#### Success Response
void

### Error Handling
[Specific error handling details not provided in source]
```

--------------------------------

### getAccounts()

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Retrieves an iterator for all accounts stored in the nLogin system.

```APIDOC
## getAccounts()

### Description
Returns all accounts from nLogin.

### Method
This is an instance method.

### Response
#### Success Response (Iterator<AccountData>)
- Returns an `Iterator` that can be used to traverse all `AccountData` objects.
```

--------------------------------

### getPlayer

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/bungee/auth/RegisterEvent.html

Returns the player instance associated with this registration event.

```APIDOC
## getPlayer

### Description
Returns the player instance associated with this registration event.

### Method
public net.md_5.bungee.api.connection.ProxiedPlayer getPlayer()

### Response
#### Success Response
- **player** (net.md_5.bungee.api.connection.ProxiedPlayer) - The player instance.
```

--------------------------------

### setDiscord

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Sets a Discord account for a player. Returns true if successful, false otherwise. Can throw exceptions if the plugin is not ready or the implementation does not support the method.

```APIDOC
## setDiscord

### Description
Set a discord account for a certain player. Returns true if the operation was successful. If the user is not registered, returns false.

### Method
`boolean setDiscord(@Nonnull Identity identity, long newAccountId)`

### Parameters
#### Path Parameters
- `identity` (Identity) - Required - Player identity.
- `newAccountId` (long) - Required - Account id.

### Throws
- `nLoginNotReadyException` - if the plugin is not yet fully loaded.
- `nLoginRequestUnavailableException` - if the implementation type does not support this method at invocation time.

### Since
API v2
```

--------------------------------

### BukkitCancellableEvent Methods

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/internal/bukkit/BukkitCancellableEvent.html

Details the methods available for interacting with the cancellation state of a BukkitCancellableEvent.

```APIDOC
## isCancelled()

### Description
Checks if the event has been cancelled.

### Method
`public boolean isCancelled()`

### Returns
`true` if the event is cancelled, `false` otherwise.
```

```APIDOC
## setCancelled(boolean cancelled)

### Description
Sets the cancellation state of the event.

### Method
`public void setCancelled(boolean cancelled)`

### Parameters
#### Parameters
- **cancelled** (boolean) - Required - `true` to cancel the event, `false` to un-cancel it.
```

--------------------------------

### Location Interface Methods

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/types/Location.html

Provides access to various properties of a location, such as world name, coordinates, and orientation.

```APIDOC
## Location Interface

Interface used to encapsulate the location data.

### Methods

- **getWorldName()**: Returns the name of the world.
- **getX()**: Returns the X coordinate.
- **getY()**: Returns the Y coordinate.
- **getZ()**: Returns the Z coordinate.
- **getPitch()**: Returns the pitch (vertical rotation).
- **getYaw()**: Returns the yaw (horizontal rotation).
```

--------------------------------

### BukkitCancellableEvent Constructor with Async Flag

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/internal/bukkit/BukkitCancellableEvent.html

Constructs a new BukkitCancellableEvent with an asynchronous flag.

```java
public BukkitCancellableEvent(boolean async)
```

--------------------------------

### BukkitEvent Constructor with Async Flag

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/internal/bukkit/BukkitEvent.html

Constructs a new BukkitEvent, allowing specification of whether the event is asynchronous.

```java
public BukkitEvent(boolean async)
```

--------------------------------

### Identity.ofBedrock

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/types/Identity.html

Returns an instance of a Bedrock player identity with a given bedrock ID.

```APIDOC
## Identity.ofBedrock

### Description
Returns an instance of a Bedrock player identity with a given bedrock ID.

### Method
static

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response
- **Identity** (Identity) - An instance of a Bedrock player identity.

#### Response Example
N/A
```

--------------------------------

### count()

Source: https://jd.nickuc.com/nlogin/index-all.html

Returns the lock counter. Available in Bukkit, Bungee, and Velocity event classes.

```APIDOC
## count() - BukkitLockableEvent

### Description
Returns the lock counter.

### Method
Method in class com.nickuc.login.api.event.internal.bukkit.BukkitLockableEvent
```

```APIDOC
## count() - BungeeLockableEvent

### Description
Returns the lock counter.

### Method
Method in class com.nickuc.login.api.event.internal.bungee.BungeeLockableEvent
```

```APIDOC
## count() - VelocityLockableEvent

### Description
Returns the lock counter.

### Method
Method in class com.nickuc.login.api.event.internal.velocity.VelocityLockableEvent
```

--------------------------------

### BukkitLockableNewActionEvent Constructor

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/internal/bukkit/BukkitLockableNewActionEvent.html

Constructs a new BukkitLockableNewActionEvent. This is used internally by the plugin to create event instances.

```java
public BukkitLockableNewActionEvent(T event, org.bukkit.plugin.Plugin plugin, LockableEventAction action)
```

--------------------------------

### requestLogin(Identity identity, Object plugin)

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Sends a login request for a player, associated with a specific plugin.

```APIDOC
## requestLogin(Identity identity, Object plugin)

### Description
Sends a login request.

### Method
This is an instance method.

### Parameters
#### Path Parameters
- **identity** (Identity) - Required - The identity of the player requesting login.
- **plugin** (Object) - Required - The plugin initiating the login request.

### Response
#### Success Response (void)
- This method does not return a value.
```

--------------------------------

### getApiVersion

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/nLoginAPI.html

Retrieves the version of the nLogin API.

```APIDOC
## getApiVersion

### Description
Retrieves the version of the nLogin API.

### Method
`int getApiVersion()`

### Since
API v1
```

--------------------------------

### getPlayer()

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/velocity/twofactor/TwoFactorAddEvent.html

Returns the player instance associated with this event. This can be null if the account was added while the player was offline.

```APIDOC
## getPlayer()

### Description
Returns the player instance. It can be null if the account is added while the player is offline.

### Method
GET

### Endpoint
N/A (Method call)

### Returns
* **com.velocitypowered.api.proxy.Player** - The player instance, or null if the player was offline.
```

--------------------------------

### values() Method

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/enums/SpawnType.html

Returns an array containing all the constants of the SpawnType enum in the order they are declared.

```APIDOC
## Method: values()

### Description
Returns an array containing the constants of this enum class, in the order they are declared.

### Returns
an array containing the constants of this enum class, in the order they are declared.
```

--------------------------------

### getPlayer

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/velocity/auth/RegisterEvent.html

Returns the player instance associated with this event.

```APIDOC
## getPlayer

### Description
Returns the player instance associated with this event.

### Method
public com.velocitypowered.api.proxy.Player getPlayer()

### Returns
- **com.velocitypowered.api.proxy.Player** - The player instance.
```

--------------------------------

### getPlayer

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/velocity/command/PreCommandExecuteEvent.html

Returns the player instance associated with this event.

```APIDOC
## getPlayer

### Description
Returns the player instance.

### Method
GET

### Endpoint
N/A (Method within an event object)

### Returns
- **player** (com.velocitypowered.api.proxy.Player) - The player instance.
```

--------------------------------

### getSource

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/event/velocity/account/PasswordUpdateEvent.html

Returns the source that triggered the password update.

```APIDOC
## getSource

### Description

Returns the update password source.

### Method

`getSource()`

### Returns

- **UpdatePasswordSource** - The source of the password update.
```

--------------------------------

### LoginType Enum Constants

Source: https://jd.nickuc.com/nlogin/com/nickuc/login/api/enums/LoginType.html

Lists the available constants for the LoginType enum, representing different authentication methods.

```APIDOC
## Enum Constants

Enum Constant | Description
---|---
`BEDROCK` | 
`LOGIN` | 
`PREMIUM` | 
`REGISTER` | 
`SESSION` | 
```
Tokens:
Raw