Interface ParticleOptions

All Superinterfaces:

Wrapper

@NullMarked
@AsOf("2.3.0")
public interface ParticleOptions
extends Wrapper

Opaque handle to NMS ParticleOptions. Impl module wraps the real thing.

Since:

2.0.0

Method Summary

Static Methods

Modifier and Type	Method	Description
static ParticleOptions	decode(Object minecraftParticleOptions)	Reads Minecraft particle options into a wrapper.
static ParticleOptions	of(ParticleTypes type)	Creates a new ParticleOptions instance.
static ParticleOptions	of(ParticleTypes type, @Nullable ParticleData data)	Creates a new ParticleOptions instance.

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

of

@AsOf("3.0.0")
static ParticleOptions of(ParticleTypes type,
 @Nullable ParticleData data)

Creates a new ParticleOptions instance.

Parameters:

type - the particle type

data - the particle data, can be null for simple particle types

Returns:

a new ParticleOptions instance

Since:

3.0.0

of

@AsOf("3.0.0")
static ParticleOptions of(ParticleTypes type)

Creates a new ParticleOptions instance.

Parameters:

type - the particle type

Returns:

a new ParticleOptions instance

Since:

3.0.0

decode

@AsOf("3.3.0")
static ParticleOptions decode(Object minecraftParticleOptions)

Reads Minecraft particle options into a wrapper.

Parameters:

minecraftParticleOptions - the particle options to read

Returns:

the wrapper for them

Since:

3.3.0