net.tridentsdk.server.world

Class TridentWorldLoader

java.lang.Object

net.tridentsdk.server.world.TridentWorldLoader

All Implemented Interfaces:

WorldLoader

public class TridentWorldLoader
extends Object
implements WorldLoader

The world loading class, creates, saves, handles worlds

Author:

The TridentSDK Team

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,TridentWorld>	WORLDS

Constructor Summary

Constructors

Constructor and Description
TridentWorldLoader()
TridentWorldLoader(WorldCreateOptions opt)

Method Summary

Modifier and Type	Method and Description
List<FeatureGenerator>	brushes() Obtains a mutable collection of the overlay brushes used to generate the world
boolean	chunkExists(ChunkLocation location) Checks the existence of a chunk in a world, based on the world directory
boolean	chunkExists(int x, int z) Checks the existence of a chunk in a world, based on the world directory
World	createWorld(String name) Creates a new world
ChunkGenerator	generator() The generator used to load new chunks used by this world loader
World	load(String world) Load an existing world inside the server's file container
static void	loadAll()
TridentChunk	loadChunk(ChunkLocation location) Loads the chunk into the world
Chunk	loadChunk(int x, int z) Loads the chunk into the world
WorldCreateOptions	options() Options used for creating the world
void	save() Writes the changes made to the world to the world folder
void	saveChunk(Chunk chunk) Writes the changes in the chunk to the world file
void	setGenerator(long seed)
Collection<TridentWorld>	worlds()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.tridentsdk.world.WorldLoader

newLoader, newLoader, worldExists

Field Detail

WORLDS

public static final Map<String,TridentWorld> WORLDS

Constructor Detail

TridentWorldLoader

public TridentWorldLoader(WorldCreateOptions opt)

TridentWorldLoader

public TridentWorldLoader()

Method Detail

worlds

public Collection<TridentWorld> worlds()

loadAll

@InternalUseOnly
public static void loadAll()

load

public World load(String world)

Description copied from interface: WorldLoader

Load an existing world inside the server's file container

Specified by:

load in interface WorldLoader

Parameters:

world - the name of the folder containing a world

Returns:

the world loaded

save

public void save()

Description copied from interface: WorldLoader

Writes the changes made to the world to the world folder

Specified by:

save in interface WorldLoader

createWorld

public World createWorld(String name)

Description copied from interface: WorldLoader

Creates a new world

Specified by:

createWorld in interface WorldLoader

Parameters:

name - the name of the new world

Returns:

the world which was created

chunkExists

public boolean chunkExists(int x,
                           int z)

Description copied from interface: WorldLoader

Checks the existence of a chunk in a world, based on the world directory

Specified by:

chunkExists in interface WorldLoader

Parameters:

x - the X coordinate of the chunk

z - the Z coordinate of the chunk

Returns:

true if the chunk is not present within the world directory

chunkExists

public boolean chunkExists(ChunkLocation location)

Description copied from interface: WorldLoader

Checks the existence of a chunk in a world, based on the world directory

Specified by:

chunkExists in interface WorldLoader

Parameters:

location - the position which the chunk should be checked for existence

Returns:

true if the chunk is not present within the world directory

loadChunk

public Chunk loadChunk(int x,
                       int z)

Description copied from interface: WorldLoader

Loads the chunk into the world

Specified by:

loadChunk in interface WorldLoader

Parameters:

x - the X of the chunk

z - the Z of the chunk

Returns:

the chunk which was loaded

loadChunk

public TridentChunk loadChunk(ChunkLocation location)

Description copied from interface: WorldLoader

Loads the chunk into the world

Specified by:

loadChunk in interface WorldLoader

Parameters:

location - the position of the chunk to load

Returns:

the chunk which was loaded

saveChunk

public void saveChunk(Chunk chunk)

Description copied from interface: WorldLoader

Writes the changes in the chunk to the world file

Specified by:

saveChunk in interface WorldLoader

Parameters:

chunk - the chunk which to write the changes

options

public WorldCreateOptions options()

Description copied from interface: WorldLoader

Options used for creating the world

Specified by:

options in interface WorldLoader

Returns:

the world creation options

setGenerator

public void setGenerator(long seed)

generator

public ChunkGenerator generator()

Description copied from interface: WorldLoader

The generator used to load new chunks used by this world loader

Specified by:

generator in interface WorldLoader

Returns:

the generation abstraction to generated chunks

brushes

public List<FeatureGenerator> brushes()

Description copied from interface: WorldLoader

Obtains a mutable collection of the overlay brushes used to generate the world

Specified by:

brushes in interface WorldLoader

Returns:

the overlay brushes