com.github.riking.templateworlds.api

Interface ApiMain

public interface ApiMain

This class is a plugin's access into TemplateWorlds. Instances are retrieved through the Bukkit ServicesManager - this is to allow easy updating across Minecraft versions.

Method Summary

Methods

Modifier and Type	Method and Description
void	changeTemplate(org.bukkit.World templated, org.bukkit.World newTemplate) Change the template for the given templated world.
org.bukkit.World	createWorld(String name, org.bukkit.World template) Create a new templated world with the given name and template world
org.bukkit.World	createWorld(String name, org.bukkit.World template, Collection<org.bukkit.generator.BlockPopulator> extraPopulators) Create a templated world with the given name, template world, and extra BlockPopulators from your plugin.
org.bukkit.generator.ChunkGenerator	getTemplatedGenerator(String world, String template) Get a templated ChunkGenerator for the given world.
org.bukkit.generator.ChunkGenerator	getVoidGenerator() Get a ChunkGenerator that will only create empty (all air / void) chunks.
boolean	isTemplatedWorld(org.bukkit.World world) Check whether the given World was created by this plugin.
void	onDisable(org.bukkit.plugin.Plugin templateWorlds) Please do not call this method.
void	onEnable(org.bukkit.plugin.Plugin templateWorlds) Please do not call this method.
void	resetArea(org.bukkit.World templated, int chunkMinX, int chunkMinZ, int chunkMaxX, int chunkMaxZ) Reset all chunks in the given area to the chunks in the template world.
void	resetArea(org.bukkit.World templated, org.bukkit.Location a, org.bukkit.Location b) Reset all chunks in the area bounded in X and Z by the two locations to the chunks in the template world.
void	resetAreaGradually(org.bukkit.World templated, int chunkMinX, int chunkMinZ, int chunkMaxX, int chunkMaxZ, Runnable callback) Reset all chunks in the given area to the chunks in the template world over time.
void	resetAreaGradually(org.bukkit.World templated, int chunkMinX, int chunkMinZ, int chunkMaxX, int chunkMaxZ, Runnable callback, double timeAllotment) Reset all chunks in the given area to the chunks in the template world over time.
void	resetAreaGradually(org.bukkit.World templated, org.bukkit.Location a, org.bukkit.Location b, Runnable callback) Reset all chunks in the area bounded in X and Z by the two locations to the chunks in the template world over time.

Method Detail

onEnable

void onEnable(org.bukkit.plugin.Plugin templateWorlds)

Please do not call this method.

onDisable

void onDisable(org.bukkit.plugin.Plugin templateWorlds)

Please do not call this method.

createWorld

org.bukkit.World createWorld(String name,
                           org.bukkit.World template)

Create a new templated world with the given name and template world

Parameters:

name - name of the world folder for the templated world

template - the world to use as the template

Returns:

a World whose templated chunks must now be regenerated

createWorld

org.bukkit.World createWorld(String name,
                           org.bukkit.World template,
                           Collection<org.bukkit.generator.BlockPopulator> extraPopulators)

Create a templated world with the given name, template world, and extra BlockPopulators from your plugin. (This will typically create a different world each time, assuming the Populator uses the Random argument.)

Parameters:

name - name of the world folder for the templated world

template - the world to use as the template

Returns:

a WorldCreator ready to create a World

getTemplatedGenerator

org.bukkit.generator.ChunkGenerator getTemplatedGenerator(String world,
                                                        String template)

Get a templated ChunkGenerator for the given world.

This allows people to create templated worlds from the command line with Multiverse or from bukkit.yml.

Parameters:

world - the world this is being created for

template - a string that should be the template world

Returns:

a ChunkGenerator that you can give to a WorldCreator to make a templated world

getVoidGenerator

org.bukkit.generator.ChunkGenerator getVoidGenerator()

Get a ChunkGenerator that will only create empty (all air / void) chunks. This is useful when loading the world to use as the template, as it is possible for the templated world to cause new chunks to be generated on the template when that is not desirable.

Returns:

