SettingsManager

Access plugin configuration settings and values

Overview

The SettingsManager interface provides access to all plugin configuration settings from config.yml. Access it via SuperiorSkyblockAPI.getSettings().

General Settings

getCalcInterval() · long

The amount of time between auto-calculations that the plugin runs. If set to 0, the task is disabled.

Config path: calc-interval

Returns: Time in ticks

getIslandCommand() · String

The main command of the plugin. Aliases can be added by adding ”,” after the command name.

Config path: island-command

Returns: The main command name

getMaxIslandSize() · int

The maximum island size.

Config path: max-island-size

Returns: Maximum size in blocks

getIslandHeight() · int

The default height islands will generate.

Config path: islands-height

Returns: Height in blocks

isWorldBorders() · boolean

Whether world borders are enabled for islands or not.

Config path: world-borders

Returns: True if world borders are enabled

Database Settings

getDatabase() · Database

All settings related to the database of the plugin.

Config path: database

Returns: Database settings interface

The Database interface includes:

• getType() - Database type (SQLite or MySQL)
• isBackup() - Whether backup is enabled
• getAddress() - MySQL address
• getPort() - MySQL port
• getDBName() - Database name
• getUsername() - MySQL username
• getPassword() - MySQL password
• getPrefix() - Table prefix
• hasSSL() - SSL enabled
• hasPublicKeyRetrieval() - Public key retrieval
• getWaitTimeout() - Wait timeout in milliseconds
• getMaxLifetime() - Max lifetime in milliseconds

Default Values

getDefaultValues() · DefaultValues

All the default values for new islands that are created.

Config path: default-values

Returns: DefaultValues settings interface

The DefaultValues interface includes:

• getIslandSize() - Default island size
• getBlockLimits() - Map of block limits
• getEntityLimits() - Map of entity limits
• getWarpsLimit() - Default warps limit
• getTeamLimit() - Default team limit
• getCoopLimit() - Default coops limit
• getCropGrowth() - Default crop growth multiplier
• getSpawnerRates() - Default spawner rates multiplier
• getMobDrops() - Default mob drops multiplier
• getBankLimit() - Default bank limit
• getGeneratorsMap() - Map of generator rates by dimension
• getRoleLimits() - Map of role limits
• getIslandEffects() - Map of island effects

Island Level & Worth

getIslandLevelFormula() · String

The formula used to calculate a block’s level when it has a worth defined but no level specified. The formula can contain a placeholder: {}, which is replaced with the block worth.

Config path: block-level-formula

Returns: The formula string

isRoundedIslandLevels() · boolean

Whether island levels should be rounded or not.

Config path: rounded-island-level

Returns: True if rounding is enabled

getIslandLevelRoundingMode() · RoundingMode

The rounding mode used for the island level when rounded-island-level feature is enabled.

Config path: island-level-rounding-mode

Returns: The RoundingMode enum value

isAutoBlocksTracking() · boolean

Whether to automatically track block counts when players place and break blocks.

Config path: auto-blocks-tracking

Returns: True if auto tracking is enabled

getSyncWorth() · BlockValuesManager.SyncWorthStatus

The sync-worth status of the plugin.

Config path: sync-worth

Returns: The sync worth status

isNegativeWorth() · boolean

Whether island-worth can be negative or not.

Config path: negative-worth

Returns: True if negative worth is allowed

isNegativeLevel() · boolean

Whether island-level can be negative or not.

Config path: negative-level

Returns: True if negative level is allowed

Island Top & Sorting

getIslandTopOrder() · String

The default island-top sorting type.

Config path: island-top-order

Returns: The sorting type name

isIslandTopIncludeLeader() · boolean

Whether the members list shown in island top should include the leader or not.

Config path: island-top-include-leader

Returns: True if leader should be included

getTopIslandMembersSorting() · TopIslandMembersSorting

Get the way to sort members in the top islands menu.

Config path: island-top-members-sorting

Returns: The sorting method

Island Names

getIslandNames() · IslandNames

All settings related to island-names.

Config path: island-names

Returns: IslandNames settings interface

The IslandNames interface includes:

