Class BiomeMaskJsonLoader

java.lang.Object

com.hypixel.hytale.procedurallib.json.Loader<SeedStringResource, IIntCondition>

com.hypixel.hytale.procedurallib.json.JsonLoader<SeedStringResource, IIntCondition>

com.hypixel.hytale.server.worldgen.loader.biome.BiomeMaskJsonLoader

public class BiomeMaskJsonLoader
extends JsonLoader<SeedStringResource, IIntCondition>

Biome masks can be used to control the placement of world-gen features. In json format they'd be defined as an array of 'rule' strings.

A rule string should defined in the format: "Zone_Name.Biome_Name#Type": 'Zone_Name' - The containing Zone's name. If excluded then the Zone is derived from context. 'Biome_Name' - The name of the Biome to add to the mask. 'Type' - The type of Biome (Tile or Custom). If excluded then Biomes of each type will be added to the mask.

Special characters: '.' - Character separates the Zone invalid input: '&' Biome names. '#' - Character separates the Biome invalid input: '&' Type names. '*' - Wildcard character can be used to match all Biomes in the Zone

Examples: "Zone1_Tier1.Plains_Birch#Tile" - Match Tile.Plains_Birch.json only in Z1T1 "Zone1_Tier1.*#Custom" - Match all Custom biomes in Z1T1 "Zone1_Tier1.Plains_Birch" - Match Tile invalid input: '&' Custom variants of Plains_Birch in Z1T1 "Plains_Birch#Custom" - Match Custom.Plains_Birch.json in the currently loading Zone "Plains_Birch" - Match Tile invalid input: '&' Custom variants of Plains_Birch in the currently loading Zone

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BiomeMaskJsonLoader.Constants

Field Summary

Fields inherited from class JsonLoader

JSON_ARR_LOADER, JSON_LOADER, JSON_OBJ_LOADER

Constructor Summary

Constructors

Constructor	Description
BiomeMaskJsonLoader(SeedString<SeedStringResource> seed, Path dataFolder, com.google.gson.JsonElement json, String maskName, ZoneFileContext zoneContext)

Method Summary

Modifier and Type	Method	Description
IIntCondition	load()

Methods inherited from class JsonLoader

get, getOrLoad, getRaw, has

Methods inherited from class Loader

getDataFolder, getSeed

Methods inherited from class Object

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

Constructor Details

BiomeMaskJsonLoader

public BiomeMaskJsonLoader(@Nonnull
 SeedString<SeedStringResource> seed,
 Path dataFolder,
 com.google.gson.JsonElement json,
 String maskName,
 ZoneFileContext zoneContext)

Method Details

load

@Nullable
public IIntCondition load()

Specified by:

load in class Loader<SeedStringResource, IIntCondition>