Package net.minestom.server.instance.palette

Interface Palette

public sealed interface Palette

Represents a palette used to store blocks and biomes.

0 is the default value.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Palette.EntryConsumer
static interface	Palette.EntryFunction
static interface	Palette.EntrySupplier
static enum	Palette.Optimization

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BIOME_DIMENSION
static final int	BIOME_PALETTE_DIRECT_BITS
static final int	BIOME_PALETTE_MAX_BITS
static final int	BIOME_PALETTE_MIN_BITS
static final int	BLOCK_DIMENSION
static final int	BLOCK_PALETTE_DIRECT_BITS
static final int	BLOCK_PALETTE_MAX_BITS
static final int	BLOCK_PALETTE_MIN_BITS
static final NetworkBuffer.Type<Palette>	BLOCK_SERIALIZER

Method Summary

Modifier and Type	Method	Description
static Palette	biomes()
static Palette	biomes(int bitsPerEntry)
static NetworkBuffer.Type<Palette>	biomeSerializer(int biomeCount)
int	bitsPerEntry()	Returns the number of bits used per entry.
static Palette	blocks()
static Palette	blocks(int bitsPerEntry)
@NotNull Palette	clone()
boolean	compare(@NotNull Palette palette)	Compare palettes content independently of their storage format.
int	count()	Returns the number of entries in this palette.
int	dimension()
static Palette	empty(int dimension, int minBitsPerEntry, int maxBitsPerEntry, int directBits)
void	fill(int value)
int	get(int x, int y, int z)
void	getAll(@NotNull Palette.EntryConsumer consumer)
void	getAllPresent(@NotNull Palette.EntryConsumer consumer)
long @Nullable []	indexedValues()	Gets the value array if it has one, otherwise returns null (i.e.
default int	maxSize()	Returns the maximum number of entries in this palette.
void	optimize(Palette.Optimization focus)
int	paletteIndexToValue(int value)
void	replace(int x, int y, int z, @NotNull IntUnaryOperator operator)
void	replaceAll(@NotNull Palette.EntryFunction function)
static NetworkBuffer.Type<Palette>	serializer(int dimension, int minIndirect, int maxIndirect, int directBits)
void	set(int x, int y, int z, int value)
void	setAll(@NotNull Palette.EntrySupplier supplier)
int	singleValue()	Gets the single value of this palette if it is a single value palette, otherwise returns -1.
static Palette	sized(int dimension, int minBitsPerEntry, int maxBitsPerEntry, int directBits, int bitsPerEntry)
int	valueToPaletteIndex(int value)

Field Details

BLOCK_DIMENSION

static final int BLOCK_DIMENSION

See Also:

• Constant Field Values

BLOCK_PALETTE_MIN_BITS

static final int BLOCK_PALETTE_MIN_BITS

See Also:

• Constant Field Values

BLOCK_PALETTE_MAX_BITS

static final int BLOCK_PALETTE_MAX_BITS

See Also:

• Constant Field Values

BLOCK_PALETTE_DIRECT_BITS

static final int BLOCK_PALETTE_DIRECT_BITS

See Also:

• Constant Field Values

BIOME_DIMENSION

static final int BIOME_DIMENSION

See Also:

• Constant Field Values

BIOME_PALETTE_MIN_BITS

static final int BIOME_PALETTE_MIN_BITS

See Also:

• Constant Field Values

BIOME_PALETTE_MAX_BITS

static final int BIOME_PALETTE_MAX_BITS

See Also:

• Constant Field Values

BIOME_PALETTE_DIRECT_BITS

@Internal
static final int BIOME_PALETTE_DIRECT_BITS

See Also:

• Constant Field Values

BLOCK_SERIALIZER

static final NetworkBuffer.Type<Palette> BLOCK_SERIALIZER

Method Details

blocks

static Palette blocks(int bitsPerEntry)

biomes

static Palette biomes(int bitsPerEntry)

blocks

static Palette blocks()

biomes

static Palette biomes()

empty

static Palette empty(int dimension,
 int minBitsPerEntry,
 int maxBitsPerEntry,
 int directBits)

sized

static Palette sized(int dimension,
 int minBitsPerEntry,
 int maxBitsPerEntry,
 int directBits,
 int bitsPerEntry)

get

int get(int x,
 int y,
 int z)

getAll

void getAll(@NotNull
 @NotNull Palette.EntryConsumer consumer)

getAllPresent

void getAllPresent(@NotNull
 @NotNull Palette.EntryConsumer consumer)

set

void set(int x,
 int y,
 int z,
 int value)

fill

void fill(int value)

setAll

void setAll(@NotNull
 @NotNull Palette.EntrySupplier supplier)

replace

void replace(int x,
 int y,
 int z,
 @NotNull
 @NotNull IntUnaryOperator operator)

replaceAll

void replaceAll(@NotNull
 @NotNull Palette.EntryFunction function)

count

int count()

Returns the number of entries in this palette.

bitsPerEntry

int bitsPerEntry()

Returns the number of bits used per entry.

dimension

int dimension()

maxSize

default int maxSize()

Returns the maximum number of entries in this palette.

optimize

void optimize(Palette.Optimization focus)

compare

boolean compare(@NotNull
 @NotNull Palette palette)

Compare palettes content independently of their storage format.

Parameters:

palette - the palette to compare with

Returns:

true if the palettes are equivalent, false otherwise

clone

@NotNull
@NotNull Palette clone()

paletteIndexToValue

@Internal
int paletteIndexToValue(int value)

valueToPaletteIndex

@Internal
int valueToPaletteIndex(int value)

singleValue

@Internal
int singleValue()

Gets the single value of this palette if it is a single value palette, otherwise returns -1.

indexedValues

@Internal
long @Nullable [] indexedValues()

Gets the value array if it has one, otherwise returns null (i.e. single value palette).

biomeSerializer

static NetworkBuffer.Type<Palette> biomeSerializer(int biomeCount)

serializer

static NetworkBuffer.Type<Palette> serializer(int dimension,
 int minIndirect,
 int maxIndirect,
 int directBits)