• isRequiredForCreation() - Whether a name is required
• getMaxLength() - Maximum name length
• getMinLength() - Minimum name length
• getFilteredNames() - List of forbidden names
• isColorSupport() - Whether color codes are supported
• isIslandTop() - Whether names show in island top
• isPreventPlayerNames() - Prevent using player names
• isAnnounceChangeToAll() - Announce name changes

Island Roles

getIslandRoles() · IslandRoles

All settings related to the island-roles.

Config path: island-roles

Returns: IslandRoles settings interface

Worlds

getWorlds() · Worlds

All settings related to the worlds of the plugin.

Config path: worlds

Returns: Worlds settings interface

The Worlds interface includes:

• getDefaultWorldDimension() - Default world dimension
• getWorldName() - Overworld world name
• getDefaultWorldName() - Default world name
• getNormal() - Normal world settings
• getNether() - Nether world settings
• getEnd() - End world settings
• getDimensionConfig(Dimension) - Settings for a dimension
• getDifficulty() - World difficulty
• getSeaLevelHeight() - Sea level height

Spawn Island

getSpawn() · Spawn

All settings related to the spawn island.

Config path: spawn

Returns: Spawn settings interface

The Spawn interface includes:

• getLocation() - Spawn location string
• isProtected() - Whether spawn is protected
• getSettings() - List of enabled flags
• getPermissions() - List of permissions
• isWorldBorder() - Whether world border is enabled
• getSize() - Spawn island size
• isPlayersDamage() - Whether players take damage

Stacked Blocks

getStackedBlocks() · StackedBlocks

All settings related to the stacked-blocks system of the plugin.

Config path: stacked-blocks

Returns: StackedBlocks settings interface

The StackedBlocks interface includes:

• isEnabled() - Whether stacked blocks are enabled
• getCustomName() - Custom hologram name
• getDisabledWorlds() - List of disabled worlds
• getWhitelisted() - Whitelisted block types
• getLimits() - Map of block stack limits
• isAutoCollect() - Whether auto-collect is enabled
• getDepositMenu() - Deposit menu settings

Teleportation

isTeleportOnCreate() · boolean

Whether to teleport players to their island when they create it or not.

Config path: teleport-on-create

Returns: True if enabled

isTeleportOnJoin() · boolean

Whether to teleport players to their island when they join it or not.

Config path: teleport-on-join

Returns: True if enabled

isTeleportOnKick() · boolean

Whether to teleport players to the spawn when they are kicked from their island or not.

Config path: teleport-on-kick

Returns: True if enabled

isTeleportOnLeave() · boolean

Whether to teleport players to the spawn when they leave an island or not.

Config path: teleport-on-leave

Returns: True if enabled

isTeleportOnPvPEnable() · boolean

Whether visitors on islands should get teleported to spawn when pvp is enabled on the island they were on or not.

Config path: teleport-on-pvp-enable

Returns: True if enabled

getWarpsWarmup() · long

Delay before teleporting to an island warp, in milliseconds. If 0, no delay will be applied.

Config path: warps-warmup

Returns: Delay in milliseconds

getHomeWarmup() · long

Delay before teleporting to island home, in milliseconds. If 0, no delay will be applied.

Config path: home-warmup

Returns: Delay in milliseconds

getVisitWarmup() · long

Delay before teleporting to another island, in milliseconds. If 0, no delay will be applied.

Config path: visit-warmup

Returns: Delay in milliseconds

Void Teleport

getVoidTeleport() · VoidTeleport

All settings related to the void teleportation.

Config path: void-teleport

Returns: VoidTeleport settings interface

The VoidTeleport interface includes:

• isMembers() - Whether members are teleported
• isVisitors() - Whether visitors are teleported

Player Inventory

getClearActionsOnDisband() · List<ClearAction>

Get the list of clear actions to perform on island members when their island is disbanded.

Config path: clear-on-disband

Returns: List of clear actions

getClearActionsOnJoin() · List<ClearAction>

Get the list of clear actions to perform on players when they accept an invite.

Config path: clear-on-join

Returns: List of clear actions

getClearActionsOnKick() · List<ClearAction>

Get the list of clear actions to perform on players when they are kicked from their island.

Config path: clear-on-kick

