Adds missing JavaDoc
This commit is contained in:
parent
56ed0495b0
commit
56bf51f370
@ -14,7 +14,23 @@ public class RelativeBlockVector {
|
||||
private final int down;
|
||||
private final int out;
|
||||
|
||||
public enum Property {RIGHT, DOWN, OUT}
|
||||
/**
|
||||
* A specifier for one of the relative block vector's three properties
|
||||
*/
|
||||
public enum Property {
|
||||
/**
|
||||
* Specifies the relative block vector's right property
|
||||
*/
|
||||
RIGHT,
|
||||
/**
|
||||
* Specifies the relative block vector's down property
|
||||
*/
|
||||
DOWN,
|
||||
/**
|
||||
* Specifies the relative block vector's out property
|
||||
*/
|
||||
OUT
|
||||
}
|
||||
|
||||
/**
|
||||
* Instantiates a new relative block vector
|
||||
|
@ -64,6 +64,8 @@ public class StargateEntityPortalEvent extends StargateEvent {
|
||||
|
||||
/**
|
||||
* Set the location of the entity's exit point
|
||||
*
|
||||
* @param location <p>The new location of the entity's exit point</p>
|
||||
*/
|
||||
public void setExit(Location location) {
|
||||
this.exit = location;
|
||||
|
@ -53,6 +53,8 @@ public class StargatePlayerPortalEvent extends StargatePlayerEvent {
|
||||
|
||||
/**
|
||||
* Set the location of the player's exit point
|
||||
*
|
||||
* @param location <p>The new location of the player's exit point</p>
|
||||
*/
|
||||
public void setExit(Location location) {
|
||||
this.exit = location;
|
||||
|
@ -71,7 +71,8 @@ public class PortalOpener {
|
||||
/**
|
||||
* Open this portal opener's portal
|
||||
*
|
||||
* @param force <p>Whether to force the portal open, even if it's already open for some player</p>
|
||||
* @param openFor <p>The player to open the portal for</p>
|
||||
* @param force <p>Whether to force the portal open, even if it's already open for some player</p>
|
||||
*/
|
||||
public void openPortal(Player openFor, boolean force) {
|
||||
//Call the StargateOpenEvent to allow the opening to be cancelled
|
||||
|
@ -24,7 +24,13 @@ import java.util.List;
|
||||
*/
|
||||
public abstract class Teleporter {
|
||||
|
||||
/**
|
||||
* The portal the entity is teleporting to
|
||||
*/
|
||||
protected final Portal portal;
|
||||
/**
|
||||
* The scheduler to use for delaying tasks
|
||||
*/
|
||||
protected final BukkitScheduler scheduler;
|
||||
|
||||
/**
|
||||
|
Loading…
x
Reference in New Issue
Block a user