Package com.infernalsuite.aswm.api.world
Interface SlimeWorld
- All Superinterfaces:
org.bukkit.persistence.PersistentDataHolder
,io.papermc.paper.persistence.PersistentDataViewHolder
public interface SlimeWorld
extends org.bukkit.persistence.PersistentDataHolder
In-memory representation of a SRF world.
-
Method Summary
Modifier and TypeMethodDescriptionReturns a clone of the world with the given name.clone
(String worldName, SlimeLoader loader) Returns a clone of the world with the given name.getChunk
(int x, int z) Returns the chunk that belongs to the coordinates specified.int
com.flowpowered.nbt.CompoundTag
Returns the extra data of the world.Returns theSlimeLoader
used to load and store the world.getName()
Returns the name of the world.Returns the property map.Collection
<com.flowpowered.nbt.CompoundTag> Returns aCollection
with every world map, serialized in aCompoundTag
object.boolean
Returns whether read-only is enabled.Methods inherited from interface org.bukkit.persistence.PersistentDataHolder
getPersistentDataContainer
-
Method Details
-
getName
String getName()Returns the name of the world.- Returns:
- The name of the world.
-
getLoader
SlimeLoader getLoader()Returns theSlimeLoader
used to load and store the world.- Returns:
- The
SlimeLoader
used to load and store the world.
-
getChunk
Returns the chunk that belongs to the coordinates specified.- Parameters:
x
- X coordinate.z
- Z coordinate.- Returns:
- The
SlimeChunk
that belongs to those coordinates.
-
getChunkStorage
Collection<SlimeChunk> getChunkStorage() -
getExtraData
com.flowpowered.nbt.CompoundTag getExtraData()Returns the extra data of the world. Inside thisCompoundTag
can be stored any information to then be retrieved later, as it's saved alongside the world data.- Returns:
- A
CompoundTag
containing the extra data of the world.
-
getWorldMaps
Collection<com.flowpowered.nbt.CompoundTag> getWorldMaps()Returns aCollection
with every world map, serialized in aCompoundTag
object.- Returns:
- A
Collection
containing every world map.
-
getPropertyMap
SlimePropertyMap getPropertyMap()Returns the property map.- Returns:
- A
SlimePropertyMap
object containing all the properties of the world.
-
isReadOnly
boolean isReadOnly()Returns whether read-only is enabled.- Returns:
- true if read-only is enabled, false otherwise.
-
clone
Returns a clone of the world with the given name. This world will never be stored, as thereadOnly
property will be set to true.- Parameters:
worldName
- The name of the cloned world.- Returns:
- The clone of the world.
- Throws:
IllegalArgumentException
- if the name of the world is the same as the current one or isnull
.
-
clone
SlimeWorld clone(String worldName, SlimeLoader loader) throws WorldAlreadyExistsException, IOException Returns a clone of the world with the given name. The world will be automatically stored inside the provided data source.- Parameters:
worldName
- The name of the cloned world.loader
- TheSlimeLoader
used to store the world ornull
if the world is temporary.- Returns:
- The clone of the world.
- Throws:
IllegalArgumentException
- if the name of the world is the same as the current one or isnull
.WorldAlreadyExistsException
- if there's already a world with the same name inside the provided data source.IOException
- if the world could not be stored.
-
getDataVersion
int getDataVersion()
-