SteamWar/Paper
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Many javadoc fixes thanks to Celtic Minstrel

Browse Source 
By: Dinnerbone <dinnerbone@dinnerbone.com>
This commit is contained in:
Bukkit/Spigot
2011-09-25 02:56:40 +01:00
parent 1968b78a12
commit a8e72bdb91
78 changed files with 380 additions and 335 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
paper-api/src/main/java/org/bukkit/event/Event.java
View File

@@ -90,8 +90,8 @@ public abstract class Event implements Serializable {
/**
* Represents Player-based events
*
* @see Category.LIVING_ENTITY
*
* @see #LIVING_ENTITY
*/
PLAYER,
/**
@@ -134,8 +134,6 @@ public abstract class Event implements Serializable {
/**
* Provides a lookup for all core events
*
* @see org.bukkit.event.
*/
public enum Type {
@@ -421,13 +419,13 @@ public abstract class Event implements Serializable {
/**
* Called when a piston extends
*
* @see org.bukkit.event.block.PistonExtendEvent
* @see org.bukkit.event.block.BlockPistonExtendEvent
*/
BLOCK_PISTON_EXTEND (Category.BLOCK),
/**
* Called when a piston retracts
*
* @see org.bukkit.event.block.PistonRetractEvent
* @see org.bukkit.event.block.BlockPistonRetractEvent
*/
BLOCK_PISTON_RETRACT (Category.BLOCK),
@@ -529,7 +527,7 @@ public abstract class Event implements Serializable {
/**
* Called when a newly created chunk has been populated.
*
* If your intent is to populate the chunk using this event, please see {@link BlockPopulator}
* If your intent is to populate the chunk using this event, please see {@link org.bukkit.generator.BlockPopulator}
*
* @see org.bukkit.event.world.ChunkPopulateEvent
*/

3
paper-api/src/main/java/org/bukkit/event/EventException.java
View File

@@ -22,6 +22,8 @@ public class EventException extends Exception {
/**
* Constructs a new EventException with the given message
* @param cause The exception that caused this
* @param message The message
*/
public EventException(Throwable cause, String message) {
super(message);
@@ -30,6 +32,7 @@ public class EventException extends Exception {
/**
* Constructs a new EventException with the given message
* @param message The message
*/
public EventException(String message) {
super(message);

2
paper-api/src/main/java/org/bukkit/event/block/BlockFormEvent.java
View File

@@ -11,7 +11,7 @@ import org.bukkit.event.Cancellable;
* Examples:
*<ul>
* <li>Snow forming due to a snow storm.</li>
* <li>Ice forming in a snowy Biome like Tiga or Tundra.</li>
* <li>Ice forming in a snowy Biome like Taiga or Tundra.</li>
* </ul>
*<p />
* If a Block Form event is cancelled, the block will not be formed.

1
paper-api/src/main/java/org/bukkit/event/block/BlockListener.java
View File

@@ -1,7 +1,6 @@
package org.bukkit.event.block;
import org.bukkit.event.Listener;
import org.bukkit.plugin.AuthorNagException;
/**
* Handles all events thrown in relation to Blocks

3
paper-api/src/main/java/org/bukkit/event/entity/CreeperPowerEvent.java
View File

@@ -11,20 +11,17 @@ import org.bukkit.event.Cancellable;
public class CreeperPowerEvent extends EntityEvent implements Cancellable {
private boolean canceled;
private Entity creeper;
private PowerCause cause;
private Entity bolt;
public CreeperPowerEvent(Entity creeper, Entity bolt, PowerCause cause) {
super(Type.CREEPER_POWER, creeper);
this.creeper = creeper;
this.bolt = bolt;
this.cause = cause;
}
public CreeperPowerEvent(Entity creeper, PowerCause cause) {
super(Type.CREEPER_POWER, creeper);
this.creeper = creeper;
this.cause = cause;
this.bolt = null;
}

3
paper-api/src/main/java/org/bukkit/event/entity/EntityDamageByBlockEvent.java
View File

@@ -2,12 +2,11 @@ package org.bukkit.event.entity;
import org.bukkit.block.Block;
import org.bukkit.entity.Entity;
import org.bukkit.event.Cancellable;
/**
* Called when an entity is damaged by a block
*/
public class EntityDamageByBlockEvent extends EntityDamageEvent implements Cancellable {
public class EntityDamageByBlockEvent extends EntityDamageEvent {
private Block damager;

3
paper-api/src/main/java/org/bukkit/event/entity/EntityDamageByEntityEvent.java
View File

@@ -1,12 +1,11 @@
package org.bukkit.event.entity;
import org.bukkit.entity.Entity;
import org.bukkit.event.Cancellable;
/**
* Called when an entity is damaged by an entity
*/
public class EntityDamageByEntityEvent extends EntityDamageEvent implements Cancellable {
public class EntityDamageByEntityEvent extends EntityDamageEvent {
private Entity damager;

5
paper-api/src/main/java/org/bukkit/event/entity/EntityExplodeEvent.java
View File

@@ -33,6 +33,7 @@ public class EntityExplodeEvent extends EntityEvent implements Cancellable {
/**
* Returns the list of blocks that would have been removed or were
* removed from the explosion event.
* @return All blown-up blocks
*/
public List<Block> blockList() {
return blocks;
@@ -42,6 +43,7 @@ public class EntityExplodeEvent extends EntityEvent implements Cancellable {
* Returns the location where the explosion happened.
* It is not possible to get this value from the Entity as
* the Entity no longer exists in the world.
* @return The location of the explosion
*/
public Location getLocation() {
return location;
@@ -50,7 +52,7 @@ public class EntityExplodeEvent extends EntityEvent implements Cancellable {
/**
* Returns the percentage of blocks to drop from this explosion
*
* @return
* @return The yield.
*/
public float getYield() {
return yield;
@@ -58,6 +60,7 @@ public class EntityExplodeEvent extends EntityEvent implements Cancellable {
/**
* Sets the percentage of blocks to drop from this explosion
* @param yield The new yield percentage
*/
public void setYield(float yield) {
this.yield = yield;

1
paper-api/src/main/java/org/bukkit/event/entity/EntityPortalEnterEvent.java
View File

@@ -3,7 +3,6 @@ package org.bukkit.event.entity;
import org.bukkit.entity.Entity;
import org.bukkit.Location;
import org.bukkit.event.Cancellable;
/**
* Stores data for entities standing inside a portal block

8
paper-api/src/main/java/org/bukkit/event/entity/EntityTargetEvent.java
View File

@@ -4,7 +4,7 @@ import org.bukkit.entity.Entity;
import org.bukkit.event.Cancellable;
/**
* Called when a creature targets another entity
* Called when a creature targets or untargets another entity
*/
public class EntityTargetEvent extends EntityEvent implements Cancellable {
private boolean cancel;
@@ -28,15 +28,17 @@ public class EntityTargetEvent extends EntityEvent implements Cancellable {
/**
* Returns the reason for the targeting
* @return The reason
*/
public TargetReason getReason() {
return reason;
}
/**
* Get the entity that this is target.
* This is possible to be null in the case that the event is called when
* Get the entity that this is targeting.
* This will be null in the case that the event is called when
* the mob forgets its target.
* @return The entity
*/
public Entity getTarget() {
return target;

2
paper-api/src/main/java/org/bukkit/event/entity/PigZapEvent.java
View File

@@ -9,13 +9,11 @@ import org.bukkit.event.Cancellable;
public class PigZapEvent extends EntityEvent implements Cancellable {
private boolean canceled;
private Entity pig;
private Entity pigzombie;
private Entity bolt;
public PigZapEvent(Entity pig, Entity bolt, Entity pigzombie) {
super(Type.PIG_ZAP, pig);
this.pig = pig;
this.bolt = bolt;
this.pigzombie = pigzombie;
}

1
paper-api/src/main/java/org/bukkit/event/painting/PaintingBreakEvent.java
View File

@@ -1,6 +1,5 @@
package org.bukkit.event.painting;
import org.bukkit.entity.Entity;
import org.bukkit.entity.Painting;
import org.bukkit.event.Cancellable;

1
paper-api/src/main/java/org/bukkit/event/painting/PaintingPlaceEvent.java
View File

@@ -2,7 +2,6 @@ package org.bukkit.event.painting;
import org.bukkit.block.Block;
import org.bukkit.block.BlockFace;
import org.bukkit.entity.Entity;
import org.bukkit.entity.Painting;
import org.bukkit.entity.Player;
import org.bukkit.event.Cancellable;

2
paper-api/src/main/java/org/bukkit/event/player/PlayerPreLoginEvent.java
View File

@@ -87,7 +87,7 @@ public class PlayerPreLoginEvent extends Event {
/**
* Gets the player IP address.
*
* @return
* @return The IP address
*/
public InetAddress getAddress() {
return ipAddress;

1
paper-api/src/main/java/org/bukkit/event/server/ServerCommandEvent.java
View File

@@ -35,6 +35,7 @@ public class ServerCommandEvent extends ServerEvent {
/**
* Get the command sender.
* @return The sender
*/
public CommandSender getSender() {
return sender;

2
paper-api/src/main/java/org/bukkit/event/vehicle/VehicleDamageEvent.java
View File

@@ -39,7 +39,7 @@ public class VehicleDamageEvent extends VehicleEvent implements Cancellable {
/**
* Sets the damage done to the vehicle
*
* @param damage
* @param damage The damage
*/
public void setDamage(int damage) {
this.damage = damage;

2
paper-api/src/main/java/org/bukkit/event/vehicle/VehicleExitEvent.java
View File

@@ -19,7 +19,7 @@ public class VehicleExitEvent extends VehicleEvent implements Cancellable {
/**
* Get the living entity that exited the vehicle.
*
* @return
* @return The entity.
*/
public LivingEntity getExited() {
return exited;

18
paper-api/src/main/java/org/bukkit/event/vehicle/VehicleListener.java
View File

@@ -14,63 +14,63 @@ public class VehicleListener implements Listener {
* Called when a vehicle is created by a player. This hook will be called
* for all vehicles created.
*
* @param event
* @param event The event
*/
public void onVehicleCreate(VehicleCreateEvent event) {}
/**
* Called when a vehicle is damaged by the player.
*
* @param event
* @param event The event
*/
public void onVehicleDamage(VehicleDamageEvent event) {}
/**
* Called when a vehicle collides with a block.
*
* @param event
* @param event The event
*/
public void onVehicleBlockCollision(VehicleBlockCollisionEvent event) {}
/**
* Called when a vehicle collides with an entity.
*
* @param event
* @param event The event
*/
public void onVehicleEntityCollision(VehicleEntityCollisionEvent event) {}
/**
* Called when an entity enters a vehicle.
*
* @param event
* @param event The event
*/
public void onVehicleEnter(VehicleEnterEvent event) {}
/**
* Called when an entity exits a vehicle.
*
* @param event
* @param event The event
*/
public void onVehicleExit(VehicleExitEvent event) {}
/**
* Called when an vehicle moves.
*
* @param event
* @param event The event
*/
public void onVehicleMove(VehicleMoveEvent event) {}
/**
* Called when a vehicle is destroyed.
*
* @param event
* @param event The event
*/
public void onVehicleDestroy(VehicleDestroyEvent event) {}
/**
* Called when a vehicle goes through an update cycle
*
* @param event
* @param event The event
*/
public void onVehicleUpdate(VehicleUpdateEvent event) {}
}

4
paper-api/src/main/java/org/bukkit/event/vehicle/VehicleMoveEvent.java
View File

@@ -22,7 +22,7 @@ public class VehicleMoveEvent extends VehicleEvent {
/**
* Get the previous position.
*
* @return
* @return Old position.
*/
public Location getFrom() {
return from;
@@ -31,7 +31,7 @@ public class VehicleMoveEvent extends VehicleEvent {
/**
* Get the next position.
*
* @return
* @return New position.
*/
public Location getTo() {
return to;

3
paper-api/src/main/java/org/bukkit/event/weather/LightningStrikeEvent.java
View File

@@ -1,7 +1,6 @@
package org.bukkit.event.weather;
import org.bukkit.World;
import org.bukkit.entity.Entity;
import org.bukkit.entity.LightningStrike;
import org.bukkit.event.Cancellable;
@@ -12,12 +11,10 @@ public class LightningStrikeEvent extends WeatherEvent implements Cancellable {
private boolean canceled;
private LightningStrike bolt;
private World world;
public LightningStrikeEvent(World world, LightningStrike bolt) {
super(Type.LIGHTNING_STRIKE, world);
this.bolt = bolt;
this.world = world;
}
public boolean isCancelled() {

2
paper-api/src/main/java/org/bukkit/event/world/WorldListener.java
View File

@@ -17,7 +17,7 @@ public class WorldListener implements Listener {
/**
* Called when a newly created chunk has been populated.
*
* If your intent is to populate the chunk using this event, please see {@link BlockPopulator}
* If your intent is to populate the chunk using this event, please see {@link org.bukkit.generator.BlockPopulator}
*
* @param event Relevant event details
*/