io.github.nucleuspowered.nucleus.api.core

Interface NucleusPlayerMetadataService.Result

Enclosing interface:

NucleusPlayerMetadataService

public static interface NucleusPlayerMetadataService.Result

Represents the metadata for a player.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.String>	getLastIP() Gets the last known IP address of the user.
java.util.Optional<org.spongepowered.api.util.Tuple<org.spongepowered.api.world.storage.WorldProperties,com.flowpowered.math.vector.Vector3d>>	getLastLocation() Gets the last known location of the user.
java.util.Optional<java.time.Instant>	getLastLogin() The Instant that the player last logged in.
java.util.Optional<java.time.Instant>	getLastLogout() The Instant that the player last logged out.
boolean	hasFirstJoinBeenProcessed() Gets whether Nucleus will perform first join actions for this player on the next login.

Method Detail

hasFirstJoinBeenProcessed

boolean hasFirstJoinBeenProcessed()

Gets whether Nucleus will perform first join actions for this player on the next login. This may be affected by server configuration.

Returns:

if first join actions may be run on this player's next login.

getLastLogin

java.util.Optional<java.time.Instant> getLastLogin()

The Instant that the player last logged in. This does not get updated on logout, see getLastLogout().

Returns:

The Instant the player last logged in, if any.

getLastLogout

java.util.Optional<java.time.Instant> getLastLogout()

The Instant that the player last logged out. This does not get updated on login, see getLastLogin() ()}.

Returns:

The Instant the player last logged out, if any.

getLastIP

java.util.Optional<java.lang.String> getLastIP()

Gets the last known IP address of the user. This string is formed using InetAddress.toString()

Returns:

The IP, if the player has logged in before.

getLastLocation

java.util.Optional<org.spongepowered.api.util.Tuple<org.spongepowered.api.world.storage.WorldProperties,com.flowpowered.math.vector.Vector3d>> getLastLocation()

Gets the last known location of the user.

Note that this method exists to cater for unloaded worlds.

Returns:

The Tuple of the target WorldProperties and Vector3d as the location.