a ChunkGenerator that will only create empty chunks

isTemplatedWorld

boolean isTemplatedWorld(org.bukkit.World world)

Check whether the given World was created by this plugin.

Parameters:

world - a world that may or may not be templated

Returns:

if the world was templated

resetAreaGradually

void resetAreaGradually(org.bukkit.World templated,
                      int chunkMinX,
                      int chunkMinZ,
                      int chunkMaxX,
                      int chunkMaxZ,
                      Runnable callback)

Reset all chunks in the given area to the chunks in the template world over time. The provided Runnable will be executed once the reset is complete.

Parameters:

templated - A templated world

chunkMinX - low chunk-coord X to regenerate

chunkMinZ - low chunk-coord Z to regenerate

chunkMaxX - high chunk-coord X to regenerate

chunkMaxZ - high chunk-coord Z to regenerate

callback - A Runnable to execute once the resetting is completed. It will be executed on the server main thread. May be null.

Throws:

IllegalArgumentException - if max < min

IllegalArgumentException - if the provided world is not a templated world

resetAreaGradually

void resetAreaGradually(org.bukkit.World templated,
                      org.bukkit.Location a,
                      org.bukkit.Location b,
                      Runnable callback)

Reset all chunks in the area bounded in X and Z by the two locations to the chunks in the template world over time. The provided Runnable will be executed once the reset is complete.

Parameters:

templated - A templated world

a - one corner of the bounding box

b - opposite corner of the bounding box

callback - A Runnable to execute once the resetting is completed. It will be executed on the server main thread. May be null.

Throws:

IllegalArgumentException - if the provided world is not a templated world

resetAreaGradually

void resetAreaGradually(org.bukkit.World templated,
                      int chunkMinX,
                      int chunkMinZ,
                      int chunkMaxX,
                      int chunkMaxZ,
                      Runnable callback,
                      double timeAllotment)

Reset all chunks in the given area to the chunks in the template world over time. The provided Runnable will be executed once the reset is complete.

Parameters:

templated - A templated world

chunkMinX - low chunk-coord X to regenerate

chunkMinZ - low chunk-coord Z to regenerate

chunkMaxX - high chunk-coord X to regenerate

chunkMaxZ - high chunk-coord Z to regenerate

callback - A Runnable to execute once the resetting is completed. It will be executed on the server main thread. May be null.

timeAllotment - What FRACTION of 1/20th of a second (one tick) to spend doing the reset. If the allotment is less than the time it takes to reset a chunk, only 1 chunk will be reset per tick. Be warned that values in excess of 100 billion may also exhibit this behavior, due to overflow of the long type.

Throws:

IllegalArgumentException - if max < min

IllegalArgumentException - if the provided world is not a templated world

resetArea

void resetArea(org.bukkit.World templated,
             int chunkMinX,
             int chunkMinZ,
             int chunkMaxX,
             int chunkMaxZ)

Reset all chunks in the given area to the chunks in the template world.

Parameters:

templated - A templated world

chunkMinX - low chunk-coord X to regenerate

chunkMinZ - low chunk-coord Z to regenerate

chunkMaxX - high chunk-coord X to regenerate

chunkMaxZ - high chunk-coord Z to regenerate

Throws:

IllegalArgumentException - if max < min

IllegalArgumentException - if the provided world is not a templated world

resetArea

void resetArea(org.bukkit.World templated,
             org.bukkit.Location a,
             org.bukkit.Location b)

Reset all chunks in the area bounded in X and Z by the two locations to the chunks in the template world.

Parameters:

templated - A templated world

a - one corner of the bounding box

b - opposite corner of the bounding box

Throws:

IllegalArgumentException - if the provided world is not a templated world

changeTemplate

void changeTemplate(org.bukkit.World templated,
                  org.bukkit.World newTemplate)

Change the template for the given templated world.

After changing the template, you must reset the area for the changes to take effect.

Parameters:

templated - A templated world

newTemplate - The world to use as the new template

Throws:

IllegalArgumentException - if the provided world is not a templated world