Skip to content

Commit

Permalink
Update JavaDocs regarding teleportation of entities. Fixes BUKKIT-4210
Browse files Browse the repository at this point in the history
Up until Minecraft version 1.5 it was not possible to teleport entities
within vehicles. With the 1.5 update came the change in the Minecraft
teleportation logic to dismount before teleporting the entity, if
applicable.

This commit simply ammends the JavaDocs for the associated CraftBukkit
half regarding the action the teleportation methods will take before
completing a teleport.
  • Loading branch information
aviansie-ben authored and turt2live committed Aug 17, 2014
1 parent e0dc947 commit f210234
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions src/main/java/org/bukkit/entity/Entity.java
Expand Up @@ -65,15 +65,17 @@ public interface Entity extends Metadatable {
public World getWorld();

/**
* Teleports this entity to the given location
* Teleports this entity to the given location. If this entity is riding a
* vehicle, it will be dismounted prior to teleportation.
*
* @param location New location to teleport this entity to
* @return <code>true</code> if the teleport was successful
*/
public boolean teleport(Location location);

/**
* Teleports this entity to the given location
* Teleports this entity to the given location. If this entity is riding a
* vehicle, it will be dismounted prior to teleportation.
*
* @param location New location to teleport this entity to
* @param cause The cause of this teleportation
Expand All @@ -82,15 +84,17 @@ public interface Entity extends Metadatable {
public boolean teleport(Location location, TeleportCause cause);

/**
* Teleports this entity to the target Entity
* Teleports this entity to the target Entity. If this entity is riding a
* vehicle, it will be dismounted prior to teleportation.
*
* @param destination Entity to teleport this entity to
* @return <code>true</code> if the teleport was successful
*/
public boolean teleport(Entity destination);

/**
* Teleports this entity to the target Entity
* Teleports this entity to the target Entity. If this entity is riding a
* vehicle, it will be dismounted prior to teleportation.
*
* @param destination Entity to teleport this entity to
* @param cause The cause of this teleportation
Expand Down

3 comments on commit f210234

@fynntimes
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if anyone knew, two years ago, that this would be the final commit before everything would change.

@James137137
Copy link

@James137137 James137137 commented on f210234 May 26, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cough: see spigot repo, Bukkit isn't dead Cough Cough

@fynntimes
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I said "until everything changed," not "until Bukkit died." I know it isn't dead, but this repository certainly is small shadow of its former self.

Please sign in to comment.