org.spongepowered.api.world.schematic

Interface BlockPalette

All Superinterfaces:

Palette<BlockState>

Deprecated.

Use Palette for improved generics

@Deprecated
public interface BlockPalette
extends Palette<BlockState>

Represents a mapping for block states to a local identifier.

Method Summary

Modifier and Type	Method and Description
Optional<Integer>	get(BlockState state) Deprecated. Gets the identifier for the given blockstate if it exists within the mapping.
Optional<BlockState>	get(int id) Deprecated. Gets the blockstate represented by the given identifier from the mapping.
Collection<BlockState>	getEntries() Deprecated. Gets all BlockStates contained in this palette.
int	getHighestId() Deprecated. Gets the highest identifier in this palette.
int	getOrAssign(BlockState state) Deprecated. Gets the identifier for the given blockstate from the mapping.
BlockPaletteType	getType() Deprecated. Gets the type of this palette.
boolean	remove(BlockState state) Deprecated. Removes the given blockstate from the mapping.

Method Detail

getType

BlockPaletteType getType()

Deprecated.

Gets the type of this palette.

Specified by:

getType in interface Palette<BlockState>

Returns:

The palette type

getHighestId

int getHighestId()

Deprecated.

Gets the highest identifier in this palette.

Specified by:

getHighestId in interface Palette<BlockState>

Returns:

The highest id

get

Optional<BlockState> get(int id)

Deprecated.

Gets the blockstate represented by the given identifier from the mapping.

Specified by:

get in interface Palette<BlockState>

Parameters:

id - The identifier

Returns:

The blockstate, if found

get

Optional<Integer> get(BlockState state)

Deprecated.

Gets the identifier for the given blockstate if it exists within the mapping.

Specified by:

get in interface Palette<BlockState>

Parameters:

state - The block state

Returns:

The identifier, if found

getOrAssign

int getOrAssign(BlockState state)

Deprecated.

Gets the identifier for the given blockstate from the mapping. If the blockstate is not yet registered in the mapping then it is registered and given the next available identifier.

Specified by:

getOrAssign in interface Palette<BlockState>

Parameters:

state - The blockstate

Returns:

The identifier

remove

boolean remove(BlockState state)

Deprecated.

Removes the given blockstate from the mapping.

If this palette is the BlockPaletteTypes.GLOBAL palette then removal is not supported.

Specified by:

remove in interface Palette<BlockState>

Parameters:

state - The blockstate to remove

Returns:

If the blockstate existed in the mapping

getEntries

Collection<BlockState> getEntries()

Deprecated.

Gets all BlockStates contained in this palette.

Specified by:

getEntries in interface Palette<BlockState>

Returns:

All contained block states