Class Structure

java.lang.Object

org.bukkit.generator.structure.Structure

All Implemented Interfaces:

Keyed, Keyed

public abstract class Structure
extends Object
implements Keyed

Represent a Structure from the world.

Listed structures are present in the default server. Depending on the server there might be additional structures present (for example structures added by data packs), which can be received via RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey) and RegistryKey.STRUCTURE.

Since:

1.19

Field Summary

Fields

Modifier and Type	Field	Description
static final Structure	ANCIENT_CITY
static final Structure	BASTION_REMNANT
static final Structure	BURIED_TREASURE
static final Structure	DESERT_PYRAMID
static final Structure	END_CITY
static final Structure	FORTRESS
static final Structure	IGLOO
static final Structure	JUNGLE_PYRAMID
static final Structure	MANSION
static final Structure	MINESHAFT
static final Structure	MINESHAFT_MESA
static final Structure	MONUMENT
static final Structure	NETHER_FOSSIL
static final Structure	OCEAN_RUIN_COLD
static final Structure	OCEAN_RUIN_WARM
static final Structure	PILLAGER_OUTPOST
static final Structure	RUINED_PORTAL
static final Structure	RUINED_PORTAL_DESERT
static final Structure	RUINED_PORTAL_JUNGLE
static final Structure	RUINED_PORTAL_MOUNTAIN
static final Structure	RUINED_PORTAL_NETHER
static final Structure	RUINED_PORTAL_OCEAN
static final Structure	RUINED_PORTAL_SWAMP
static final Structure	SHIPWRECK
static final Structure	SHIPWRECK_BEACHED
static final Structure	STRONGHOLD
static final Structure	SWAMP_HUT
static final Structure	TRAIL_RUINS
static final Structure	TRIAL_CHAMBERS
static final Structure	VILLAGE_DESERT
static final Structure	VILLAGE_PLAINS
static final Structure	VILLAGE_SAVANNA
static final Structure	VILLAGE_SNOWY
static final Structure	VILLAGE_TAIGA

Constructor Summary

Constructors

Constructor	Description
Structure()

Method Summary

Modifier and Type	Method	Description
abstract @NotNull NamespacedKey	getKey()	Deprecated, for removal: This API element is subject to removal in a future version. use Registry.getKey(Keyed), RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), and RegistryKey.STRUCTURE.
abstract @NotNull StructureType	getStructureType()	Returns the type of the structure.
@NotNull Key	key()	Deprecated, for removal: This API element is subject to removal in a future version. use Registry.getKey(Keyed), RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), and RegistryKey.STRUCTURE.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ANCIENT_CITY

public static final Structure ANCIENT_CITY

Since:

1.19

BASTION_REMNANT

public static final Structure BASTION_REMNANT

Since:

1.19

BURIED_TREASURE

public static final Structure BURIED_TREASURE

Since:

1.19

DESERT_PYRAMID

public static final Structure DESERT_PYRAMID

Since:

1.19

END_CITY

public static final Structure END_CITY

Since:

1.19

FORTRESS

public static final Structure FORTRESS

Since:

1.19

IGLOO

public static final Structure IGLOO

Since:

1.19

JUNGLE_PYRAMID

public static final Structure JUNGLE_PYRAMID

Since:

1.19

MANSION

public static final Structure MANSION

Since:

1.19

MINESHAFT

public static final Structure MINESHAFT

Since:

1.19

MINESHAFT_MESA

public static final Structure MINESHAFT_MESA

Since:

1.19

MONUMENT

public static final Structure MONUMENT

Since:

1.19

NETHER_FOSSIL

public static final Structure NETHER_FOSSIL

Since:

1.19

OCEAN_RUIN_COLD

public static final Structure OCEAN_RUIN_COLD

Since:

1.19

OCEAN_RUIN_WARM

public static final Structure OCEAN_RUIN_WARM

Since:

1.19

PILLAGER_OUTPOST

public static final Structure PILLAGER_OUTPOST

Since:

1.19

RUINED_PORTAL

public static final Structure RUINED_PORTAL

Since:

1.19

RUINED_PORTAL_DESERT

public static final Structure RUINED_PORTAL_DESERT

Since:

1.19

RUINED_PORTAL_JUNGLE

public static final Structure RUINED_PORTAL_JUNGLE

Since:

1.19

RUINED_PORTAL_MOUNTAIN

public static final Structure RUINED_PORTAL_MOUNTAIN

Since:

1.19

RUINED_PORTAL_NETHER

public static final Structure RUINED_PORTAL_NETHER

Since:

1.19

RUINED_PORTAL_OCEAN

public static final Structure RUINED_PORTAL_OCEAN

Since:

1.19

RUINED_PORTAL_SWAMP

public static final Structure RUINED_PORTAL_SWAMP

Since:

1.19

SHIPWRECK

public static final Structure SHIPWRECK

Since:

1.19

SHIPWRECK_BEACHED

public static final Structure SHIPWRECK_BEACHED

Since:

1.19

STRONGHOLD

public static final Structure STRONGHOLD

Since:

1.19

SWAMP_HUT

public static final Structure SWAMP_HUT

Since:

1.19

TRAIL_RUINS

public static final Structure TRAIL_RUINS

Since:

1.20

TRIAL_CHAMBERS

public static final Structure TRIAL_CHAMBERS

Since:

1.20.4

VILLAGE_DESERT

public static final Structure VILLAGE_DESERT

Since:

1.19

VILLAGE_PLAINS

public static final Structure VILLAGE_PLAINS

Since:

1.19

VILLAGE_SAVANNA

public static final Structure VILLAGE_SAVANNA

Since:

1.19

VILLAGE_SNOWY

public static final Structure VILLAGE_SNOWY

Since:

1.19

VILLAGE_TAIGA

public static final Structure VILLAGE_TAIGA

Since:

1.19

Constructor Details

Structure

public Structure()

Method Details

getStructureType

@NotNull
public abstract @NotNull StructureType getStructureType()

Returns the type of the structure.

Returns:

the type of structure

Since:

1.19

getKey

@Deprecated(since="1.20.4",
            forRemoval=true)
@NotNull
public abstract @NotNull NamespacedKey getKey()

Deprecated, for removal: This API element is subject to removal in a future version.

use Registry.getKey(Keyed), RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), and RegistryKey.STRUCTURE. Structures can exist without a key.

Description copied from interface: Keyed

Return the namespaced identifier for this object.

Specified by:

getKey in interface Keyed

Returns:

this object's key

key

@Deprecated(since="1.20.4",
            forRemoval=true)
public @NotNull Key key()

Deprecated, for removal: This API element is subject to removal in a future version.

use Registry.getKey(Keyed), RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), and RegistryKey.STRUCTURE. Structures can exist without a key.

Description copied from interface: Keyed

Returns the unique identifier for this object.

Specified by:

key in interface Keyed

Specified by:

key in interface Keyed

Returns:

this object's key