Returns: List of clear actions

getClearActionsOnLeave() · List<ClearAction>

Get the list of clear actions to perform on players when they leave an island.

Config path: clear-on-leave

Returns: List of clear actions

Confirmations

isBanConfirm() · boolean

Whether confirmation menu should be opened before banning a player from an island or not.

Config path: ban-confirm

Returns: True if confirmation is required

isDisbandConfirm() · boolean

Whether confirmation menu should be opened before disbanding an island or not.

Config path: disband-confirm

Returns: True if confirmation is required

isKickConfirm() · boolean

Whether confirmation menu should be opened before kicking an island member from an island or not.

Config path: kick-confirm

Returns: True if confirmation is required

isLeaveConfirm() · boolean

Whether confirmation menu should be opened before leaving an island or not.

Config path: leave-confirm

Returns: True if confirmation is required

isTransferConfirm() · boolean

Whether confirmation menu should be opened before transferring an island or not.

Config path: transfer-confirm

Returns: True if confirmation is required

Permissions & Damage

getWorldPermissions() · Collection<String>

A list of permissions players will have in the islands world, outside of islands.

Config path: world-permissions

Returns: Collection of permission strings

isVisitorsDamage() · boolean

Whether visitors should take damage on islands or not.

Config path: visitors-damage

Returns: True if visitors can take damage

isCoopDamage() · boolean

Whether coop players should take damage on islands or not.

Config path: coop-damage

Returns: True if coop players can take damage

isCoopMembers() · boolean

Whether coop members are enabled.

Config path: coop-members

Returns: True if coop is enabled

isEditPlayerPermissions() · boolean

Should players be able to edit island privileges for other players?

Config path: edit-player-permissions

Returns: True if editing is allowed

Commands

getCommandsCooldown() · Map<String, Pair<Integer, String>>

Cooldowns of commands for players. Represented by a map with keys as the command labels, and values as pairs containing the cooldown and a bypass permission.

Config path: commands-cooldown

Returns: Map of command cooldowns

getCommandAliases() · Map<String, List<String>>

Custom aliases for commands of the plugin. Represented by a map with keys as commands, and values as aliases.

Config path: command-aliases

Returns: Map of command aliases

getDisabledCommands() · List<String>

List of commands that should be disabled within the plugin.

Config path: disabled-commands

Returns: List of disabled command names

getBlockedVisitorsCommands() · List<String>

List of blocked commands that visitors cannot run on islands.

Config path: blocked-visitors-commands

Returns: List of blocked commands

getCommandsPerPage() · int

Amount of commands to be listed in the /is help and /is admin commands.

Config path: commands-per-page

Returns: Number of commands per page

isHelpOnInvalidCommand() · boolean

Whether players should receive a help instead of a INVALID_COMMAND message when using a command that doesn’t exist or not.

Config path: help-on-invalid-command

Returns: True if help should be shown

isHelpOnNoPermission() · boolean

Whether players should receive a help instead of a NO_COMMAND_PERMISSION message when using a command they don’t have permission for or not.

Config path: help-on-no-permission

Returns: True if help should be shown

Example Usage

import com.bgsoftware.superiorskyblock.api.SuperiorSkyblockAPI;
import com.bgsoftware.superiorskyblock.api.config.SettingsManager;

public class SettingsExample {
    public void example() {
        SettingsManager settings = SuperiorSkyblockAPI.getSettings();
        
        // Check if world borders are enabled
        if (settings.isWorldBorders()) {
            System.out.println("World borders are enabled");
        }
        
        // Get maximum island size
        int maxSize = settings.getMaxIslandSize();
        System.out.println("Max island size: " + maxSize);
        
        // Check database settings
        SettingsManager.Database db = settings.getDatabase();
        System.out.println("Database type: " + db.getType());
        
        // Get default island values
        SettingsManager.DefaultValues defaults = settings.getDefaultValues();
        int defaultSize = defaults.getIslandSize();
        int teamLimit = defaults.getTeamLimit();
        
        // Check teleportation settings
        boolean teleportOnCreate = settings.isTeleportOnCreate();
        long homeWarmup = settings.getHomeWarmup();
    }
}