SybSafetyFirst/com.sybsuper.sybsafetyfirst.modules/BadAirCaves/BadAirCavesOptions

BadAirCavesOptions

@Serializable

data class BadAirCavesOptions(var enabled: Boolean = true, var damageAmount: Double = 1.0, var applyPoison: Boolean = true, var heavyGas: Boolean = true, var gasCloudRadius: Int = 4, var poisonDurationTicks: Int = 100, var poisonLevel: Int = 1, var particle: Particle = Particle.WITCH, var particleCountPerCloudPart: Int = 16, var creationChancePerSecond: Double = 0.001, var cloudMaxSize: Int = 300, var particleVisibilityRange: Float = 32.0f, var spreadsPerCloudPerSecond: Int = 5, var decayAfterTicks: Int = 120 * 20) : ModuleOptions

Constructors

BadAirCavesOptions

constructor(enabled: Boolean = true, damageAmount: Double = 1.0, applyPoison: Boolean = true, heavyGas: Boolean = true, gasCloudRadius: Int = 4, poisonDurationTicks: Int = 100, poisonLevel: Int = 1, particle: Particle = Particle.WITCH, particleCountPerCloudPart: Int = 16, creationChancePerSecond: Double = 0.001, cloudMaxSize: Int = 300, particleVisibilityRange: Float = 32.0f, spreadsPerCloudPerSecond: Int = 5, decayAfterTicks: Int = 120 * 20)

Properties

applyPoison

var applyPoison: Boolean

If true, players will get the poison effect when they are in the gas cloud. If false, they will only take damage.

cloudMaxSize

var cloudMaxSize: Int

The maximum number of points in a gas cloud. This is the maximum number of particles that will be spawned for a single cloud. If the cloud reaches this size, it will not spread anymore. Greater values will increase the size of the gas cloud, but also increase server load.

creationChancePerSecond

var creationChancePerSecond: Double

The chance per second that a new gas cloud could be created if a player is in a cave at the time. This is a value between 0 and 1, where 1 means every player will create a cloud every second. A value of 0.001 means that on average, one cloud will be created every 1000 seconds per player. Which is around 17 minutes.

damageAmount

var damageAmount: Double

Damage amount per second to apply to players in the gas cloud.

decayAfterTicks

var decayAfterTicks: Int

Set to 0 to disable decay.

enabled

open override var enabled: Boolean

Whether the module is enabled or not. This is used to determine if the module should be loaded and its features activated.

gasCloudRadius

var gasCloudRadius: Int

Gas cloud radius in blocks. Decreasing this increases realism but also increases server load. The Minimum value is 1. Would not recommend going over 16.

heavyGas

var heavyGas: Boolean

If true, the gas will be considered heavy, meaning it will stay closer to the ground.

particle

var particle: Particle

The particle to use for the gas cloud.

particleCountPerCloudPart

var particleCountPerCloudPart: Int

The number of particles to spawn per cloud part. A cloud is made up of multiple parts, each part is a point in the cloud. This controls how many particles are spawned per point.

particleVisibilityRange

var particleVisibilityRange: Float

The range in blocks at which particles will be visible to players. This is used to limit the number of particles sent to players. A value of 32 means that particles will only be sent to players within 32 blocks of the cloud.

poisonDurationTicks

var poisonDurationTicks: Int

The distance the gas can spread from the edge of the gas cloud. Should not be higher than the gas cloud radius, or there will be gaps in the gas cloud.

poisonLevel

var poisonLevel: Int

The level of poison effect to apply to players in the gas cloud.

spreadsPerCloudPerSecond

var spreadsPerCloudPerSecond: Int

The number of times a gas cloud will spread per second. This is the number of new points that will be added to the cloud every second. A value of 5 means that 5 new points will be added to the cloud every second. Greater values will increase the spread speed of the gas cloud, but also increase server load.