Package org.sgrewritten.stargate.api.config

Enum Class ConfigurationOption

java.lang.Object
java.lang.Enum<ConfigurationOption>
org.sgrewritten.stargate.api.config.ConfigurationOption
All Implemented Interfaces:
Serializable, Comparable<ConfigurationOption>, Constable
public enum ConfigurationOption extends Enum<ConfigurationOption>
An enum containing all available settings/configuration options
Author:
Thorin

  • Enum Constant Details

    • DEFAULT_NETWORK

      public static final ConfigurationOption DEFAULT_NETWORK
      The default network if no network is specified

    • LEGACY_BUNGEE_NETWORK

      public static final ConfigurationOption LEGACY_BUNGEE_NETWORK
      The network used for all legacy BungeeCord Stargates

    • LANGUAGE

      public static final ConfigurationOption LANGUAGE
      The language used for all translatable messages

    • USING_BUNGEE

      public static final ConfigurationOption USING_BUNGEE
      Whether BungeeCord functionality is enabled

    • GATE_LIMIT

      public static final ConfigurationOption GATE_LIMIT
      The maximum number of stargates on a single network

    • USE_ECONOMY

      public static final ConfigurationOption USE_ECONOMY
      Whether to enable economy functionality for stargate interaction

    • TAX_DESTINATION

      public static final ConfigurationOption TAX_DESTINATION
      The UUID to pay any taxes to

    • CREATION_COST

      public static final ConfigurationOption CREATION_COST
      The cost of creating a new stargate

    • DESTROY_COST

      public static final ConfigurationOption DESTROY_COST
      The cost of destroying a stargate

    • USE_COST

      public static final ConfigurationOption USE_COST
      The cost of using (teleporting through) a stargate

    • GATE_OWNER_REVENUE

      public static final ConfigurationOption GATE_OWNER_REVENUE
      Whether to send any transaction fees to the gate owner's balance

    • CHARGE_FREE_DESTINATION

      public static final ConfigurationOption CHARGE_FREE_DESTINATION
      Whether to charge for a teleportation from a non-free stargate even if the destination is free

    • DEFAULT_SIGN_COLOR

      public static final ConfigurationOption DEFAULT_SIGN_COLOR
      The default color to use for signs

    • POINTER_BEHAVIOR

      public static final ConfigurationOption POINTER_BEHAVIOR
      How should SG style its pointer symbol?

    • GATE_EXIT_SPEED_MULTIPLIER

      public static final ConfigurationOption GATE_EXIT_SPEED_MULTIPLIER
      The multiplier to use for the exit speed when leaving a Stargate

      If the multiplier is 0, the behaviour is the same as in legacy. If the multiplier is 1, it's the same as the entry speed. 2 = double, 0.5 = half.

    • DISABLE_CUSTOM_COLORED_NAMES

      public static final ConfigurationOption DISABLE_CUSTOM_COLORED_NAMES
      Whether to strip any color tags from stargate names and inter-server networks

    • DEBUG_LEVEL

      public static final ConfigurationOption DEBUG_LEVEL
      The level of debugging/warning messages to display

    • CONFIG_VERSION

      public static final ConfigurationOption CONFIG_VERSION
      The version of the configuration. Use for updating the config file

    • DATABASE_NAME

      public static final ConfigurationOption DATABASE_NAME
      The name of the .db file if using SQLite

    • USING_REMOTE_DATABASE

      public static final ConfigurationOption USING_REMOTE_DATABASE
      Whether to use a "real" database instead of just a .db file

    • SHOW_HIKARI_CONFIG

      public static final ConfigurationOption SHOW_HIKARI_CONFIG
      Whether to use database settings from a Hikari config file instead of the settings in the config file

    • BUNGEE_DRIVER

      public static final ConfigurationOption BUNGEE_DRIVER
      The database driver to use, if using a remote database

    • BUNGEE_DATABASE

      public static final ConfigurationOption BUNGEE_DATABASE
      The name of the used database, if using a remote database

    • BUNGEE_PORT

      public static final ConfigurationOption BUNGEE_PORT
      The port of the used database, if using a remote database

    • BUNGEE_ADDRESS

      public static final ConfigurationOption BUNGEE_ADDRESS
      The address of the used database, if using a remote database

    • BUNGEE_USERNAME

      public static final ConfigurationOption BUNGEE_USERNAME
      The username for the used database, if using a remote database

    • BUNGEE_PASSWORD

      public static final ConfigurationOption BUNGEE_PASSWORD
      The password for the used database, if using a remote database

    • BUNGEE_USE_SSL

      public static final ConfigurationOption BUNGEE_USE_SSL
      Whether to use an SSL connection, if using a remote database

    • BUNGEE_INSTANCE_NAME

      public static final ConfigurationOption BUNGEE_INSTANCE_NAME
      When using remote database, what should the name of the proxy be?

    • DESTROY_ON_EXPLOSION

      public static final ConfigurationOption DESTROY_ON_EXPLOSION
      Allow explosions to destroy portals

    • HANDLE_VEHICLES

      public static final ConfigurationOption HANDLE_VEHICLES
      Allow vehicles to teleport without any player inside

    • REMEMBER_LAST_DESTINATION

      public static final ConfigurationOption REMEMBER_LAST_DESTINATION
      Remember the last destination a networked portal was connected to

    • UPKEEP_COST

      public static final ConfigurationOption UPKEEP_COST
      TODO: Unimplemented

    • PORTAL_VALIDITY

      public static final ConfigurationOption PORTAL_VALIDITY
      The action that should be made whenever a loaded portal does not have a valid layout

    • HANDLE_LEASHES

      public static final ConfigurationOption HANDLE_LEASHES
      Handle leashed entities during teleportation

    • DEFAULT_TERMINAL_NAME

      public static final ConfigurationOption DEFAULT_TERMINAL_NAME
      TODO: Unimplemented

    • ENABLE_OWNED_GATES

      public static final ConfigurationOption ENABLE_OWNED_GATES
      Allows users to use/break any gates they create, regardless of any permissions that may prevent them from doing so

    • SPECIFIC_PROTECTION_OVERRIDE

      public static final ConfigurationOption SPECIFIC_PROTECTION_OVERRIDE
      Allows for specific events to destroy portals

    • GATE_FOLDER

      public static final ConfigurationOption GATE_FOLDER
      The folder to load gate files from

  • Method Details

    • values

      public static ConfigurationOption[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ConfigurationOption valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getDataType

      public OptionDataType getDataType()
      Gets the data type used for storing this config option
      Returns:

      The data type used

    • getConfigNode

      public String getConfigNode()
      Gets the config file string node corresponding to this setting
      Returns:

      The config file string node corresponding to this setting

    • getDescription

      public String getDescription()
      Gets the description of what this config option does
      Returns:

      The description of this config option

    • getDefaultValue

      public Object getDefaultValue()
      Gets this config option's default value
      Returns:

      This config option's default value

    • isHidden

      public boolean isHidden()
      Gets whether this configuration option is hidden

      A hidden configuration option should not be provided to users unless they are really advanced users and have an obscure need to change the value.

      Returns:

      Whether this configuration option is hidden