SpongeConfigAPI (viaversion-parent 1.6.1-SNAPSHOT API)

java.lang.Object
- us.myles.ViaVersion.util.Config
- - us.myles.ViaVersion.sponge.platform.SpongeConfigAPI

All Implemented Interfaces:: ConfigurationProvider, ViaVersionConfig

public class SpongeConfigAPI
extends Config
implements ViaVersionConfig

Constructor Summary

Constructors
Constructor and Description

SpongeConfigAPI(org.spongepowered.api.plugin.PluginContainer pluginContainer, File configFile)

Constructors
Constructor and Description
`SpongeConfigAPI(org.spongepowered.api.plugin.PluginContainer pluginContainer, File configFile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBlockedDisconnectMsg()` Get the custom disconnect message
`List<Integer>`	`getBlockedProtocols()` Get the blocked protocols
`URL`	`getDefaultConfigURL()`
`double`	`getHologramYOffset()` Get the vertical offset armor stands are being moved with when the hologram patch is enabled
`int`	`getMaxPPS()` Get the maximum number of packets a client can send per second.
`String`	`getMaxPPSKickMessage()` Get the kick message sent if the user hits the max packets per second.
`int`	`getMaxWarnings()` Get the maximum number of warnings the client can have in the interval
`String`	`getMaxWarningsKickMessage()` Get the kick message sent if the user goes over the warnings in the interval
`int`	`getPistonReplacementId()` Get the id for replacing extended pistons.
`String`	`getReloadDisconnectMsg()` Get the message sent to players being kicked on reload.
`int`	`getTrackingPeriod()` The time in seconds that should be tracked for warnings
`List<String>`	`getUnsupportedOptions()`
`int`	`getWarningPPS()` The number of packets per second to count as a warning
`protected void`	`handleConfig(Map<String,Object> config)`
`boolean`	`is1_12NBTArrayFix()` Should we fix nbt array's in json chat messages for 1.12 clients
`boolean`	`is1_12QuickMoveActionFix()` Should we fix shift quick move action for 1.12 clients
`boolean`	`is1_13TeamColourFix()` Should we make team colours based on the last colour in team prefix
`boolean`	`isAntiXRay()` Is anti-xray enabled?
`boolean`	`isAutoTeam()` Get if players will be automatically put in the same team when collision preventing is enabled
`boolean`	`isBlockBreakPatch()` Get if our block break patch is enabled to prevent weird ghost glitches.
`boolean`	`isBossbarAntiflicker()` Get if the boss bars for 1.9 & 1.10 clients are being stopped from flickering This will keep all boss bars on 100% (not recommended)
`boolean`	`isBossbarPatch()` Get if boss bars are fixed for 1.9 & 1.10 clients
`boolean`	`isCheckForUpdates()` Get if the plugin should check for updates
`boolean`	`isDisable1_13AutoComplete()` Should we disable the 1.13 auto-complete feature to stop spam kicks? (for any server lower than 1.13)
`boolean`	`isForceJsonTransform()` Force json transform
`boolean`	`isHologramPatch()` Get if armor stand positions are fixed so holograms show up at the correct height in 1.9 & 1.10
`boolean`	`isItemCache()` Use the item cache to prevent high resource usage
`boolean`	`isMinimizeCooldown()` Tries to minimize cooldown animation.
`boolean`	`isNewEffectIndicator()` Get if 1.9 & 1.10 clients are shown the new effect indicator in the top-right corner
`boolean`	`isNMSPlayerTicking()` Use the NMS player ticking
`boolean`	`isPistonAnimationPatch()` Get if the 1.11 piston animation patch is enabled
`boolean`	`isPreventCollision()` Get if collision preventing for players is enabled
`boolean`	`isReplacePistons()` Replace extended pistons on 1.10 chunk loading.
`boolean`	`isSendSupportedVersions()` Send supported versions in the status response packet
`boolean`	`isShieldBlocking()` Get if blocking in 1.9 & 1.10 appears as a player holding a shield
`boolean`	`isShowNewDeathMessages()` Get if 1.9 & 1.10 clients are shown the new death message on the death screen
`boolean`	`isStimulatePlayerTick()` Stimulate the player tick
`boolean`	`isSuppress1_13ConversionErrors()` Should we hide errors that occur when trying to converting to 1.13 data?
`boolean`	`isSuppressMetadataErrors()` Get if metadata errors will be suppressed
`boolean`	`isUnknownEntitiesSuppressed()` Get if unknown entity errors will be suppressed

Methods inherited from class us.myles.ViaVersion.util.Config
get, getBoolean, getDouble, getInt, getIntegerList, getString, getValues, loadConfig, reloadConfig, saveConfig, saveConfig, set

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SpongeConfigAPI
```
public SpongeConfigAPI(org.spongepowered.api.plugin.PluginContainer pluginContainer,
                       File configFile)
```
- Method Detail
  - getDefaultConfigURL
