Interface SimpleStructure

All Superinterfaces:

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

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

A structure whose layout is written in Java and takes no configuration beyond its settings.

Since:

3.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SimpleStructure.Builder	Builder for SimpleStructure.

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<StructureType>	TYPES

Method Summary

Modifier and Type	Method	Description
static SimpleStructure.Builder	builder(StructureType type, StructureSettings settings)	Creates a new builder.
static SimpleStructure	of(@Nullable ResourceKey resourceKey, StructureType type, StructureSettings settings)	Creates a new structure of a type that takes no configuration.
static SimpleStructure	of(StructureType type, StructureSettings settings)	Creates a new structure of a type that takes no configuration.
SimpleStructure	register()	Registers this structure under its resource key.
default SimpleStructure.Builder	toBuilder()	Converts this object back to a builder.
StructureType	type()	The structure type, one of TYPES.
default SimpleStructure	withResourceKey(ResourceKey resourceKey)	Returns a copy of this structure registered under the given key.
default SimpleStructure	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

Field Details

TYPES

static final Set<StructureType> TYPES

Method Details

type

@AsOf("3.4.0")
StructureType type()

The structure type, one of TYPES.

Returns:

the structure type

Since:

3.4.0

withSettings

@AsOf("3.4.0")
default SimpleStructure 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 SimpleStructure 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")
SimpleStructure 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<SimpleStructure>

Returns:

this structure

toBuilder

@AsOf("3.4.0")
default SimpleStructure.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 SimpleStructure of(@Nullable ResourceKey resourceKey,
 StructureType type,
 StructureSettings settings)

Creates a new structure of a type that takes no configuration.

Parameters:

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

type - the structure type, one of TYPES

settings - the settings every structure carries

Returns:

a new structure

Throws:

IllegalArgumentException - if the type takes configuration of its own

Since:

3.4.0

of

@AsOf("3.4.0")
static SimpleStructure of(StructureType type,
 StructureSettings settings)

Creates a new structure of a type that takes no configuration.

Parameters:

type - the structure type, one of TYPES

settings - the settings every structure carries

Returns:

a new structure

Since:

3.4.0

builder

@AsOf("3.4.0")
static SimpleStructure.Builder builder(StructureType type,
 StructureSettings settings)

Creates a new builder.

Parameters:

type - the structure type, one of TYPES

settings - the settings every structure carries

Returns:

a new builder

Since:

3.4.0