api/org.kryptonmc.api.effect.particle

Package-level declarations

Types

BlockParticleType

interface BlockParticleType : ScopedParticleType<BlockParticleEffectBuilder>

A type of particle that uses a block texture for its appearance.

ColorParticleType

interface ColorParticleType : ScopedParticleType<ColorParticleEffectBuilder>

A type of particle that uses a colour for its appearance.

DirectionalParticleType

interface DirectionalParticleType : ScopedParticleType<DirectionalParticleEffectBuilder>

A type of particle that can have velocity applied in a direction.

DustParticleType

interface DustParticleType : ScopedParticleType<DustParticleEffectBuilder>

A type of particle that uses a colour and scale for its appearance.

DustTransitionParticleType

interface DustTransitionParticleType : ScopedParticleType<DustTransitionParticleEffectBuilder>

A type of particle that uses a colour and scale for its appearance, and transitions from one colour to another.

ItemParticleType

interface ItemParticleType : ScopedParticleType<ItemParticleEffectBuilder>

A type of particle that uses an item texture for its appearance.

NoteParticleType

interface NoteParticleType : ScopedParticleType<NoteParticleEffectBuilder>

A type of particle that uses a specific note value for its colour appearance.

ParticleEffect

interface ParticleEffect

Holds information used to spawn particles for a player.

ParticleType

@CataloguedBy(catalogue = ParticleTypes::class)

interface ParticleType : Keyed

A type of particle effect.

ParticleTypes

@Catalogue(type = ParticleType::class)

object ParticleTypes

All of the built-in vanilla particle types.

ScopedParticleType

interface ScopedParticleType> : ParticleType

A particle type that scopes the return of the builder.

SimpleParticleType

interface SimpleParticleType : ScopedParticleType<SimpleParticleEffectBuilder>

A type of particle with basic options available.

VibrationParticleType

interface VibrationParticleType : ScopedParticleType<VibrationParticleEffectBuilder>

A type of particle that vibrates from one location to another in a given amount of ticks.

Functions

particleEffect

@Contract(value = "_, _ -> new", pure = true)

inline fun , T : Scoped> particleEffect(type: T, builder: B.() -> Unit): ParticleEffect

@Contract(value = "_, _ -> new", pure = true)

inline fun , T : Scoped> particleEffect(type: RegistryReference<T>, builder: B.() -> Unit): ParticleEffect

Creates a new particle effect with the given type and the result of applying the given builder.