```
public URL getDefaultConfigURL()
```
    Specified by:
    
    getDefaultConfigURL in class Config
  - handleConfig
```
protected void handleConfig(Map<String,Object> config)
```
    Specified by:
    
    handleConfig in class Config
  - getUnsupportedOptions
```
public List<String> getUnsupportedOptions()
```
    Specified by:
    
    getUnsupportedOptions in class Config
  - isCheckForUpdates
```
public boolean isCheckForUpdates()
```
    Description copied from interface: ViaVersionConfig
    
    Get if the plugin should check for updates
    
    Specified by:
    
    isCheckForUpdates in interface ViaVersionConfig
    
    Returns:
    
    true if update checking is enabled
  - isPreventCollision
```
public boolean isPreventCollision()
```
    Description copied from interface: ViaVersionConfig
    
    Get if collision preventing for players is enabled
    
    Specified by:
    
    isPreventCollision in interface ViaVersionConfig
    
    Returns:
    
    true if collision preventing is enabled
  - isNewEffectIndicator
```
public boolean isNewEffectIndicator()
```
    Description copied from interface: ViaVersionConfig
    
    Get if 1.9 & 1.10 clients are shown the new effect indicator in the top-right corner
    
    Specified by:
    
    isNewEffectIndicator in interface ViaVersionConfig
    
    Returns:
    
    true if the using of the new effect indicator is enabled
  - isShowNewDeathMessages
```
public boolean isShowNewDeathMessages()
```
    Description copied from interface: ViaVersionConfig
    
    Get if 1.9 & 1.10 clients are shown the new death message on the death screen
    
    Specified by:
    
    isShowNewDeathMessages in interface ViaVersionConfig
    
    Returns:
    
    true if enabled
  - isSuppressMetadataErrors
```
public boolean isSuppressMetadataErrors()
```
    Description copied from interface: ViaVersionConfig
    
    Get if metadata errors will be suppressed
    
    Specified by:
    
    isSuppressMetadataErrors in interface ViaVersionConfig
    
    Returns:
    
    true if metadata errors suppression is enabled
  - isShieldBlocking
```
public boolean isShieldBlocking()
```
    Description copied from interface: ViaVersionConfig
    
    Get if blocking in 1.9 & 1.10 appears as a player holding a shield
    
    Specified by:
    
    isShieldBlocking in interface ViaVersionConfig
    
    Returns:
    
    true if shield blocking is enabled
  - isHologramPatch
```
public boolean isHologramPatch()
```
    Description copied from interface: ViaVersionConfig
    
    Get if armor stand positions are fixed so holograms show up at the correct height in 1.9 & 1.10
    
    Specified by:
    
    isHologramPatch in interface ViaVersionConfig
    
    Returns:
    
    true if hologram patching is enabled
  - isPistonAnimationPatch
```
public boolean isPistonAnimationPatch()
```
    Description copied from interface: ViaVersionConfig
    
    Get if the 1.11 piston animation patch is enabled
    
    Specified by:
    
    isPistonAnimationPatch in interface ViaVersionConfig
    
    Returns:
    
    true if the piston patch is enabled.
  - isBossbarPatch
```
public boolean isBossbarPatch()
```
    Description copied from interface: ViaVersionConfig
    
    Get if boss bars are fixed for 1.9 & 1.10 clients
    
    Specified by:
    
    isBossbarPatch in interface ViaVersionConfig
    
    Returns:
    
    true if boss bar patching is enabled
  - isBossbarAntiflicker
```
public boolean isBossbarAntiflicker()
```
    Description copied from interface: ViaVersionConfig
    
    Get if the boss bars for 1.9 & 1.10 clients are being stopped from flickering This will keep all boss bars on 100% (not recommended)
    
    Specified by:
    
    isBossbarAntiflicker in interface ViaVersionConfig
    
    Returns:
    
    true if boss bar anti flickering is enabled
  - isUnknownEntitiesSuppressed
```
public boolean isUnknownEntitiesSuppressed()
```
    Description copied from interface: ViaVersionConfig
    
    Get if unknown entity errors will be suppressed
    
    Specified by:
    
    isUnknownEntitiesSuppressed in interface ViaVersionConfig
    
    Returns:
    
    true if boss bar patching is enabled
  - getHologramYOffset
```
public double getHologramYOffset()
```
    Description copied from interface: ViaVersionConfig
    
    Get the vertical offset armor stands are being moved with when the hologram patch is enabled
    
    Specified by:
    
    getHologramYOffset in interface ViaVersionConfig
    
    Returns:
    
    the vertical offset holograms will be moved with
  - isBlockBreakPatch
