Interface MultiverseWorld
-
- All Known Implementing Classes:
MVWorld
public interface MultiverseWorld
The API for a Multiverse Handled World.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description boolean
addToVariable(java.lang.String property, java.lang.String value)
Deprecated.We changed the entire world-config-system.void
allowPortalMaking(AllowedPortalType type)
Sets The types of portals that are allowed in this world.boolean
canAnimalsSpawn()
Gets whether or not animals are allowed to spawn in this world.boolean
canMonstersSpawn()
Gets whether or not monsters are allowed to spawn in this world.boolean
clearList(java.lang.String property)
Deprecated.We changed the entire world-config-system.boolean
clearVariable(java.lang.String property)
Deprecated.We changed the entire world-config-system.org.bukkit.permissions.Permission
getAccessPermission()
Gets the permission required to enter this world.boolean
getAdjustSpawn()
Gets whether or not Multiverse should auto-adjust the spawn for this world.java.lang.String
getAlias()
Gets the alias of this world.AllowedPortalType
getAllowedPortals()
Gets which type(s) of portals are allowed to be constructed in this world.boolean
getAllowFlight()
Whether or not players are allowed to fly in this world.java.lang.String
getAllPropertyNames()
Gets all the names of all properties that can be SET.java.util.List<java.lang.String>
getAnimalList()
Returns a list of animals.boolean
getAutoHeal()
Gets whether or not a world will auto-heal players if the difficulty is on peaceful.boolean
getAutoLoad()
Gets whether or not Multiverse should auto-load this world.boolean
getBedRespawn()
Gets whether or not a player who dies in this world will respawn in their bed or follow the normal respawn pattern.org.bukkit.World
getCBWorld()
Returns the Bukkit world object that this world describes.org.bukkit.ChatColor
getColor()
Gets the color that this world's name/alias will display as.java.lang.String
getColoredWorldString()
Returns a very nicely colored string (using Alias and Color if they are set).@Nullable org.bukkit.Material
getCurrency()
Gets the type of currency that will be used when users enter this world.org.bukkit.Difficulty
getDifficulty()
Gets the difficulty of this world.org.bukkit.World.Environment
getEnvironment()
Gets the environment of this world.org.bukkit.permissions.Permission
getExemptPermission()
Gets the permission required to be exempt when entering.boolean
getFakePVP()
Deprecated.This is deprecated.org.bukkit.GameMode
getGameMode()
Gets the GameMode of this world.java.lang.String
getGenerator()
Gets the generator of this world.boolean
getHunger()
Gets whether or not the hunger level of players will go down in a world.java.util.List<java.lang.String>
getMonsterList()
Returns a list of monsters.java.lang.String
getName()
Gets the name of this world.java.lang.String
getPermissibleName()
Gets the lowercased name of the world.int
getPlayerLimit()
Gets the player limit for this world after which players without an override permission node will not be allowed in.double
getPrice()
Gets the amount of currency it requires to enter this world.java.lang.String
getPropertyHelp(java.lang.String property)
Gets the help-message for a property.java.lang.String
getPropertyValue(java.lang.String property)
Gets a property asString
.org.bukkit.World
getRespawnToWorld()
Gets the world players will respawn in if they die in this one.double
getScaling()
Gets the scaling value of this world.Really only has an effect if you use Multiverse-NetherPortals.long
getSeed()
Gets the world seed of this world.org.bukkit.Location
getSpawnLocation()
Gets the spawn location of this world.org.bukkit.ChatColor
getStyle()
Gets the style that this world's name/alias will display as.java.lang.String
getTime()
Same asgetTime()
, but returns a string.java.util.List<java.lang.String>
getWorldBlacklist()
Gets a list of all the worlds that players CANNOT travel to from this world, regardless of their access permissions.org.bukkit.WorldType
getWorldType()
Gets the type of this world.boolean
isHidden()
Gets whether or not this world will display in chat, mvw and mvl regardless if a user has the access permissions to go to this world.boolean
isKeepingSpawnInMemory()
Gets whether or not CraftBukkit is keeping the chunks for this world in memory.boolean
isPVPEnabled()
Gets whether or not PVP is enabled in this world in some form (fake or not).boolean
isValidAliasColor(java.lang.String color)
Deprecated.This has been moved:EnglishChatColor.isValidAliasColor(String)
boolean
isWeatherEnabled()
Gets whether weather is enabled in this world.boolean
removeFromVariable(java.lang.String property, java.lang.String value)
Deprecated.We changed the entire world-config-system.void
setAdjustSpawn(boolean adjust)
Sets whether or not Multiverse should auto-adjust the spawn for this world.void
setAlias(java.lang.String alias)
Sets the alias of the world.void
setAllowAnimalSpawn(boolean allowAnimalSpawn)
Sets whether or not animals can spawn.void
setAllowFlight(boolean allowFlight)
Sets whether or not players are allowed to fly in this world.void
setAllowMonsterSpawn(boolean allowMonsterSpawn)
Sets whether or not monsters can spawn.void
setAutoHeal(boolean heal)
Sets whether or not a world will auto-heal players if the difficulty is on peaceful.void
setAutoLoad(boolean autoLoad)
Sets whether or not Multiverse should auto-load this world.void
setBedRespawn(boolean autoLoad)
Sets whether or not a player who dies in this world will respawn in their bed or follow the normal respawn pattern.boolean
setColor(java.lang.String color)
Sets the color that this world's name/alias will display as.void
setCurrency(@Nullable org.bukkit.Material item)
Sets the type of item that will be required given the price is not 0.boolean
setDifficulty(java.lang.String difficulty)
Deprecated.UsesetDifficulty(Difficulty)
or, if you have to pass a string, usesetPropertyValue(String, String)
instead.boolean
setDifficulty(org.bukkit.Difficulty difficulty)
Sets the difficulty of this world and returnstrue
on success.void
setEnableWeather(boolean enableWeather)
Sets whether or not there will be weather events in a given world.void
setEnvironment(org.bukkit.World.Environment environment)
Sets the environment of a world.boolean
setGameMode(java.lang.String gameMode)
Deprecated.UsesetGameMode(GameMode)
instead.boolean
setGameMode(org.bukkit.GameMode gameMode)
Sets the game mode of this world.void
setGenerator(java.lang.String generator)
Sets the generator of this world.void
setHidden(boolean hidden)
Sets whether or not this world will display in chat, mvw and mvl regardless if a user has the access permissions to go to this world.void
setHunger(boolean hungerEnabled)
Sets whether or not the hunger level of players will go down in a world.void
setKeepSpawnInMemory(boolean keepSpawnInMemory)
If true, tells Craftbukkit to keep a worlds spawn chunks loaded in memory (default: true) If not, CraftBukkit will attempt to free memory when players have not used that world.void
setPlayerLimit(int limit)
Sets the player limit for this world after which players without an override permission node will not be allowed in.void
setPrice(double price)
Sets the price for entry to this world.boolean
setPropertyValue(java.lang.String property, java.lang.String value)
Sets a property to a given value.void
setPVPMode(boolean pvpMode)
Turn pvp on or off.boolean
setRespawnToWorld(java.lang.String respawnWorld)
Sets the world players will respawn in if they die in this one.boolean
setScaling(double scaling)
Sets the scale of this world.void
setSeed(long seed)
Sets the seed of this world.void
setSpawnLocation(org.bukkit.Location spawnLocation)
Sets the spawn location for a world.boolean
setStyle(java.lang.String style)
Sets the style that this world's name/alias will display as.boolean
setTime(java.lang.String timeAsString)
Sets the current time in a world.
-
-
-
Method Detail
-
getCBWorld
org.bukkit.World getCBWorld()
Returns the Bukkit world object that this world describes.- Returns:
- A
World
-
getName
java.lang.String getName()
Gets the name of this world. The name cannot be changed.Note for plugin developers: Usually
getAlias()
is what you want to use instead of this method.- Returns:
- The name of the world as a String.
-
getWorldType
org.bukkit.WorldType getWorldType()
Gets the type of this world. As of 1.2 this will be: FLAT, NORMAL or VERSION_1_1This is not the generator.
- Returns:
- The Type of this world.
-
getEnvironment
org.bukkit.World.Environment getEnvironment()
Gets the environment of this world.- Returns:
- A
World.Environment
.
-
setEnvironment
void setEnvironment(org.bukkit.World.Environment environment)
Sets the environment of a world.Note: This will ONLY take effect once the world is unloaded/reloaded.
- Parameters:
environment
- AWorld.Environment
.
-
getDifficulty
org.bukkit.Difficulty getDifficulty()
Gets the difficulty of this world.- Returns:
- The difficulty of this world.
-
setDifficulty
@Deprecated boolean setDifficulty(java.lang.String difficulty)
Deprecated.UsesetDifficulty(Difficulty)
or, if you have to pass a string, usesetPropertyValue(String, String)
instead.Sets the difficulty of this world and returns true if success. Valid string values are either an integer of difficulty(0-3) or the name that resides in the Bukkit enum, ex.PEACEFUL
- Parameters:
difficulty
- The difficulty to set the world to as a string.- Returns:
- True if success, false if the provided string could not be translated to a difficulty.
-
setDifficulty
boolean setDifficulty(org.bukkit.Difficulty difficulty)
Sets the difficulty of this world and returnstrue
on success. Valid string values are either an integer of difficulty(0-3) or the name that resides in the Bukkit enum, ex. PEACEFUL- Parameters:
difficulty
- The new difficulty.- Returns:
- True if success, false if the operation failed... for whatever reason.
-
getSeed
long getSeed()
Gets the world seed of this world.- Returns:
- The Long version of the seed.
-
setSeed
void setSeed(long seed)
Sets the seed of this world.- Parameters:
seed
- A Long that is the seed.
-
getGenerator
java.lang.String getGenerator()
Gets the generator of this world.- Returns:
- The name of the generator.
-
setGenerator
void setGenerator(java.lang.String generator)
Sets the generator of this world.- Parameters:
generator
- The new generator's name.
-
getPropertyHelp
java.lang.String getPropertyHelp(java.lang.String property) throws PropertyDoesNotExistException
Gets the help-message for a property.- Parameters:
property
- The name of the property.- Returns:
- The help-message.
- Throws:
PropertyDoesNotExistException
- Thrown if the property was not found.
-
getPropertyValue
java.lang.String getPropertyValue(java.lang.String property) throws PropertyDoesNotExistException
Gets a property asString
.- Parameters:
property
- The name of a world property to get.- Returns:
- The string-representation of that property.
- Throws:
PropertyDoesNotExistException
- Thrown if the property was not found in the world.
-
setPropertyValue
boolean setPropertyValue(java.lang.String property, java.lang.String value) throws PropertyDoesNotExistException
Sets a property to a given value.- Parameters:
property
- The name of a world property to set.value
- A value in string representation, it will be parsed to the correct type.- Returns:
- True if the value was set, false if not.
- Throws:
PropertyDoesNotExistException
- Thrown if the property was not found in the world.
-
addToVariable
@Deprecated boolean addToVariable(java.lang.String property, java.lang.String value)
Deprecated.We changed the entire world-config-system. This is not compatible any more.Adds a value to the given property. The property must be aAddProperties
.- Parameters:
property
- The name of aAddProperties
to add a value to.value
- A value in string representation, it will be parsed to the correct type.- Returns:
- True if the value was added, false if not.
-
removeFromVariable
@Deprecated boolean removeFromVariable(java.lang.String property, java.lang.String value)
Deprecated.We changed the entire world-config-system. This is not compatible any more.Removes a value from the given property. The property must be aAddProperties
.- Parameters:
property
- The name of aAddProperties
to remove a value from.value
- A value in string representation, it will be parsed to the correct type.- Returns:
- True if the value was removed, false if not.
-
clearVariable
@Deprecated boolean clearVariable(java.lang.String property)
Deprecated.We changed the entire world-config-system. This is not compatible any more.Removes all values from the given property. The property must be aAddProperties
.- Parameters:
property
- The name of aAddProperties
to clear.- Returns:
- True if it was cleared, false if not.
-
clearList
@Deprecated boolean clearList(java.lang.String property)
Deprecated.We changed the entire world-config-system. This is not compatible any more.Clears a list property (sets it to []).- Parameters:
property
- The property to clear.- Returns:
- True if success, false if fail.
-
getPermissibleName
java.lang.String getPermissibleName()
Gets the lowercased name of the world. This method is required, since the permissables lowercase all permissions when recalculating.Note: This also means if a user has worlds named: world and WORLD, that they can both exist, and both be teleported to independently, but their permissions **cannot** be uniqueified at this time. See bug report #.
- Returns:
- The lowercased name of the world.
-
getAccessPermission
org.bukkit.permissions.Permission getAccessPermission()
Gets the permission required to enter this world.- Returns:
- The permission required to be exempt from charges to/from this world.
-
getExemptPermission
org.bukkit.permissions.Permission getExemptPermission()
Gets the permission required to be exempt when entering.- Returns:
- The permission required to be exempt when entering.
-
getAlias
java.lang.String getAlias()
Gets the alias of this world.This alias allows users to have a world named "world" but show up in the list as "FernIsland"
- Returns:
- The alias of the world as a String.
-
setAlias
void setAlias(java.lang.String alias)
Sets the alias of the world.- Parameters:
alias
- A string that is the new alias.
-
getColor
org.bukkit.ChatColor getColor()
Gets the color that this world's name/alias will display as.- Returns:
- The color of this world.
-
setColor
boolean setColor(java.lang.String color)
Sets the color that this world's name/alias will display as.- Parameters:
color
- A valid color name.- Returns:
- True if the color was set, false if not.
-
getStyle
org.bukkit.ChatColor getStyle()
Gets the style that this world's name/alias will display as.- Returns:
- The style of this world.
null
for "normal" style.
-
setStyle
boolean setStyle(java.lang.String style)
Sets the style that this world's name/alias will display as.- Parameters:
style
- A valid style name.- Returns:
- True if the style was set, false if not.
-
isValidAliasColor
@Deprecated boolean isValidAliasColor(java.lang.String color)
Deprecated.This has been moved:EnglishChatColor.isValidAliasColor(String)
Tells you if someone entered a valid color.- Parameters:
color
- A string that may translate to a color.- Returns:
- True if it is a color, false if not.
-
getColoredWorldString
java.lang.String getColoredWorldString()
Returns a very nicely colored string (using Alias and Color if they are set).- Returns:
- A nicely colored string.
-
canAnimalsSpawn
boolean canAnimalsSpawn()
Gets whether or not animals are allowed to spawn in this world.- Returns:
- True if ANY animal can, false if no animals can spawn.
-
setAllowAnimalSpawn
void setAllowAnimalSpawn(boolean allowAnimalSpawn)
Sets whether or not animals can spawn. If there are values ingetAnimalList()
and this is false, those animals become the exceptions, and will spawn- Parameters:
allowAnimalSpawn
- True to allow spawning of monsters, false to prevent.
-
getAnimalList
java.util.List<java.lang.String> getAnimalList()
Returns a list of animals. This list always negates thecanAnimalsSpawn()
result.- Returns:
- A list of animals that will spawn if
canAnimalsSpawn()
is false.
-
canMonstersSpawn
boolean canMonstersSpawn()
Gets whether or not monsters are allowed to spawn in this world.- Returns:
- True if ANY monster can, false if no monsters can spawn.
-
setAllowMonsterSpawn
void setAllowMonsterSpawn(boolean allowMonsterSpawn)
Sets whether or not monsters can spawn. If there are values ingetMonsterList()
and this is false, those monsters become the exceptions, and will spawn- Parameters:
allowMonsterSpawn
- True to allow spawning of monsters, false to prevent.
-
getMonsterList
java.util.List<java.lang.String> getMonsterList()
Returns a list of monsters. This list always negates thecanMonstersSpawn()
result.- Returns:
- A list of monsters that will spawn if
canMonstersSpawn()
is false.
-
isPVPEnabled
boolean isPVPEnabled()
Gets whether or not PVP is enabled in this world in some form (fake or not).- Returns:
- True if players can take damage from other players.
-
setPVPMode
void setPVPMode(boolean pvpMode)
Turn pvp on or off. This setting is used to set the world's PVP mode.- Parameters:
pvpMode
- True to enable PVP damage, false to disable it.
-
getFakePVP
@Deprecated boolean getFakePVP()
Deprecated.This is deprecated.Turn pvp on or off. This setting is used to set the world's PVP mode, and thus relies on fakePVP- Returns:
- True if this world has fakepvp on
-
isHidden
boolean isHidden()
Gets whether or not this world will display in chat, mvw and mvl regardless if a user has the access permissions to go to this world.- Returns:
- True if the world will be hidden, false if not.
-
setHidden
void setHidden(boolean hidden)
Sets whether or not this world will display in chat, mvw and mvl regardless if a user has the access permissions to go to this world.- Parameters:
hidden
- Set
-
isWeatherEnabled
boolean isWeatherEnabled()
Gets whether weather is enabled in this world.- Returns:
- True if weather events will occur, false if not.
-
setEnableWeather
void setEnableWeather(boolean enableWeather)
Sets whether or not there will be weather events in a given world. If set to false, Multiverse will disable the weather in the world immediately.- Parameters:
enableWeather
- True if weather events should occur in a world, false if not.
-
isKeepingSpawnInMemory
boolean isKeepingSpawnInMemory()
Gets whether or not CraftBukkit is keeping the chunks for this world in memory.- Returns:
- True if CraftBukkit is keeping spawn chunks in memory.
-
setKeepSpawnInMemory
void setKeepSpawnInMemory(boolean keepSpawnInMemory)
If true, tells Craftbukkit to keep a worlds spawn chunks loaded in memory (default: true) If not, CraftBukkit will attempt to free memory when players have not used that world. This will not happen immediately.- Parameters:
keepSpawnInMemory
- If true, CraftBukkit will keep the spawn chunks loaded in memory.
-
getSpawnLocation
org.bukkit.Location getSpawnLocation()
Gets the spawn location of this world.- Returns:
- The spawn location of this world.
-
setSpawnLocation
void setSpawnLocation(org.bukkit.Location spawnLocation)
Sets the spawn location for a world.- Parameters:
spawnLocation
- The spawn location for a world.
-
getHunger
boolean getHunger()
Gets whether or not the hunger level of players will go down in a world.- Returns:
- True if it will go down, false if it will remain steady.
-
setHunger
void setHunger(boolean hungerEnabled)
Sets whether or not the hunger level of players will go down in a world.- Parameters:
hungerEnabled
- True if hunger will go down, false to keep it at the level they entered a world with.
-
getGameMode
org.bukkit.GameMode getGameMode()
Gets the GameMode of this world.- Returns:
- The GameMode of this world.
-
setGameMode
@Deprecated boolean setGameMode(java.lang.String gameMode)
Deprecated.UsesetGameMode(GameMode)
instead. If you have to pass a string, usesetPropertyValue(String, String)
.Sets the game mode of this world.- Parameters:
gameMode
- A valid game mode string (either an int ex. 0 or a string ex. creative).- Returns:
- True if the game mode was successfully changed, false if not.
-
setGameMode
boolean setGameMode(org.bukkit.GameMode gameMode)
Sets the game mode of this world.- Parameters:
gameMode
- The newGameMode
.- Returns:
- True if the game mode was successfully changed, false if not.
-
getPrice
double getPrice()
Gets the amount of currency it requires to enter this world.- Returns:
- The amount it costs to enter this world.
-
setPrice
void setPrice(double price)
Sets the price for entry to this world. You can think of this like an amount. The type can be set withsetCurrency(Material)
- Parameters:
price
- The Amount of money/item to enter the world.
-
getCurrency
@Nullable @Nullable org.bukkit.Material getCurrency()
Gets the type of currency that will be used when users enter this world. A value of null indicates a non-item based currency is used.- Returns:
- The type of currency that will be used when users enter this world.
-
setCurrency
void setCurrency(@Nullable @Nullable org.bukkit.Material item)
Sets the type of item that will be required given the price is not 0. Use a value of null to specify a non-item based currency.- Parameters:
item
- The Type of currency that will be used when users enter this world.
-
getRespawnToWorld
org.bukkit.World getRespawnToWorld()
Gets the world players will respawn in if they die in this one.- Returns:
- A world that exists on the server.
-
setRespawnToWorld
boolean setRespawnToWorld(java.lang.String respawnWorld)
Sets the world players will respawn in if they die in this one. Returns true upon success, false upon failure.- Parameters:
respawnWorld
- The name of a world that exists on the server.- Returns:
- True if respawnWorld existed, false if not.
-
getScaling
double getScaling()
Gets the scaling value of this world.Really only has an effect if you use Multiverse-NetherPortals.- Returns:
- This world's non-negative, non-zero scale.
-
setScaling
boolean setScaling(double scaling)
Sets the scale of this world. Really only has an effect if you use Multiverse-NetherPortals.- Parameters:
scaling
- A scaling value, cannot be negative or 0.- Returns:
- Whether the scale was set successfully.
-
getAutoHeal
boolean getAutoHeal()
Gets whether or not a world will auto-heal players if the difficulty is on peaceful.- Returns:
- True if the world should heal (default), false if not.
-
setAutoHeal
void setAutoHeal(boolean heal)
Sets whether or not a world will auto-heal players if the difficulty is on peaceful.- Parameters:
heal
- True if the world will heal.
-
getAdjustSpawn
boolean getAdjustSpawn()
Gets whether or not Multiverse should auto-adjust the spawn for this world.- Returns:
- True if Multiverse should adjust the spawn, false if not.
-
setAdjustSpawn
void setAdjustSpawn(boolean adjust)
Sets whether or not Multiverse should auto-adjust the spawn for this world.- Parameters:
adjust
- True if multiverse should adjust the spawn, false if not.
-
getAutoLoad
boolean getAutoLoad()
Gets whether or not Multiverse should auto-load this world.- Returns:
- True if Multiverse should auto-load this world.
-
setAutoLoad
void setAutoLoad(boolean autoLoad)
Sets whether or not Multiverse should auto-load this world.True is default.
- Parameters:
autoLoad
- True if multiverse should autoload this world the spawn, false if not.
-
getBedRespawn
boolean getBedRespawn()
Gets whether or not a player who dies in this world will respawn in their bed or follow the normal respawn pattern.- Returns:
- True if players dying in this world should respawn at their bed.
-
setBedRespawn
void setBedRespawn(boolean autoLoad)
Sets whether or not a player who dies in this world will respawn in their bed or follow the normal respawn pattern.True is default.
- Parameters:
autoLoad
- True if players dying in this world respawn at their bed.
-
setPlayerLimit
void setPlayerLimit(int limit)
Sets the player limit for this world after which players without an override permission node will not be allowed in. A value of -1 or less signifies no limit- Parameters:
limit
- The new limit
-
getPlayerLimit
int getPlayerLimit()
Gets the player limit for this world after which players without an override permission node will not be allowed in. A value of -1 or less signifies no limit- Returns:
- The player limit
-
getTime
java.lang.String getTime()
Same asgetTime()
, but returns a string.- Returns:
- The time as a short string: 12:34pm
-
setTime
boolean setTime(java.lang.String timeAsString)
Sets the current time in a world.This method will take the following formats: 11:37am 4:30p day(morning), night, noon, midnight
- Parameters:
timeAsString
- The formatted time to set the world to.- Returns:
- True if the time was set, false if not.
-
allowPortalMaking
void allowPortalMaking(AllowedPortalType type)
Sets The types of portals that are allowed in this world.- Parameters:
type
- The type of portals allowed in this world.
-
getAllowedPortals
AllowedPortalType getAllowedPortals()
Gets which type(s) of portals are allowed to be constructed in this world.- Returns:
- The type of portals that are allowed.
-
getWorldBlacklist
java.util.List<java.lang.String> getWorldBlacklist()
Gets a list of all the worlds that players CANNOT travel to from this world, regardless of their access permissions.- Returns:
- A List of world names.
-
getAllPropertyNames
java.lang.String getAllPropertyNames()
Gets all the names of all properties that can be SET.- Returns:
- All property names, with alternating colors.
-
getAllowFlight
boolean getAllowFlight()
Whether or not players are allowed to fly in this world.- Returns:
- True if players allowed to fly in this world.
-
setAllowFlight
void setAllowFlight(boolean allowFlight)
Sets whether or not players are allowed to fly in this world.- Parameters:
allowFlight
- True to allow flight in this world.
-
-