Package io.github.thebusybiscuit.slimefun4.core.services

Class PerWorldSettingsService

java.lang.Object
io.github.thebusybiscuit.slimefun4.core.services.PerWorldSettingsService
public class PerWorldSettingsService extends Object
This Service is responsible for disabling a SlimefunItem in a certain World.
Author:
TheBusyBiscuit

  • Constructor Summary

    Constructors
    Constructor
    Description
    PerWorldSettingsService(Slimefun plugin)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isAddonEnabled(org.bukkit.World world, SlimefunAddon addon)
    This method checks whether the given SlimefunAddon is enabled in that World.
    boolean
    isEnabled(org.bukkit.World world, SlimefunItem item)
    This method checks whether the given SlimefunItem is enabled in the given World.
    boolean
    isWorldEnabled(org.bukkit.World world)
    This checks whether the given World is enabled or not.
    void
    load(Iterable<org.bukkit.World> worlds)
    This method will forcefully load all currently active Worlds to load up their settings.
    void
    load(org.bukkit.World world)
    This method loads the given World if it was not loaded before.
    void
    save(org.bukkit.World world)
    This will forcefully save the settings for that World.
    void
    setEnabled(org.bukkit.World world, boolean enabled)
    This method enables or disables the given World.
    void
    setEnabled(org.bukkit.World world, SlimefunItem item, boolean enabled)
    This method enables or disables the given SlimefunItem in the specified World.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PerWorldSettingsService

      public PerWorldSettingsService(@Nonnull Slimefun plugin)

  • Method Details

    • load

      public void load(@Nonnull Iterable<org.bukkit.World> worlds)
      This method will forcefully load all currently active Worlds to load up their settings.
      Parameters:
      worlds - An Iterable of Worlds to load

    • load

      public void load(@Nonnull org.bukkit.World world)
      This method loads the given World if it was not loaded before.
      Parameters:
      world - The World to load

    • isEnabled

      public boolean isEnabled(@Nonnull org.bukkit.World world, @Nonnull SlimefunItem item)
      This method checks whether the given SlimefunItem is enabled in the given World.
      Parameters:
      world - The World to check
      item - The SlimefunItem that should be checked
      Returns:
      Whether the given SlimefunItem is enabled in that World

    • setEnabled

      public void setEnabled(@Nonnull org.bukkit.World world, @Nonnull SlimefunItem item, boolean enabled)
      This method enables or disables the given SlimefunItem in the specified World.
      Parameters:
      world - The World in which to disable or enable the given SlimefunItem
      item - The SlimefunItem to enable or disable
      enabled - Whether the given SlimefunItem should be enabled in that world

    • setEnabled

      public void setEnabled(@Nonnull org.bukkit.World world, boolean enabled)
      This method enables or disables the given World.
      Parameters:
      world - The World to enable or disable
      enabled - Whether this World should be enabled or not

    • isWorldEnabled

      public boolean isWorldEnabled(@Nonnull org.bukkit.World world)
      This checks whether the given World is enabled or not.
      Parameters:
      world - The World to check
      Returns:
      Whether this World is enabled

    • isAddonEnabled

      public boolean isAddonEnabled(@Nonnull org.bukkit.World world, @Nonnull SlimefunAddon addon)
      This method checks whether the given SlimefunAddon is enabled in that World.
      Parameters:
      world - The World to check
      addon - The SlimefunAddon to check
      Returns:
      Whether this addon is enabled in that World

    • save

      public void save(@Nonnull org.bukkit.World world)
      This will forcefully save the settings for that World. This should only be called if you altered the settings while the Server was still running. This writes to a File so it can be a heavy operation.
      Parameters:
      world - The World to save