```
public boolean isBlockBreakPatch()
```
    Description copied from interface: ViaVersionConfig
    
    Get if our block break patch is enabled to prevent weird ghost glitches.
    
    Specified by:
    
    isBlockBreakPatch in interface ViaVersionConfig
    
    Returns:
    
    true if it is enabled.
  - getMaxPPS
```
public int getMaxPPS()
```
    Description copied from interface: ViaVersionConfig
    
    Get the maximum number of packets a client can send per second.
    
    Specified by:
    
    getMaxPPS in interface ViaVersionConfig
    
    Returns:
    
    The number of packets a client can send per second.
  - getMaxPPSKickMessage
```
public String getMaxPPSKickMessage()
```
    Description copied from interface: ViaVersionConfig
    
    Get the kick message sent if the user hits the max packets per second.
    
    Specified by:
    
    getMaxPPSKickMessage in interface ViaVersionConfig
    
    Returns:
    
    Kick message, with colour codes using '&'
  - getTrackingPeriod
```
public int getTrackingPeriod()
```
    Description copied from interface: ViaVersionConfig
    
    The time in seconds that should be tracked for warnings
    
    Specified by:
    
    getTrackingPeriod in interface ViaVersionConfig
    
    Returns:
    
    Time in seconds that should be tracked for warnings
  - getWarningPPS
```
public int getWarningPPS()
```
    Description copied from interface: ViaVersionConfig
    
    The number of packets per second to count as a warning
    
    Specified by:
    
    getWarningPPS in interface ViaVersionConfig
    
    Returns:
    
    The number of packets per second to count as a warning.
  - getMaxWarnings
```
public int getMaxWarnings()
```
    Description copied from interface: ViaVersionConfig
    
    Get the maximum number of warnings the client can have in the interval
    
    Specified by:
    
    getMaxWarnings in interface ViaVersionConfig
    
    Returns:
    
    The number of packets a client can send per second.
  - getMaxWarningsKickMessage
```
public String getMaxWarningsKickMessage()
```
    Description copied from interface: ViaVersionConfig
    
    Get the kick message sent if the user goes over the warnings in the interval
    
    Specified by:
    
    getMaxWarningsKickMessage in interface ViaVersionConfig
    
    Returns:
    
    Kick message, with colour codes using '&'
  - isAntiXRay
```
public boolean isAntiXRay()
```
    Description copied from interface: ViaVersionConfig
    
    Is anti-xray enabled?
    
    Specified by:
    
    isAntiXRay in interface ViaVersionConfig
    
    Returns:
    
    A boolean
  - isSendSupportedVersions
```
public boolean isSendSupportedVersions()
```
    Description copied from interface: ViaVersionConfig
    
    Send supported versions in the status response packet
    
    Specified by:
    
    isSendSupportedVersions in interface ViaVersionConfig
    
    Returns:
    
    If true, enabled
  - isStimulatePlayerTick
```
public boolean isStimulatePlayerTick()
```
    Description copied from interface: ViaVersionConfig
    
    Stimulate the player tick
    
    Specified by:
    
    isStimulatePlayerTick in interface ViaVersionConfig
    
    Returns:
    
    if true, enabled
  - isItemCache
```
public boolean isItemCache()
```
    Description copied from interface: ViaVersionConfig
    
    Use the item cache to prevent high resource usage
    
    Specified by:
    
    isItemCache in interface ViaVersionConfig
    
    Returns:
    
    if true, enabled
  - isNMSPlayerTicking
```
public boolean isNMSPlayerTicking()
```
    Description copied from interface: ViaVersionConfig
    
    Use the NMS player ticking
    
    Specified by:
    
    isNMSPlayerTicking in interface ViaVersionConfig
    
    Returns:
    
    if true, enabled
  - isReplacePistons
```
public boolean isReplacePistons()
```
    Description copied from interface: ViaVersionConfig
    
    Replace extended pistons on 1.10 chunk loading.
    
    Specified by:
    
    isReplacePistons in interface ViaVersionConfig
    
    Returns:
    
    True if to replace them
  - getPistonReplacementId
```
public int getPistonReplacementId()
```
    Description copied from interface: ViaVersionConfig
    
    Get the id for replacing extended pistons.
    
    Specified by:
    
    getPistonReplacementId in interface ViaVersionConfig
    
    Returns:
    
    The integer id
  - isAutoTeam
```
public boolean isAutoTeam()
```
    Description copied from interface: ViaVersionConfig
    
    Get if players will be automatically put in the same team when collision preventing is enabled
    
    Specified by:
    
    isAutoTeam in interface ViaVersionConfig
    
    Returns:
    
    true if automatic teaming is enabled
  - isForceJsonTransform
