Package org.mvplugins.multiverse.portals

Class MultiversePortalsApi

java.lang.Object

org.mvplugins.multiverse.portals.MultiversePortalsApi

public final class MultiversePortalsApi
extends Object

Method Summary

Modifier and Type	Method	Description
static @NotNull MultiversePortalsApi	get()	Gets the MultiversePortalsApi.
@NotNull PortalFiller	getPortalFiller()	Gets the instance of the PortalFiller.
@NotNull PortalManager	getPortalManager()	Gets the instance of the PortalManager.
@NotNull PortalsConfig	getPortalsConfig()	Gets the instance of the PortalsConfig.
@NotNull org.mvplugins.multiverse.core.inject.PluginServiceLocator	getServiceLocator()	Gets the instance of Multiverse-Portals's PluginServiceLocator.

Methods inherited from class java.lang.Object

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

Method Details

get

@NotNull
public static @NotNull MultiversePortalsApi get()

Gets the MultiversePortalsApi. This will throw an exception if the Multiverse-Portals has not been initialized.

Returns:

The MultiversePortalsApi

getPortalFiller

@NotNull
public @NotNull PortalFiller getPortalFiller()

Gets the instance of the PortalFiller.

Returns:

The PortalFiller instance

getPortalManager

@NotNull
public @NotNull PortalManager getPortalManager()

Gets the instance of the PortalManager.

Returns:

The PortalManager instance

getPortalsConfig

@AvailableSince("5.1")
@NotNull
public @NotNull PortalsConfig getPortalsConfig()

Gets the instance of the PortalsConfig.

Returns:

The PortalsConfig instance

Since:

5.1

getServiceLocator

@NotNull
public @NotNull org.mvplugins.multiverse.core.inject.PluginServiceLocator getServiceLocator()

Gets the instance of Multiverse-Portals's PluginServiceLocator.
You can use this to hook into the hk2 dependency injection system used by Multiverse-Portals.

Returns:

The Multiverse-Portals's PluginServiceLocator