Class HytaleAssetsWorldGenProvider

java.lang.Object

com.hypixel.hytale.builtin.worldgen.HytaleAssetsWorldGenProvider

All Implemented Interfaces:

IWorldGenProvider, StagedWorldGenProvider

public final class HytaleAssetsWorldGenProvider
extends Object
implements StagedWorldGenProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	HytaleAssetsWorldGenProvider.PublishedBuild

Nested classes/interfaces inherited from interface StagedWorldGenProvider

StagedWorldGenProvider.Candidate, StagedWorldGenProvider.Installer

Field Summary

Fields

Modifier and Type	Field	Description
static final BuilderCodec<HytaleAssetsWorldGenProvider>	CODEC
static final String	DEFAULT_CONFIG
static final String	ID
static final BuilderCodec<HytaleAssetsWorldGenProvider>	LEGACY_CODEC

Constructor Summary

Constructors

Constructor	Description
HytaleAssetsWorldGenProvider()
HytaleAssetsWorldGenProvider(String config)

Method Summary

Modifier and Type	Method	Description
HytaleAssetsWorldGenProvider.PublishedBuild	buildCandidate()	Builds a complete candidate without changing the installed snapshot and generator pair.
HytaleAssetsWorldGenProvider.PublishedBuild	buildCandidate(WorldGenMembershipSnapshot snapshot)
String	getConfig()
IWorldGen	getGenerator()	Creates a generator and transfers ownership to the caller.
HytaleAssetsWorldGenProvider.PublishedBuild	getPublishedBuild()
boolean	installCandidate(HytaleAssetsWorldGenProvider.PublishedBuild candidate, StagedWorldGenProvider.Installer installer)
boolean	installCandidate(StagedWorldGenProvider.Candidate candidate, StagedWorldGenProvider.Installer installer)	Attempts to install a candidate and takes responsibility for its generator.
String	toString()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

DEFAULT_CONFIG

public static final String DEFAULT_CONFIG

See Also:

• Constant Field Values

CODEC

public static final BuilderCodec<HytaleAssetsWorldGenProvider> CODEC

LEGACY_CODEC

public static final BuilderCodec<HytaleAssetsWorldGenProvider> LEGACY_CODEC

Constructor Details

HytaleAssetsWorldGenProvider

public HytaleAssetsWorldGenProvider()

HytaleAssetsWorldGenProvider

public HytaleAssetsWorldGenProvider(@Nonnull
 String config)

Method Details

getConfig

@Nullable
public String getConfig()

getGenerator

@Nonnull
public IWorldGen getGenerator()
                       throws WorldGenLoadException

Description copied from interface: IWorldGenProvider

Creates a generator and transfers ownership to the caller. The caller must shut down the generator if it does not install it into a world. A successful world installation transfers ownership to that world.

Specified by:

getGenerator in interface IWorldGenProvider

Returns:

the new generator.

Throws:

WorldGenLoadException - if the provider cannot create the generator.

buildCandidate

@Nonnull
public HytaleAssetsWorldGenProvider.PublishedBuild buildCandidate()
                                                           throws WorldGenLoadException

Builds a complete candidate without changing the installed snapshot and generator pair.

Specified by:

buildCandidate in interface StagedWorldGenProvider

Throws:

WorldGenLoadException

buildCandidate

@Nonnull
public HytaleAssetsWorldGenProvider.PublishedBuild buildCandidate(@Nonnull
 WorldGenMembershipSnapshot snapshot)
                                                           throws WorldGenLoadException

Throws:

WorldGenLoadException

installCandidate

public boolean installCandidate(@Nonnull
 StagedWorldGenProvider.Candidate candidate,
 @Nonnull
 StagedWorldGenProvider.Installer installer)
                         throws WorldMapLoadException

Description copied from interface: StagedWorldGenProvider

Attempts to install a candidate and takes responsibility for its generator. The implementation must shut down a rejected candidate or a candidate whose installation fails. A successful installation transfers ownership to the installer.

Specified by:

installCandidate in interface StagedWorldGenProvider

Throws:

WorldMapLoadException

installCandidate

public boolean installCandidate(@Nonnull
 HytaleAssetsWorldGenProvider.PublishedBuild candidate,
 @Nonnull
 StagedWorldGenProvider.Installer installer)
                         throws WorldMapLoadException

Throws:

WorldMapLoadException

getPublishedBuild

@Nullable
public HytaleAssetsWorldGenProvider.PublishedBuild getPublishedBuild()

toString

public String toString()

Overrides:

toString in class Object