```
public boolean isForceJsonTransform()
```
    Description copied from interface: ViaVersionConfig
    
    Force json transform
    
    Specified by:
    
    isForceJsonTransform in interface ViaVersionConfig
    
    Returns:
    
    True if enabled
  - is1_12NBTArrayFix
```
public boolean is1_12NBTArrayFix()
```
    Description copied from interface: ViaVersionConfig
    
    Should we fix nbt array's in json chat messages for 1.12 clients
    
    Specified by:
    
    is1_12NBTArrayFix in interface ViaVersionConfig
    
    Returns:
    
    True if enabled
  - is1_12QuickMoveActionFix
```
public boolean is1_12QuickMoveActionFix()
```
    Description copied from interface: ViaVersionConfig
    
    Should we fix shift quick move action for 1.12 clients
    
    Specified by:
    
    is1_12QuickMoveActionFix in interface ViaVersionConfig
    
    Returns:
    
    True if enabled
  - getBlockedProtocols
```
public List<Integer> getBlockedProtocols()
```
    Description copied from interface: ViaVersionConfig
    
    Get the blocked protocols
    
    Specified by:
    
    getBlockedProtocols in interface ViaVersionConfig
    
    Returns:
    
    An Integer list
  - getBlockedDisconnectMsg
```
public String getBlockedDisconnectMsg()
```
    Description copied from interface: ViaVersionConfig
    
    Get the custom disconnect message
    
    Specified by:
    
    getBlockedDisconnectMsg in interface ViaVersionConfig
    
    Returns:
    
    Disconnect message
  - getReloadDisconnectMsg
```
public String getReloadDisconnectMsg()
```
    Description copied from interface: ViaVersionConfig
    
    Get the message sent to players being kicked on reload. Players are kicked to stop the server crashing
    
    Specified by:
    
    getReloadDisconnectMsg in interface ViaVersionConfig
    
    Returns:
    
    Disconnect message
  - isMinimizeCooldown
```
public boolean isMinimizeCooldown()
```
    Description copied from interface: ViaVersionConfig
    
    Tries to minimize cooldown animation.
    
    Specified by:
    
    isMinimizeCooldown in interface ViaVersionConfig
    
    Returns:
    
    True if enabled
  - is1_13TeamColourFix
```
public boolean is1_13TeamColourFix()
```
    Description copied from interface: ViaVersionConfig
    
    Should we make team colours based on the last colour in team prefix
    
    Specified by:
    
    is1_13TeamColourFix in interface ViaVersionConfig
    
    Returns:
    
    True if enabled
  - isSuppress1_13ConversionErrors
```
public boolean isSuppress1_13ConversionErrors()
```
    Description copied from interface: ViaVersionConfig
    
    Should we hide errors that occur when trying to converting to 1.13 data?
    
    Specified by:
    
    isSuppress1_13ConversionErrors in interface ViaVersionConfig
    
    Returns:
    
    True if enabled
  - isDisable1_13AutoComplete
```
public boolean isDisable1_13AutoComplete()
```
    Description copied from interface: ViaVersionConfig
    
    Should we disable the 1.13 auto-complete feature to stop spam kicks? (for any server lower than 1.13)
    
    Specified by:
    
    isDisable1_13AutoComplete in interface ViaVersionConfig
    
    Returns:
    
    True if enabled

Class SpongeConfigAPI

Constructor Summary

Method Summary

Methods inherited from class us.myles.ViaVersion.util.Config

Methods inherited from class java.lang.Object

Constructor Detail

SpongeConfigAPI

Method Detail

getDefaultConfigURL

handleConfig

getUnsupportedOptions

isCheckForUpdates

isPreventCollision

isNewEffectIndicator

isShowNewDeathMessages

isSuppressMetadataErrors

isShieldBlocking

isHologramPatch

isPistonAnimationPatch

isBossbarPatch

isBossbarAntiflicker

isUnknownEntitiesSuppressed

getHologramYOffset

isBlockBreakPatch

getMaxPPS

getMaxPPSKickMessage

getTrackingPeriod

getWarningPPS

getMaxWarnings

getMaxWarningsKickMessage

isAntiXRay

isSendSupportedVersions

isStimulatePlayerTick

isItemCache

isNMSPlayerTicking

isReplacePistons

getPistonReplacementId

isAutoTeam

isForceJsonTransform

is1_12NBTArrayFix

is1_12QuickMoveActionFix

getBlockedProtocols

getBlockedDisconnectMsg

getReloadDisconnectMsg

isMinimizeCooldown

is1_13TeamColourFix

isSuppress1_13ConversionErrors

isDisable1_13AutoComplete