Package com.thevoxelbox.voxelsniper.config

Class VoxelSniperConfig

java.lang.Object

com.thevoxelbox.voxelsniper.config.VoxelSniperConfig

public class VoxelSniperConfig
extends Object

Constructor Summary

Constructors

Constructor

Description

VoxelSniperConfig(boolean updateCheckerEnabled, int updateCheckerInterval, boolean messageOnLoginEnabled, boolean persistSessionsOnLogout, BlockType defaultBlockMaterial, BlockType defaultReplaceBlockMaterial, int defaultBrushSize, int litesniperMaxBrushSize, List<String> litesniperRestrictedMaterials, int brushSizeWarningThreshold, int defaultVoxelHeight, int defaultCylinderCenter, Map<String,Map<String,Object>> brushProperties)

Create a new cached voxel configuration, used runtime.

Method Summary

Modifier and Type	Method	Description
boolean	arePersistentSessionsEnabled()	Return if persistent sessions are enabled.
Map<String,Map<String,Object>>	getBrushProperties()	Return brush properties.
int	getBrushSizeWarningThreshold()	Gets brush size warning threshold.
BlockType	getDefaultBlockMaterial()	Return default block type
int	getDefaultBrushSize()	Return default brush size.
int	getDefaultCylinderCenter()	Return default cylinder center.
BlockType	getDefaultReplaceBlockMaterial()	Return default replace block type.
int	getDefaultVoxelHeight()	Return default voxel height.
int	getLitesniperMaxBrushSize()	Return maximum size of brushes that LiteSnipers can use.
List<String>	getLitesniperRestrictedMaterials()	Return List of restricted Litesniper materials.
int	getUpdateCheckerInterval()	Return update interval in hours.
boolean	isMessageOnLoginEnabled()	Return if the login message is enabled.
boolean	isUpdateCheckerEnabled()	Return if update checker is enabled.
void	saveBrushPropertyToConfig(String brush, String propertyKey, Object value)	Force saving a brush property and its value to config.

Methods inherited from class java.lang.Object

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

Constructor Details

VoxelSniperConfig

public VoxelSniperConfig(boolean updateCheckerEnabled,
 int updateCheckerInterval,
 boolean messageOnLoginEnabled,
 boolean persistSessionsOnLogout,
 BlockType defaultBlockMaterial,
 BlockType defaultReplaceBlockMaterial,
 int defaultBrushSize,
 int litesniperMaxBrushSize,
 List<String> litesniperRestrictedMaterials,
 int brushSizeWarningThreshold,
 int defaultVoxelHeight,
 int defaultCylinderCenter,
 Map<String,Map<String,Object>> brushProperties)

Create a new cached voxel configuration, used runtime.

Parameters:

updateCheckerEnabled - whether to check for updates

updateCheckerInterval - period to wait in hours in-between checks

messageOnLoginEnabled - if message on login is enabled

persistSessionsOnLogout - if snipers shall be removed on logout

defaultBlockMaterial - default block material

defaultReplaceBlockMaterial - default replace block material

defaultBrushSize - default brush size

litesniperMaxBrushSize - litesniper max brush size

litesniperRestrictedMaterials - litesniper restricted materials

brushSizeWarningThreshold - brush size warning threshold

defaultVoxelHeight - default voxel height

defaultCylinderCenter - default cylinder center

brushProperties - brush properties

Method Details

isUpdateCheckerEnabled

public boolean isUpdateCheckerEnabled()

Return if update checker is enabled.

Returns:

true if to check for updates periodically, false otherwise.

Since:

2.8.0

See Also:

• VoxelSniperConfigLoader.isUpdateCheckerEnabled()

getUpdateCheckerInterval

public int getUpdateCheckerInterval()

Return update interval in hours.

Returns:

interval in hours

Since:

2.8.0

See Also:

• VoxelSniperConfigLoader.getUpdateCheckerInterval()

isMessageOnLoginEnabled

public boolean isMessageOnLoginEnabled()

Return if the login message is enabled.

Returns:

true if message on login is enabled, false otherwise.

See Also:

• VoxelSniperConfigLoader.isMessageOnLoginEnabled()

arePersistentSessionsEnabled

public boolean arePersistentSessionsEnabled()

Return if persistent sessions are enabled.

Returns:

true if persistent session are enabled, false otherwise.

See Also:

• VoxelSniperConfigLoader.arePersistentSessionsEnabled()

getDefaultBlockMaterial

public BlockType getDefaultBlockMaterial()

Return default block type

Returns:

default type

See Also:

• VoxelSniperConfigLoader.getDefaultBlockMaterial()

getDefaultReplaceBlockMaterial

public BlockType getDefaultReplaceBlockMaterial()

Return default replace block type.

Returns:

default type

See Also:

• VoxelSniperConfigLoader.getDefaultReplaceBlockMaterial()

getDefaultBrushSize

public int getDefaultBrushSize()

Return default brush size.

Returns:

default size

See Also:

• VoxelSniperConfigLoader.getDefaultBrushSize()

getLitesniperMaxBrushSize

public int getLitesniperMaxBrushSize()

Return maximum size of brushes that LiteSnipers can use.

Returns:

maximum size

See Also:

• VoxelSniperConfigLoader.getLitesniperMaxBrushSize()

getLitesniperRestrictedMaterials

public List<String> getLitesniperRestrictedMaterials()

Return List of restricted Litesniper materials.

Returns:

List of restricted Litesniper materials

See Also:

• VoxelSniperConfigLoader.getLitesniperRestrictedMaterials()

getBrushSizeWarningThreshold

public int getBrushSizeWarningThreshold()

Gets brush size warning threshold.

Returns:

the brush size warning threshold

See Also:

• VoxelSniperConfigLoader.getBrushSizeWarningThreshold()

getDefaultVoxelHeight

public int getDefaultVoxelHeight()

Return default voxel height.

Returns:

default height

See Also:

• VoxelSniperConfigLoader.getDefaultVoxelHeight()

getDefaultCylinderCenter

public int getDefaultCylinderCenter()

Return default cylinder center.

Returns:

default center

See Also:

• VoxelSniperConfigLoader.getDefaultCylinderCenter()

getBrushProperties

public Map<String,Map<String,Object>> getBrushProperties()

Return brush properties. This Map stores another Map (associating Property -> Value) per brush.

Returns:

brush properties

See Also:

• VoxelSniperConfigLoader.getBrushProperties()

saveBrushPropertyToConfig

public void saveBrushPropertyToConfig(String brush,
 String propertyKey,
 Object value)

Force saving a brush property and its value to config. Used to register missing or fix wrong values.

Parameters:

brush - brush

propertyKey - property key

value - value