Class PrefabEditorCreationSettings

java.lang.Object

com.hypixel.hytale.builtin.buildertools.prefabeditor.PrefabEditorCreationSettings

All Implemented Interfaces:

JsonAsset<String>, JsonAssetWithMap<String, DefaultAssetMap<String, PrefabEditorCreationSettings>>, PrefabEditorCreationContext

public class PrefabEditorCreationSettings
extends Object
implements PrefabEditorCreationContext, JsonAssetWithMap<String, DefaultAssetMap<String, PrefabEditorCreationSettings>>

Extra information that needs to be passed between various systems for creating a PrefabEditSession through the PrefabEditSessionManager. Also gets stored for the prefab edit UI

Field Summary

Fields

Modifier and Type	Field	Description
static final AssetBuilderCodec<String, PrefabEditorCreationSettings>	CODEC

Constructor Summary

Constructors

Constructor

Description

PrefabEditorCreationSettings(PrefabRootDirectory prefabRootDirectory, List<String> unprocessedPrefabPaths, int pasteYLevelGoal, int blocksBetweenEachPrefab, WorldGenType worldGenType, int blocksAboveSurface, PrefabStackingAxis stackingAxis, PrefabAlignment alignment, boolean recursive, boolean loadChildren, boolean loadEntities, boolean enableWorldTicking, PrefabRowSplitMode rowSplitMode, String environment, String grassTint)

Method Summary

Modifier and Type	Method	Description
PrefabAlignment	getAlignment()
static DefaultAssetMap<String, PrefabEditorCreationSettings>	getAssetMap()
static AssetStore<String, PrefabEditorCreationSettings, DefaultAssetMap<String, PrefabEditorCreationSettings>>	getAssetStore()
int	getBlocksAboveSurface()
int	getBlocksBetweenEachPrefab()
Player	getEditor()
PlayerRef	getEditorRef()
String	getEnvironment()	Gets the environment ID to use for the prefab editor world.
Message	getFailureMessage()
String	getGrassTint()	Gets the grass tint color as a hex string (e.g. "#5B9E28").
String	getId()
int	getPasteLevelGoal()
int	getPasteYLevelGoal()
List<Path>	getPrefabPaths()
PrefabRootDirectory	getPrefabRootDirectory()
PrefabRowSplitMode	getRowSplitMode()	Determines how prefabs are split into rows when loading multiple prefabs.
PrefabStackingAxis	getStackingAxis()
List<String>	getUnprocessedPrefabPaths()	Gets the unprocessed prefab paths (the original input paths before resolving).
WorldGenType	getWorldGenType()
boolean	isLoadChildren()
boolean	isRecursive()
boolean	isWorldTickingEnabled()	Whether world ticking (block updates, random ticks, etc.) is enabled in the prefab editor world.
static CompletableFuture<PrefabEditorCreationSettings>	load(String name)	Load an existing PrefabCreationSettings asset from the PrefabCreationSettings asset directory
boolean	loadChildPrefabs()
static CompletableFuture<Void>	save(String name, PrefabEditorCreationSettings settings, AssetPack pack, PlayerRef playerRef)
static CompletableFuture<Void>	save(String name, PrefabEditorCreationSettings settings, PlayerRef playerRef)	Save the provided PrefabEditorCreationSettings to the filename specified inside the PrefabEditorCreationSettings assets directory
boolean	shouldLoadEntities()
static boolean	stringEndsWithPrefabPath(String input)

Methods inherited from class Object

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

Field Details

CODEC

public static final AssetBuilderCodec<String, PrefabEditorCreationSettings> CODEC

Constructor Details

PrefabEditorCreationSettings

public PrefabEditorCreationSettings(PrefabRootDirectory prefabRootDirectory,
 List<String> unprocessedPrefabPaths,
 int pasteYLevelGoal,
 int blocksBetweenEachPrefab,
 WorldGenType worldGenType,
 int blocksAboveSurface,
 PrefabStackingAxis stackingAxis,
 PrefabAlignment alignment,
 boolean recursive,
 boolean loadChildren,
 boolean loadEntities,
 boolean enableWorldTicking,
 PrefabRowSplitMode rowSplitMode,
 String environment,
 String grassTint)

Method Details

getAssetStore

public static AssetStore<String, PrefabEditorCreationSettings, DefaultAssetMap<String, PrefabEditorCreationSettings>> getAssetStore()

getAssetMap

public static DefaultAssetMap<String, PrefabEditorCreationSettings> getAssetMap()

stringEndsWithPrefabPath

public static boolean stringEndsWithPrefabPath(@Nonnull
 String input)

