Package org.mvplugins.multiverse.netherportals.config

Class NetherPortalsConfig

java.lang.Object
org.mvplugins.multiverse.netherportals.config.NetherPortalsConfig
@AvailableSince("5.1") @Service public final class NetherPortalsConfig extends Object
Provides typed access to the Multiverse-NetherPortals configuration.
Since:
5.1

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CONFIG_FILENAME
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getEndPrefix()
    Gets the prefix used to identify End worlds.
    String
    getEndSuffix()
    Gets the suffix used to identify End worlds.
    String
    getNetherPrefix()
    Gets the prefix used to identify Nether worlds.
    String
    getNetherSuffix()
    Gets the suffix used to identify Nether worlds.
    org.bukkit.configuration.file.FileConfiguration
    getRawConfig()
    Gets the raw configuration while legacy links are being migrated.
    org.mvplugins.multiverse.core.config.handle.StringPropertyHandle
    getStringPropertyHandle()
    Gets the string property handle for configuration commands.
    boolean
    isEndPlatformDropBlocks()
    Checks whether replaced End platform blocks drop as items.
    boolean
    isLoaded()
    Checks whether config.yml has been loaded.
    boolean
    isSendingDisabledPortalMessage()
    Checks whether players are notified about disabled portals.
    boolean
    isSendingNoDestinationMessage()
    Checks whether players are notified when portals have no destination.
    boolean
    isTeleportingEntities()
    Checks whether non-player entities can use portals.
    boolean
    isUsingBounceBack()
    Checks whether unavailable portals bounce players back.
    org.mvplugins.multiverse.external.vavr.control.Try<Void>
    load()
    Loads and migrates config.yml.
    org.mvplugins.multiverse.external.vavr.control.Try<Void>
    save()
    Saves config.yml.
    org.mvplugins.multiverse.external.vavr.control.Try<Void>
    setEndPlatformDropBlocks(boolean endPlatformDropBlocks)
    Sets whether replaced End platform blocks drop as items.
    org.mvplugins.multiverse.external.vavr.control.Try<Void>
    setEndPrefix(String endPrefix)
    Sets the prefix used to identify End worlds.
    org.mvplugins.multiverse.external.vavr.control.Try<Void>
    setEndSuffix(String endSuffix)
    Sets the suffix used to identify End worlds.
    org.mvplugins.multiverse.external.vavr.control.Try<Void>
    setHandleEndExitRespawn(boolean handleEndExitRespawn)
    Sets whether Multiverse should override end portal exits and respawn players in the linked world's spawn.
    org.mvplugins.multiverse.external.vavr.control.Try<Void>
    setNetherPrefix(String netherPrefix)
    Sets the prefix used to identify Nether worlds.
    org.mvplugins.multiverse.external.vavr.control.Try<Void>
    setNetherSuffix(String netherSuffix)
    Sets the suffix used to identify Nether worlds.
    org.mvplugins.multiverse.external.vavr.control.Try<Void>
    setSendingDisabledPortalMessage(boolean sendingDisabledPortalMessage)
    Sets whether players are notified about disabled portals.
    org.mvplugins.multiverse.external.vavr.control.Try<Void>
    setSendingNoDestinationMessage(boolean sendingNoDestinationMessage)
    Sets whether players are notified when portals have no destination.
    org.mvplugins.multiverse.external.vavr.control.Try<Void>
    setTeleportingEntities(boolean teleportingEntities)
    Sets whether non-player entities can use portals.
    org.mvplugins.multiverse.external.vavr.control.Try<Void>
    setUsingBounceBack(boolean usingBounceBack)
    Sets whether unavailable portals bounce players back.
    boolean
    shouldHandleEndExitRespawn()
    Checks whether Multiverse should override end portal exits and respawn players in the linked world's spawn.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Method Details

    • load

      @AvailableSince("5.1") public org.mvplugins.multiverse.external.vavr.control.Try<Void> load()
      Loads and migrates config.yml.
      Returns:
      The result of the load operation.
      Since:
      5.1

    • isLoaded

      @AvailableSince("5.1") public boolean isLoaded()
      Checks whether config.yml has been loaded.
      Returns:
      Whether the configuration is loaded.
      Since:
      5.1

    • save

      @AvailableSince("5.1") public org.mvplugins.multiverse.external.vavr.control.Try<Void> save()
      Saves config.yml.
      Returns:
      The result of the save operation.
      Since:
      5.1

    • getStringPropertyHandle

      @AvailableSince("5.1") public org.mvplugins.multiverse.core.config.handle.StringPropertyHandle getStringPropertyHandle()
      Gets the string property handle for configuration commands.
      Returns:
      The string property handle.
      Since:
      5.1

    • setNetherPrefix

      @AvailableSince("5.1") public org.mvplugins.multiverse.external.vavr.control.Try<Void> setNetherPrefix(String netherPrefix)
      Sets the prefix used to identify Nether worlds.
      Parameters:
      netherPrefix - The Nether world prefix.
      Returns:
      The result of the update.
      Since:
      5.1

    • getNetherPrefix

      @AvailableSince("5.1") public String getNetherPrefix()
      Gets the prefix used to identify Nether worlds.
      Returns:
      The Nether world prefix.
      Since:
      5.1

    • setNetherSuffix

      @AvailableSince("5.1") public org.mvplugins.multiverse.external.vavr.control.Try<Void> setNetherSuffix(String netherSuffix)
      Sets the suffix used to identify Nether worlds.
      Parameters:
      netherSuffix - The Nether world suffix.
      Returns:
      The result of the update.
      Since:
      5.1

    • getNetherSuffix

      @AvailableSince("5.1") public String getNetherSuffix()
      Gets the suffix used to identify Nether worlds.
      Returns:
      The Nether world suffix.
      Since:
      5.1

    • setEndPrefix

      @AvailableSince("5.1") public org.mvplugins.multiverse.external.vavr.control.Try<Void> setEndPrefix(String endPrefix)
      Sets the prefix used to identify End worlds.
      Parameters:
      endPrefix - The End world prefix.
      Returns:
      The result of the update.
      Since:
      5.1

    • getEndPrefix

      @AvailableSince("5.1") public String getEndPrefix()
      Gets the prefix used to identify End worlds.
      Returns:
      The End world prefix.
      Since:
      5.1

    • setEndSuffix

      @AvailableSince("5.1") public org.mvplugins.multiverse.external.vavr.control.Try<Void> setEndSuffix(String endSuffix)
      Sets the suffix used to identify End worlds.
      Parameters:
      endSuffix - The End world suffix.
      Returns:
      The result of the update.
      Since:
      5.1

    • getEndSuffix

      @AvailableSince("5.1") public String getEndSuffix()
      Gets the suffix used to identify End worlds.
      Returns:
      The End world suffix.
      Since:
      5.1

    • shouldHandleEndExitRespawn

      @AvailableSince("5.1") public boolean shouldHandleEndExitRespawn()
      Checks whether Multiverse should override end portal exits and respawn players in the linked world's spawn.
      Returns:
      Whether end exit respawn is enabled.
      Since:
      5.1

    • setHandleEndExitRespawn

      @AvailableSince("5.1") public org.mvplugins.multiverse.external.vavr.control.Try<Void> setHandleEndExitRespawn(boolean handleEndExitRespawn)
      Sets whether Multiverse should override end portal exits and respawn players in the linked world's spawn.
      Parameters:
      handleEndExitRespawn - Whether end exit respawn should be enabled.
      Returns:
      The result of the update.
      Since:
      5.1

    • isUsingBounceBack

      @AvailableSince("5.1") public boolean isUsingBounceBack()
      Checks whether unavailable portals bounce players back.
      Returns:
      Whether bounceback is enabled.
      Since:
      5.1

    • setUsingBounceBack

      @AvailableSince("5.1") public org.mvplugins.multiverse.external.vavr.control.Try<Void> setUsingBounceBack(boolean usingBounceBack)
      Sets whether unavailable portals bounce players back.
      Parameters:
      usingBounceBack - Whether bounceback should be enabled.
      Returns:
      The result of the update.
      Since:
      5.1

    • isTeleportingEntities

      @AvailableSince("5.1") public boolean isTeleportingEntities()
      Checks whether non-player entities can use portals.
      Returns:
      Whether entity teleportation is enabled.
      Since:
      5.1

    • setTeleportingEntities

      @AvailableSince("5.1") public org.mvplugins.multiverse.external.vavr.control.Try<Void> setTeleportingEntities(boolean teleportingEntities)
      Sets whether non-player entities can use portals.
      Parameters:
      teleportingEntities - Whether entity teleportation should be enabled.
      Returns:
      The result of the update.
      Since:
      5.1

    • isSendingDisabledPortalMessage

      @AvailableSince("5.1") public boolean isSendingDisabledPortalMessage()
      Checks whether players are notified about disabled portals.
      Returns:
      Whether disabled portal messages are enabled.
      Since:
      5.1

    • setSendingDisabledPortalMessage

      @AvailableSince("5.1") public org.mvplugins.multiverse.external.vavr.control.Try<Void> setSendingDisabledPortalMessage(boolean sendingDisabledPortalMessage)
      Sets whether players are notified about disabled portals.
      Parameters:
      sendingDisabledPortalMessage - Whether disabled portal messages should be enabled.
      Returns:
      The result of the update.
      Since:
      5.1

    • isSendingNoDestinationMessage

      @AvailableSince("5.1") public boolean isSendingNoDestinationMessage()
      Checks whether players are notified when portals have no destination.
      Returns:
      Whether no-destination messages are enabled.
      Since:
      5.1

    • setSendingNoDestinationMessage

      @AvailableSince("5.1") public org.mvplugins.multiverse.external.vavr.control.Try<Void> setSendingNoDestinationMessage(boolean sendingNoDestinationMessage)
      Sets whether players are notified when portals have no destination.
      Parameters:
      sendingNoDestinationMessage - Whether no-destination messages should be enabled.
      Returns:
      The result of the update.
      Since:
      5.1

    • isEndPlatformDropBlocks

      @AvailableSince("5.1") public boolean isEndPlatformDropBlocks()
      Checks whether replaced End platform blocks drop as items.
      Returns:
      Whether replaced blocks should drop as items.
      Since:
      5.1

    • setEndPlatformDropBlocks

      @AvailableSince("5.1") public org.mvplugins.multiverse.external.vavr.control.Try<Void> setEndPlatformDropBlocks(boolean endPlatformDropBlocks)
      Sets whether replaced End platform blocks drop as items.
      Parameters:
      endPlatformDropBlocks - Whether replaced blocks should drop as items.
      Returns:
      The result of the update.
      Since:
      5.1

    • getRawConfig

      @Internal @AvailableSince("5.1") public org.bukkit.configuration.file.FileConfiguration getRawConfig()
      Gets the raw configuration while legacy links are being migrated.
      Returns:
      The underlying configuration.
      Since:
      5.1