Nucleus is no longer updated and this site is frozen in time. Some links may be broken.
Welcome to the new docs site for Nucleus v2! Still on Nucleus v1? Visit the old site here.
« Return to Documentation Home Page // Back Module
Permission plugin commands are provided as-is and do not imply endorsement.

Back Module

Some mods or plugins may conflict with this module

The highest rating mod/plugin compatibility issue is rated major. See the compatibility tab for more information.

Introduction

The Back module allows players to return to the location that they either last warped from, or last died at.

/back only remembers the last place they warped from or died at, any earlier locations are discarded. Locations are also discarded on server restart, and offline user’s information can be discarded at any time, subject to memory requirements of the server.

Configuration

There are two entries in the main.conf file in the back section:

  • on-teleport: if true, allow players to return to the last location they teleported or warped from, if they have permission to do so.
  • on-death: if true, allow players to return to the place they died, if they have permission to do so.
  • on-portal: if true, allow players to return to the place they last portal they travelled into, if they have permission to do so.

The following are incompatibilities that may occur with this module, along with how to resolve the problem. For the full mod/plugin incompatibility list, see the compatibility page.

  • Critical issues are where some function of Nucleus is seriously affected in a way server owners are not expecting and have no known workaround, other than removing the plugin in question. It is advised that server owners remove the plugin in question and find an alternative if they wish to use the Nucleus feature it affects.
  • Major issues are where some function of Nucleus is seriously affected in a way server owners are not expecting by default but a workaround exists to mitigate or fix the issue.
  • Minor issues are where some function of Nucleus can be mildy affected, possibly in an unwanted way, but is not enabled by default or has little impact on day to day server running and management. A workaround exists to restore or use the affected Nucleus functionality.
  • Info issues are really non-issues. Incompatibilities with this label tend to be wanted (such as a world management plugin taking over the `/world` command), and are documented here for completeness, along with how to restore or use Nucleus functions.
Mod/Plugin: ProjectWorlds. Affected Module(s): teleport, back, home, warp, spawn.

Cross world teleports, such as those via warping or returning to spawn via command, might be canceled by ProjectWorlds with a no permissions message

Major

Reason: ProjectWorlds has world access permissions that can block cross world teleports.

Resolution: Grant users the ProjectWorlds world access permission, which is "pjw.worlds.<worldname>".

Mod/Plugin: Topography. Affected Module(s): teleport, back, home, warp, spawn.

Topography may block cross-world teleports

Minor

Reason: Topography has the ability to take control of cross-world teleports in non-standard configurations. SkyFactory 4 has some worlds with this option enabled by default, which blocks the Nucleus teleport commands

Resolution: Check topography configuration files for any "captureTeleports" options and remove them.

Mod/Plugin: ProjectPortals. Affected Module(s): teleport, back, home, warp.

ProjectPortals takes over some teleport related commands in non-default scenarios

Info

Reason: ProjectPortals may override some teleport related commands such as `/back`, `/warp` and `/home` if some of the ProjectPortals modules are enabled.

Resolution: Disable the module affecting the commands in PJP or prefix the command with "n", that is, "/back" -> "/nback".

/back
Module: back
Allows a user to return to their last place before death or warp.

Aliases: /back, /return

Usage: /back [-b|--border <b>] [-f|--force <f>]

Default Role: ADMIN

Basic Command Permission: nucleus.back.base

Permissions

  • nucleus.back.base - Default Role: ADMIN
    Allows the user to run the command /back
  • nucleus.back.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /back
  • nucleus.back.exempt.samedimension - Default Role: MOD
    If granted, players can return across dimensions even when only-same-dimension is enabled.
  • nucleus.back.exempt.bordercheck - Default Role: ADMIN
    If granted, allows the user to the use "-b" flag to attempt to warp outside of the border.
  • nucleus.back.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /back
  • nucleus.back.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /back

This command is an equivalent to the following command(s) in Essentials: /back, /return

/clearback
Module: back
Allows a user to clear another user's current "back" position.

Aliases: /clearback

Usage: /clearback [<user>]

Default Role: ADMIN

Basic Command Permission: nucleus.clearback.base

Permissions

  • nucleus.clearback.base - Default Role: ADMIN
    Allows the user to run the command /clearback
Permission Suggested Role Description
nucleus.back.base ADMIN Allows the user to run the command /back
nucleus.back.exempt.bordercheck ADMIN If granted, allows the user to the use "-b" flag to attempt to warp outside of the border.
nucleus.back.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /back
nucleus.back.exempt.cost ADMIN Allows the user to bypass the cost for /back
nucleus.back.exempt.samedimension MOD If granted, players can return across dimensions even when only-same-dimension is enabled.
nucleus.back.exempt.warmup ADMIN Allows the user to bypass the warmup for /back
nucleus.back.targets.death USER Sets the player's /back location on death
nucleus.back.targets.portal USER Sets the player's /back location on portal teleports.
nucleus.back.targets.teleport USER Sets the player's /back location on returnable teleports.
nucleus.clearback.base ADMIN Allows the user to run the command /clearback
nucleus.clearback.others ADMIN Allows the user to target other players using the command "clearback".
The following configuration is the default for this module: 
                            # Log player's location on death.
on-death=true
# Log player's last location after travelling through a portal.
on-portal=false
# Log player's last location on warp.
on-teleport=true
# If true, when a player is in a different dimension than the back target, then this player will require the nucleus.back.exempt.samedimension permission to be able to go back.
only-same-dimension=false
Search
Downloading search database, this won't take long...