load

@Nonnull
public static CompletableFuture<PrefabEditorCreationSettings> load(@Nonnull
 String name)

Load an existing PrefabCreationSettings asset from the PrefabCreationSettings asset directory

Parameters:

name - The name of the file to load

Returns:

a future that ends when the PrefabEditorCreationSettings is done loading

save

@Nonnull
public static CompletableFuture<Void> save(@Nonnull
 String name,
 PrefabEditorCreationSettings settings,
 @Nonnull
 PlayerRef playerRef)

Save the provided PrefabEditorCreationSettings to the filename specified inside the PrefabEditorCreationSettings assets directory

Parameters:

name - The name of the file to save to

settings - The data to save

playerRef - The player who is saving the file

Returns:

a completable future that completes after the file is saved

save

@Nonnull
public static CompletableFuture<Void> save(@Nonnull
 String name,
 PrefabEditorCreationSettings settings,
 @Nonnull
 AssetPack pack,
 @Nonnull
 PlayerRef playerRef)

getEditor

public Player getEditor()

Specified by:

getEditor in interface PrefabEditorCreationContext

getEditorRef

public PlayerRef getEditorRef()

Specified by:

getEditorRef in interface PrefabEditorCreationContext

getPrefabPaths

public List<Path> getPrefabPaths()

Specified by:

getPrefabPaths in interface PrefabEditorCreationContext

getBlocksBetweenEachPrefab

public int getBlocksBetweenEachPrefab()

Specified by:

getBlocksBetweenEachPrefab in interface PrefabEditorCreationContext

getPasteLevelGoal

public int getPasteLevelGoal()

Specified by:

getPasteLevelGoal in interface PrefabEditorCreationContext

loadChildPrefabs

public boolean loadChildPrefabs()

Specified by:

loadChildPrefabs in interface PrefabEditorCreationContext

shouldLoadEntities

public boolean shouldLoadEntities()

Specified by:

shouldLoadEntities in interface PrefabEditorCreationContext

getStackingAxis

public PrefabStackingAxis getStackingAxis()

Specified by:

getStackingAxis in interface PrefabEditorCreationContext

getWorldGenType

public WorldGenType getWorldGenType()

Specified by:

getWorldGenType in interface PrefabEditorCreationContext

getBlocksAboveSurface

public int getBlocksAboveSurface()

Specified by:

getBlocksAboveSurface in interface PrefabEditorCreationContext

getAlignment

public PrefabAlignment getAlignment()

Specified by:

getAlignment in interface PrefabEditorCreationContext

getId

public String getId()

Specified by:

getId in interface JsonAsset<String>

getPrefabRootDirectory

public PrefabRootDirectory getPrefabRootDirectory()

Specified by:

getPrefabRootDirectory in interface PrefabEditorCreationContext

getUnprocessedPrefabPaths

public List<String> getUnprocessedPrefabPaths()

Description copied from interface: PrefabEditorCreationContext

Gets the unprocessed prefab paths (the original input paths before resolving). Used for determining row splits when using BY_SPECIFIED_FOLDER mode.

Specified by:

getUnprocessedPrefabPaths in interface PrefabEditorCreationContext

getFailureMessage

@Nullable
public Message getFailureMessage()

Returns:

the reason the last processing attempt failed, or null if it did not fail.

getPasteYLevelGoal

public int getPasteYLevelGoal()

isRecursive

public boolean isRecursive()

isLoadChildren

public boolean isLoadChildren()

isWorldTickingEnabled

public boolean isWorldTickingEnabled()

Description copied from interface: PrefabEditorCreationContext

Whether world ticking (block updates, random ticks, etc.) is enabled in the prefab editor world. Defaults to true to maintain normal game behavior for testing.

Specified by:

isWorldTickingEnabled in interface PrefabEditorCreationContext

getRowSplitMode

public PrefabRowSplitMode getRowSplitMode()

Description copied from interface: PrefabEditorCreationContext

Determines how prefabs are split into rows when loading multiple prefabs. Defaults to BY_ALL_SUBFOLDERS for automatic organization by directory structure.

Specified by:

getRowSplitMode in interface PrefabEditorCreationContext

getEnvironment

public String getEnvironment()

Description copied from interface: PrefabEditorCreationContext

Gets the environment ID to use for the prefab editor world.

Specified by:

getEnvironment in interface PrefabEditorCreationContext

getGrassTint

public String getGrassTint()

Description copied from interface: PrefabEditorCreationContext

Gets the grass tint color as a hex string (e.g. "#5B9E28").

Specified by:

getGrassTint in interface PrefabEditorCreationContext