* This API contains a bunch of useful things you can get out of Multiverse in general! */ public interface Core { diff --git a/src/main/java/com/onarandombox/MultiverseCore/api/MVDestination.java b/src/main/java/com/onarandombox/MultiverseCore/api/MVDestination.java index b0ac0b44..fd0f6cce 100644 --- a/src/main/java/com/onarandombox/MultiverseCore/api/MVDestination.java +++ b/src/main/java/com/onarandombox/MultiverseCore/api/MVDestination.java @@ -21,7 +21,7 @@ import org.bukkit.util.Vector; public interface MVDestination { /** * Returns the identifier or prefix that is required for this destination. - *
+ ** Portals have a prefix of "p" for example and OpenWarp (third party plugin) uses "ow". This is derived from a * hash and cannot have duplicate values. Read that as your plugin cannot use 'p' because it's already used. * Please check the wiki when adding a custom destination! @@ -32,7 +32,7 @@ public interface MVDestination { /** * Allows you to determine if a Destination is valid for the type it thinks it is. - *
+ ** An example of this would be the exact destination. A valid string would be: e:0,0,0 where an invalid one would * be e:1:2:3. The first string would return true the second would return false. This is simply a convenience * method @@ -48,11 +48,11 @@ public interface MVDestination { /** * Returns the location a specific entity will spawn at. - *
+ ** To just retrieve the location as it is stored you can just pass null, but be warned some destinations may return * null back to you if you do this. It is always safer to pass an actual entity. This is used so things like * minecarts can be teleported. - *
+ ** Do not forget to use {@link #getVelocity()} as destinations can use this too! * * @param entity The entity to be teleported. @@ -63,7 +63,7 @@ public interface MVDestination { /** * Returns the velocity vector for this destination. - *
+ ** Plugins wishing to fully support MVDestinations MUST implement this. * * @return A vector representing the speed/direction the player should travel when arriving @@ -72,7 +72,7 @@ public interface MVDestination { /** * Sets the destination string. - *
+ ** This should be used when you want to tell this destination object about a change in where it should take people. * The destination param should be match the result from {@link #getIdentifier()}. A valid example would be that if * {@link #getIdentifier()} returned "ow" our destination string could be "ow:TownCenter" but could not be @@ -85,7 +85,7 @@ public interface MVDestination { /** * Returns true if the destination is valid and players will be taken to it. - *
+ ** Even if destinations are in the correct format (p:MyPortal) MyPortal may not exist, and therefore this would * return false. * @@ -95,7 +95,7 @@ public interface MVDestination { /** * Gives you a general friendly description of the type of destination. - *
+ ** For example, the PlayerDestination sets this to "Player". You can use this to show where a player will be taken. * * @return A friendly string description of the type of destination. @@ -104,7 +104,7 @@ public interface MVDestination { /** * Gives you a specific name of the destination. - *
+ ** For example, the PlayerDestination sets this to The Player's Name. * * @return A friendly string stating the name of the destination. @@ -114,7 +114,7 @@ public interface MVDestination { /** * Returns a string that can easily be saved in the config that contains all the details needed to rebuild this * destination. - *
+ ** ex: e:0,0,0:50:50 * * @return The savable config string. @@ -123,9 +123,9 @@ public interface MVDestination { /** * Returns the permissions string required to go here. - *
+ ** ex: multiverse.access.world - *
+ ** NOTE: This is NOT the permission to use the teleport command. * * @return the permissions string required to go here. @@ -134,7 +134,7 @@ public interface MVDestination { /** * Should the Multiverse SafeTeleporter be used? - *
+ ** If not, MV will blindly take people to the location specified. * * @return True if the SafeTeleporter will be used, false if not. diff --git a/src/main/java/com/onarandombox/MultiverseCore/api/MVWorldManager.java b/src/main/java/com/onarandombox/MultiverseCore/api/MVWorldManager.java index 52c77702..086e01a1 100644 --- a/src/main/java/com/onarandombox/MultiverseCore/api/MVWorldManager.java +++ b/src/main/java/com/onarandombox/MultiverseCore/api/MVWorldManager.java @@ -19,7 +19,7 @@ import java.util.List; /** * Multiverse 2 World Manager API - *
+ ** This API contains all of the world managing * functions that your heart desires! */ @@ -142,7 +142,7 @@ public interface MVWorldManager { /** * Loads the Worlds & Settings for any worlds that bukkit loaded before us. - *
+ ** This way people will _always_ have some worlds in the list. */ public void loadDefaultWorlds(); diff --git a/src/main/java/com/onarandombox/MultiverseCore/api/MultiverseWorld.java b/src/main/java/com/onarandombox/MultiverseCore/api/MultiverseWorld.java index d7ac5fa1..89c54b51 100644 --- a/src/main/java/com/onarandombox/MultiverseCore/api/MultiverseWorld.java +++ b/src/main/java/com/onarandombox/MultiverseCore/api/MultiverseWorld.java @@ -17,7 +17,7 @@ import java.util.List; /** * The API for a Multiverse Handled World. - *
+ ** Currently INCOMPLETE */ public interface MultiverseWorld { @@ -97,7 +97,7 @@ public interface MultiverseWorld { /** * Sets the environment of a world. - *
+ ** Note: This will ONLY take effect once the world is unloaded/reloaded. * * @param environment A {@link org.bukkit.World.Environment}. @@ -127,7 +127,7 @@ public interface MultiverseWorld { /** * Gets the alias of this world. - *
+ ** This alias allows users to have a world named "world" but show up in the list as "FernIsland" * * @return The alias of the world as a String. @@ -472,7 +472,7 @@ public interface MultiverseWorld { /** * Sets whether or not Multiverse should auto-load this world. - *
+ ** True is default. * * @param autoLoad True if multiverse should autoload this world the spawn, false if not. @@ -489,7 +489,7 @@ public interface MultiverseWorld { /** * 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. * * @param autoLoad True if players dying in this world respawn at their bed. diff --git a/src/main/java/com/onarandombox/MultiverseCore/event/MVWorldPropertyChangeEvent.java b/src/main/java/com/onarandombox/MultiverseCore/event/MVWorldPropertyChangeEvent.java index 4fadfade..6a102da8 100644 --- a/src/main/java/com/onarandombox/MultiverseCore/event/MVWorldPropertyChangeEvent.java +++ b/src/main/java/com/onarandombox/MultiverseCore/event/MVWorldPropertyChangeEvent.java @@ -14,9 +14,9 @@ import org.bukkit.event.Event; /** * This event is fired *before* the property is actually changed. - *
+ ** If it is cancled, no change will happen. - *
+ ** If you want to get the values of the world before the change, query the world. * If you want to get the value being changed, use getProperty() */ diff --git a/src/main/java/com/onarandombox/MultiverseCore/utils/PermissionTools.java b/src/main/java/com/onarandombox/MultiverseCore/utils/PermissionTools.java index 056dbe94..84e9c2be 100644 --- a/src/main/java/com/onarandombox/MultiverseCore/utils/PermissionTools.java +++ b/src/main/java/com/onarandombox/MultiverseCore/utils/PermissionTools.java @@ -106,7 +106,7 @@ public class PermissionTools { /** * Checks to see if player can go to a world given their current status. - *
+ ** The return is a little backwards, and will return a value safe for event.setCancelled. * * @param fromWorld The MultiverseWorld they are in. diff --git a/src/test/java/com/onarandombox/MultiverseCore/test/utils/MockBlock.java b/src/test/java/com/onarandombox/MultiverseCore/test/utils/MockBlock.java index 3eb3b18d..9519f29b 100644 --- a/src/test/java/com/onarandombox/MultiverseCore/test/utils/MockBlock.java +++ b/src/test/java/com/onarandombox/MultiverseCore/test/utils/MockBlock.java @@ -263,7 +263,7 @@ public class MockBlock implements Block{ /** * Captures the current state of this block. You may then cast that state * into any accepted type, such as Furnace or Sign. - *
+ ** The returned object will never be updated, and you are not guaranteed that * (for example) a sign is still a sign after you capture its state. * @@ -352,7 +352,7 @@ public class MockBlock implements Block{ /** * Checks if this block is empty. - *
+ ** A block is considered empty when {@link #getType()} returns {@link org.bukkit.Material#AIR}. * * @return true if this block is empty @@ -364,7 +364,7 @@ public class MockBlock implements Block{ /** * Checks if this block is liquid. - *
+ ** A block is considered liquid when {@link #getType()} returns {@link org.bukkit.Material#WATER}, {@link * org.bukkit.Material#STATIONARY_WATER}, {@link org.bukkit.Material#LAVA} or {@link * org.bukkit.Material#STATIONARY_LAVA}. diff --git a/src/test/java/com/onarandombox/MultiverseCore/test/utils/TestCommandSender.java b/src/test/java/com/onarandombox/MultiverseCore/test/utils/TestCommandSender.java index f4e89a78..c7089599 100644 --- a/src/test/java/com/onarandombox/MultiverseCore/test/utils/TestCommandSender.java +++ b/src/test/java/com/onarandombox/MultiverseCore/test/utils/TestCommandSender.java @@ -87,7 +87,7 @@ public class TestCommandSender implements CommandSender { /** * Gets the value of the specified permission, if set. - *
+ ** If a permission override is not set on this object, the default value of the permission will be returned. * * @param name Name of the permission @@ -100,7 +100,7 @@ public class TestCommandSender implements CommandSender { /** * Gets the value of the specified permission, if set. - *
+ ** If a permission override is not set on this object, the default value of the permission will be returned * * @param perm Permission to get @@ -174,7 +174,7 @@ public class TestCommandSender implements CommandSender { /** * Recalculates the permissions for this object, if the attachments have changed values. - *
+ ** This should very rarely need to be called from a plugin. */ @Override