More JavaDoc improvements.
This commit is contained in:
@@ -2,6 +2,9 @@ package org.bukkit.event.world;
|
||||
|
||||
import org.bukkit.Chunk;
|
||||
|
||||
/**
|
||||
* Represents a Chunk related event
|
||||
*/
|
||||
public class ChunkEvent extends WorldEvent {
|
||||
protected Chunk chunk;
|
||||
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
|
||||
package org.bukkit.event.world;
|
||||
|
||||
import org.bukkit.Chunk;
|
||||
|
||||
@@ -1,12 +1,10 @@
|
||||
package org.bukkit.event.world;
|
||||
|
||||
|
||||
import org.bukkit.block.Block;
|
||||
import org.bukkit.World;
|
||||
import org.bukkit.event.Cancellable;
|
||||
import java.util.ArrayList;
|
||||
|
||||
|
||||
/**
|
||||
* Called when the world attempts to create a matching end to a portal
|
||||
*/
|
||||
@@ -19,6 +17,11 @@ public class PortalCreateEvent extends WorldEvent implements Cancellable {
|
||||
this.blocks = blocks;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets an array list of all the blocks associated with the created portal
|
||||
*
|
||||
* @return array list of all the blocks associated with the created portal
|
||||
*/
|
||||
public ArrayList<Block> getBlocks() {
|
||||
return this.blocks;
|
||||
}
|
||||
|
||||
@@ -6,8 +6,6 @@ import org.bukkit.Location;
|
||||
/**
|
||||
* An event that is called when a world's spawn changes. The
|
||||
* world's previous spawn location is included.
|
||||
*
|
||||
* @author willurd
|
||||
*/
|
||||
public class SpawnChangeEvent extends WorldEvent {
|
||||
private Location previousLocation;
|
||||
|
||||
@@ -2,6 +2,9 @@ package org.bukkit.event.world;
|
||||
|
||||
import org.bukkit.World;
|
||||
|
||||
/**
|
||||
* Called when a World is initializing
|
||||
*/
|
||||
public class WorldInitEvent extends WorldEvent {
|
||||
public WorldInitEvent(World world) {
|
||||
super(Type.WORLD_INIT, world);
|
||||
|
||||
@@ -2,6 +2,9 @@ package org.bukkit.event.world;
|
||||
|
||||
import org.bukkit.World;
|
||||
|
||||
/**
|
||||
* Called when a World is loaded
|
||||
*/
|
||||
public class WorldLoadEvent extends WorldEvent {
|
||||
public WorldLoadEvent(World world) {
|
||||
super(Type.WORLD_LOAD, world);
|
||||
|
||||
@@ -3,6 +3,9 @@ package org.bukkit.event.world;
|
||||
import org.bukkit.World;
|
||||
import org.bukkit.event.Cancellable;
|
||||
|
||||
/**
|
||||
* Called when a World is unloaded
|
||||
*/
|
||||
public class WorldUnloadEvent extends WorldEvent implements Cancellable {
|
||||
|
||||
private boolean isCancelled;
|
||||
@@ -11,10 +14,22 @@ public class WorldUnloadEvent extends WorldEvent implements Cancellable {
|
||||
super(Type.WORLD_UNLOAD, world);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the cancellation state of this event. A cancelled event will not
|
||||
* be executed in the server, but will still pass to other plugins
|
||||
*
|
||||
* @return true if this event is cancelled
|
||||
*/
|
||||
public boolean isCancelled() {
|
||||
return this.isCancelled;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the cancellation state of this event. A cancelled event will not
|
||||
* be executed in the server, but will still pass to other plugins
|
||||
*
|
||||
* @param cancel true if you wish to cancel this event
|
||||
*/
|
||||
public void setCancelled(boolean cancel) {
|
||||
this.isCancelled = cancel;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user