api/org.kryptonmc.api.item.data/FireworkEffect

FireworkEffect

interface FireworkEffect

An effect that may be produced from a firework star exploding.

Types

Link copied to clipboard
interface Builder : AbstractBuilder<FireworkEffect>

A builder for building firework effects.

Link copied to clipboard
object Companion
Link copied to clipboard
@ApiStatus.Internal
interface Factory

Properties

Link copied to clipboard
@get:JvmName(name = "colors")
abstract val colors: List<Color>

The primary colours of this effect.

Link copied to clipboard
@get:JvmName(name = "fadeColors")
abstract val fadeColors: List<Color>

The fading colours of this effect.

Link copied to clipboard
@get:JvmName(name = "hasFlicker")
abstract val hasFlicker: Boolean

Whether this effect flickers.

Link copied to clipboard
@get:JvmName(name = "hasTrail")
abstract val hasTrail: Boolean

Whether this effect has a trail.

Link copied to clipboard
@get:JvmName(name = "type")
abstract val type: FireworkEffectType

The type of this effect.