mirror of
https://github.com/Multiverse/Multiverse-Core.git
synced 2024-11-22 02:25:41 +01:00
Added some javadocs.
This commit is contained in:
parent
32c92fc39d
commit
1708d1dedd
@ -9,14 +9,20 @@ import com.dumptruckman.minecraft.pluginbase.plugin.PluginBase;
|
|||||||
* This is the class you should cast your plugin to unless you need more Implementation specific API.
|
* This is the class you should cast your plugin to unless you need more Implementation specific API.
|
||||||
*/
|
*/
|
||||||
public interface MultiverseCore extends MultiversePlugin, PluginBase {
|
public interface MultiverseCore extends MultiversePlugin, PluginBase {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the primary class responsible for managing Multiverse Worlds.
|
* Gets the Multiverse world manager.
|
||||||
|
*
|
||||||
|
* The world manager allows you to perform various tasks related to Minecraft worlds.
|
||||||
*
|
*
|
||||||
* @return {@link WorldManager}.
|
* @return {@link WorldManager}.
|
||||||
*/
|
*/
|
||||||
WorldManager getWorldManager();
|
WorldManager getWorldManager();
|
||||||
|
|
||||||
CoreConfig config();
|
/**
|
||||||
|
* Gets the Multiverse-Core configuration.
|
||||||
|
*
|
||||||
|
* @return The Multiverse-Core configuration.
|
||||||
|
*/
|
||||||
CoreConfig getMVConfig();
|
CoreConfig getMVConfig();
|
||||||
}
|
}
|
||||||
|
@ -1,5 +1,8 @@
|
|||||||
package com.mvplugin.core.api;
|
package com.mvplugin.core.api;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implement this if you would
|
||||||
|
*/
|
||||||
public interface MultiversePlugin {
|
public interface MultiversePlugin {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -17,11 +20,12 @@ public interface MultiversePlugin {
|
|||||||
void setCore(MultiverseCore core);
|
void setCore(MultiverseCore core);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Allows Multiverse or a plugin to query another Multiverse plugin to see what version its protocol is. This
|
* Allows Multiverse or a plugin to query another Multiverse plugin to see what version its protocol is.
|
||||||
* number
|
|
||||||
* should change when something will break the code.
|
|
||||||
*
|
*
|
||||||
* @return The Integer protocol version.
|
* This number should change when something will break the code. Generally your plugin should be checking the
|
||||||
|
* Multiverse-Core's protocol version to ensure compatibility.
|
||||||
|
*
|
||||||
|
* @return The protocol version.
|
||||||
*/
|
*/
|
||||||
int getProtocolVersion();
|
int getProtocolVersion();
|
||||||
}
|
}
|
||||||
|
@ -0,0 +1,5 @@
|
|||||||
|
/**
|
||||||
|
* The Multiverse-API, containing lots of interfaces that can be quite useful for other
|
||||||
|
* plugins when interacting with Multiverse.
|
||||||
|
*/
|
||||||
|
package com.mvplugin.core.api;
|
@ -10,8 +10,9 @@ import com.mvplugin.core.util.PropertyDescriptions;
|
|||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The primary Bukkit plugin implementation of Multiverse-Core. See {@link MultiverseCore} for a more detailed
|
* The primary Bukkit plugin implementation of Multiverse-Core.
|
||||||
* external api javadocs.
|
*
|
||||||
|
* See {@link MultiverseCore} for a more detailed external api javadocs.
|
||||||
*/
|
*/
|
||||||
public class MultiverseCorePlugin extends AbstractBukkitPlugin implements MultiverseCore {
|
public class MultiverseCorePlugin extends AbstractBukkitPlugin implements MultiverseCore {
|
||||||
|
|
||||||
@ -56,7 +57,7 @@ public class MultiverseCorePlugin extends AbstractBukkitPlugin implements Multiv
|
|||||||
|
|
||||||
@Override
|
@Override
|
||||||
public CoreConfig config() {
|
public CoreConfig config() {
|
||||||
return (CoreConfig) super.config(); //To change body of overridden methods use File | Settings | File Templates.
|
return (CoreConfig) super.config();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
|
Loading…
Reference in New Issue
Block a user