Package com.seibel.distanthorizons.api.interfaces.world

Interface IDhApiWorldProxy

public interface IDhApiWorldProxy

Used to interact with Distant Horizons' current world.
A world is equivalent to a single server connection or a singleplayer world.

Since:

API 1.0.0

Method Summary

Modifier and Type	Method	Description
Iterable<IDhApiLevelWrapper>	getAllLoadedLevelsForDimensionType(IDhApiDimensionTypeWrapper dimensionTypeWrapper)	In the case of servers running multiverse there may be multiple levels for the same dimensionType.
Iterable<IDhApiLevelWrapper>	getAllLoadedLevelsWithDimensionNameLike(String dimensionName)	Returns any dimensions that have names containing the given string (case-insensitive).
Iterable<IDhApiLevelWrapper>	getAllLoadedLevelWrappers()
boolean	getReadOnly()
IDhApiLevelWrapper	getSinglePlayerLevel()	In singleplayer this will return the level the player is currently in.
void	setReadOnly(boolean readOnly)	Defaults to false.
boolean	worldLoaded()	Returns true if a world is loaded.

Method Details

worldLoaded

boolean worldLoaded()

Returns true if a world is loaded.

setReadOnly

void setReadOnly(boolean readOnly)
          throws IllegalStateException

Defaults to false.
Setting this to true will prevent DH from updating or creating new LODs.

Throws:

IllegalStateException - if no world is loaded

Since:

API 4.0.0

See Also:

• getReadOnly()

getReadOnly

boolean getReadOnly()
             throws IllegalStateException

Throws:

IllegalStateException - if no world is loaded

Since:

API 4.0.0

See Also:

• setReadOnly(boolean)

getSinglePlayerLevel

IDhApiLevelWrapper getSinglePlayerLevel()
                                 throws IllegalStateException

In singleplayer this will return the level the player is currently in.
In multiplayer this will return null.

Throws:

IllegalStateException - if no world is loaded

getAllLoadedLevelWrappers

Iterable<IDhApiLevelWrapper> getAllLoadedLevelWrappers()
                                                throws IllegalStateException

Throws:

IllegalStateException - if no world is loaded

getAllLoadedLevelsForDimensionType

Iterable<IDhApiLevelWrapper> getAllLoadedLevelsForDimensionType(IDhApiDimensionTypeWrapper dimensionTypeWrapper)
                                                         throws IllegalStateException

In the case of servers running multiverse there may be multiple levels for the same dimensionType.

Throws:

IllegalStateException - if no world is loaded

getAllLoadedLevelsWithDimensionNameLike

Iterable<IDhApiLevelWrapper> getAllLoadedLevelsWithDimensionNameLike(String dimensionName)
                                                              throws IllegalStateException

Returns any dimensions that have names containing the given string (case-insensitive).
In the case of servers running multiverse there may be multiple levels for the same dimensionType.

Throws:

IllegalStateException - if no world is loaded