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

More JavaDoc improvements.

Browse Source 
By: EvilSeph <evilseph@unaligned.org>
This commit is contained in:
Bukkit/Spigot
2011-06-24 02:32:04 -04:00
parent 0630db640b
commit c54128077a
56 changed files with 435 additions and 139 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
paper-api/src/main/java/org/bukkit/event/vehicle/VehicleBlockCollisionEvent.java
View File

@@ -5,8 +5,6 @@ import org.bukkit.entity.Vehicle;
/**
* Raised when a vehicle collides with a block.
*
* @author sk89q
*/
public class VehicleBlockCollisionEvent extends VehicleCollisionEvent {
private Block block;
@@ -16,6 +14,11 @@ public class VehicleBlockCollisionEvent extends VehicleCollisionEvent {
this.block = block;
}
/**
* Gets the block the vehicle collided with
*
* @return the block the vehicle collided with
*/
public Block getBlock() {
return block;
}

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

@@ -4,8 +4,6 @@ import org.bukkit.entity.Vehicle;
/**
* Raised when a vehicle collides.
*
* @author sk89q
*/
public class VehicleCollisionEvent extends VehicleEvent {
public VehicleCollisionEvent(Type type, Vehicle vehicle) {

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

@@ -6,8 +6,6 @@ import org.bukkit.event.Cancellable;
/**
* Raised when a vehicle receives damage.
*
* @author sk89q
*/
public class VehicleDamageEvent extends VehicleEvent implements Cancellable {
private Entity attacker;
@@ -20,16 +18,26 @@ public class VehicleDamageEvent extends VehicleEvent implements Cancellable {
this.damage = damage;
}
/**
* Gets the Entity that is attacking the vehicle
*
* @return the Entity that is attacking the vehicle
*/
public Entity getAttacker() {
return attacker;
}
/**
* Gets the damage done to the vehicle
*
* @return the damage done to the vehicle
*/
public int getDamage() {
return damage;
}
/**
* Change the damage.
* Sets the damage done to the vehicle
*
* @param damage
*/
@@ -37,10 +45,22 @@ public class VehicleDamageEvent extends VehicleEvent implements Cancellable {
this.damage = damage;
}
/**
* 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 cancelled;
}
/**
* 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.cancelled = cancel;
}

19
paper-api/src/main/java/org/bukkit/event/vehicle/VehicleDestroyEvent.java
View File

@@ -6,8 +6,6 @@ import org.bukkit.event.Cancellable;
/**
* Raised when a vehicle is destroyed
*
* @author sk89q, cyklo
*/
public class VehicleDestroyEvent extends VehicleEvent implements Cancellable {
private Entity attacker;
@@ -18,14 +16,31 @@ public class VehicleDestroyEvent extends VehicleEvent implements Cancellable {
this.attacker = attacker;
}
/**
* Gets the Entity that has destroyed the vehicle
*
* @return the Entity that has destroyed the vehicle
*/
public Entity getAttacker() {
return attacker;
}
/**
* 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 cancelled;
}
/**
* 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.cancelled = cancel;
}

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

@@ -6,8 +6,6 @@ import org.bukkit.event.Cancellable;
/**
* Raised when an entity enters a vehicle.
*
* @author sk89q
*/
public class VehicleEnterEvent extends VehicleEvent implements Cancellable {
private boolean cancelled;
@@ -19,18 +17,30 @@ public class VehicleEnterEvent extends VehicleEvent implements Cancellable {
}
/**
* Get the entity that entered the vehicle.
* Gets the Entity that entered the vehicle.
*
* @return
* @return the Entity that entered the vehicle
*/
public Entity getEntered() {
return entered;
}
/**
* 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 cancelled;
}
/**
* 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.cancelled = cancel;
}

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

@@ -6,8 +6,6 @@ import org.bukkit.event.Cancellable;
/**
* Raised when a living entity exits a vehicle.
*
* @author sk89q
*/
public class VehicleExitEvent extends VehicleEvent implements Cancellable {
private boolean cancelled;
@@ -27,10 +25,22 @@ public class VehicleExitEvent extends VehicleEvent implements Cancellable {
return exited;
}
/**
* 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 cancelled;
}
/**
* 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.cancelled = cancel;
}