io.github.nucleuspowered.nucleus.api.module.back

Interface NucleusBackService

public interface NucleusBackService

A service that handles the subject's last location before a warp, that is, the location they will warp to if they run /back.

A subject's last location may not be set. It is not saved across server restarts, and may be discarded at any time the user is not online.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World>>	getLastLocation(org.spongepowered.api.entity.living.player.User user) Gets the location of the subject before they executed the last warp that was marked as Returnable.
boolean	isLoggingLastLocation(org.spongepowered.api.entity.living.player.User user) Gets a value indicating whether the user will have their last location logged.
void	removeLastLocation(org.spongepowered.api.entity.living.player.User user) Removes the last location from the subject, so that /back will not work for them.
void	setLastLocation(org.spongepowered.api.entity.living.player.User user, org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World> location) Sets the location that the subject will be warped to if they execute /back
void	setLoggingLastLocation(org.spongepowered.api.entity.living.player.User user, boolean log) Sets whether the user will have their last location logged.

Method Detail

getLastLocation

java.util.Optional<org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World>> getLastLocation(org.spongepowered.api.entity.living.player.User user)

Gets the location of the subject before they executed the last warp that was marked as Returnable.

Parameters:

user - The User

Returns:

If it exists, an Optional containing the Transform

setLastLocation

void setLastLocation(org.spongepowered.api.entity.living.player.User user,
                     org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World> location)

Sets the location that the subject will be warped to if they execute /back

Parameters:

user - The User

location - The Location to set as the /back target.

removeLastLocation

void removeLastLocation(org.spongepowered.api.entity.living.player.User user)

Removes the last location from the subject, so that /back will not work for them.

Parameters:

user - The User

isLoggingLastLocation

boolean isLoggingLastLocation(org.spongepowered.api.entity.living.player.User user)

Gets a value indicating whether the user will have their last location logged.

Parameters:

user - The User

Returns:

true if it is being logged.

setLoggingLastLocation

void setLoggingLastLocation(org.spongepowered.api.entity.living.player.User user,
                            boolean log)

Sets whether the user will have their last location logged.

Parameters:

user - The User

log - Whether to log the user's last location.