Interface MineshaftStructure

All Superinterfaces:

DefinedStructure, Keyed, Registerable<MineshaftStructure>, Structure, Wrapper

@NullMarked
@AsOf("3.4.0")
public interface MineshaftStructure
extends DefinedStructure, Registerable<MineshaftStructure>

A mineshaft.

Since:

3.4.0

See Also:

• Mineshaft

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	MineshaftStructure.Builder	Builder for MineshaftStructure.
static enum	MineshaftStructure.Type	The wood a mineshaft is built from.

Method Summary

Modifier and Type	Method	Description
static MineshaftStructure.Builder	builder(StructureSettings settings)	Creates a new builder for an oak mineshaft, vanilla's default.
MineshaftStructure.Type	mineshaftType()	The wood the mineshaft is built from.
static MineshaftStructure	of(@Nullable ResourceKey resourceKey, StructureSettings settings, MineshaftStructure.Type mineshaftType)	Creates a new mineshaft.
MineshaftStructure	register()	Registers this structure under its resource key.
default MineshaftStructure.Builder	toBuilder()	Converts this object back to a builder.
default MineshaftStructure	withResourceKey(ResourceKey resourceKey)	Returns a copy of this structure registered under the given key.
default MineshaftStructure	withSettings(StructureSettings settings)	Returns a copy of this structure with the given settings.

Methods inherited from interface DefinedStructure

resourceKey, settings, withSettings

Methods inherited from interface Keyed

key

Methods inherited from interface Structure

wrap

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

mineshaftType

@AsOf("3.4.0")
MineshaftStructure.Type mineshaftType()

The wood the mineshaft is built from.

Returns:

the mineshaft type

Since:

3.4.0

withSettings

@AsOf("3.4.0")
default MineshaftStructure withSettings(StructureSettings settings)

Description copied from interface: DefinedStructure

Returns a copy of this structure with the given settings.

Specified by:

withSettings in interface DefinedStructure

Parameters:

settings - the settings the copy carries

Returns:

a copy of this structure with the given settings

withResourceKey

@AsOf("3.4.0")
default MineshaftStructure withResourceKey(ResourceKey resourceKey)

Description copied from interface: DefinedStructure

Returns a copy of this structure registered under the given key.

Specified by:

withResourceKey in interface DefinedStructure

Parameters:

resourceKey - the key the copy carries

Returns:

a copy of this structure with the given key

register

@AsOf("3.4.0")
MineshaftStructure register()

Description copied from interface: DefinedStructure

Registers this structure under its resource key.

Specified by:

register in interface DefinedStructure

Specified by:

register in interface Registerable<MineshaftStructure>

Returns:

this structure

toBuilder

@AsOf("3.4.0")
default MineshaftStructure.Builder toBuilder()

Converts this object back to a builder.

Returns:

a builder with the same values as this object

Since:

3.4.0

of

@AsOf("3.4.0")
static MineshaftStructure of(@Nullable ResourceKey resourceKey,
 StructureSettings settings,
 MineshaftStructure.Type mineshaftType)

Creates a new mineshaft.

Parameters:

resourceKey - the resource key of the structure, or null if not present

settings - the settings every structure carries

mineshaftType - the wood the mineshaft is built from

Returns:

a new mineshaft

Since:

3.4.0

builder

@AsOf("3.4.0")
static MineshaftStructure.Builder builder(StructureSettings settings)

Creates a new builder for an oak mineshaft, vanilla's default.

Parameters:

settings - the settings every structure carries

Returns:

a new builder

Since:

3.4.0