SybSafetyFirst/com.sybsuper.sybsafetyfirst.modules/WaterCurrent/WaterCurrentOptions

WaterCurrentOptions

@Serializable

data class WaterCurrentOptions(var enabled: Boolean = true, var velocity: Double = 0.015, var directionChangeIntervalMs: Int = 10000, var directionChangeDegreesPerInterval: Double = 0.5, var applyInterval: Long = 2) : ModuleOptions

Constructors

WaterCurrentOptions

constructor(enabled: Boolean = true, velocity: Double = 0.015, directionChangeIntervalMs: Int = 10000, directionChangeDegreesPerInterval: Double = 0.5, applyInterval: Long = 2)

Properties

applyInterval

var applyInterval: Long

The interval in ticks at which the current is applied to entities. 20 ticks = 1 second, so 2 means 10 times per second. Min: 1 tick, max: infinity. Higher values mean less frequent updates, which can reduce server load but may make the current feel more "stuttering". Higher values also mean that the player has more control over their movement, since setting the velocity overrides their movement.

directionChangeDegreesPerInterval

var directionChangeDegreesPerInterval: Double

The number of degrees the current direction changes per interval.

directionChangeIntervalMs

var directionChangeIntervalMs: Int

The interval in milliseconds at which the direction of the current changes.

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.

velocity

var velocity: Double

The velocity at which entities in water are pushed.