api/org.kryptonmc.api.effect/Music

Music

interface Music

Music that may be played. This has a minimum and maximum delay before the music will start playing, and the music can start playing anywhere in between this time frame.

Types

Companion

object Companion

Factory

@ApiStatus.Internal

interface Factory

Properties

maximumDelay

@get:JvmName(name = "maximumDelay")

abstract val maximumDelay: Int

The maximum delay before the music will start playing.

minimumDelay

@get:JvmName(name = "minimumDelay")

abstract val minimumDelay: Int

The minimum delay before the music will start playing.

replaceCurrentMusic

@get:JvmName(name = "replaceCurrentMusic")

abstract val replaceCurrentMusic: Boolean

If this music should replace any currently playing music.

sound

@get:JvmName(name = "sound")

abstract val sound: SoundEvent

The sound that will be played.