Spigot / Bukkit / a329bc55365

Commits

bendude56 authored and turt2live committed a329bc55365 08 Jul 2013

Update JavaDocs regarding teleportation of entities. Fixes BUKKIT-4210

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.

src/main/java/org/bukkit/entity/Entity.java

Modified


58 58	public boolean isOnGround();
59 59
60 60	/**
61 61	* Gets the current world this entity resides in
62 62	*
63 63	* @return World
64 64	*/
65 65	public World getWorld();
66 66
67 67	/**
68 -	* Teleports this entity to the given location
68 +	* Teleports this entity to the given location. If this entity is riding a
69 +	* vehicle, it will be dismounted prior to teleportation.
69 70	*
70 71	* @param location New location to teleport this entity to
71 72	* @return <code>true</code> if the teleport was successful
72 73	*/
73 74	public boolean teleport(Location location);
74 75
75 76	/**
76 -	* Teleports this entity to the given location
77 +	* Teleports this entity to the given location. If this entity is riding a
78 +	* vehicle, it will be dismounted prior to teleportation.
77 79	*
78 80	* @param location New location to teleport this entity to
79 81	* @param cause The cause of this teleportation
80 82	* @return <code>true</code> if the teleport was successful
81 83	*/
82 84	public boolean teleport(Location location, TeleportCause cause);
83 85
84 86	/**
85 -	* Teleports this entity to the target Entity
87 +	* Teleports this entity to the target Entity. If this entity is riding a
88 +	* vehicle, it will be dismounted prior to teleportation.
86 89	*
87 90	* @param destination Entity to teleport this entity to
88 91	* @return <code>true</code> if the teleport was successful
89 92	*/
90 93	public boolean teleport(Entity destination);
91 94
92 95	/**
93 -	* Teleports this entity to the target Entity
96 +	* Teleports this entity to the target Entity. If this entity is riding a
97 +	* vehicle, it will be dismounted prior to teleportation.
94 98	*
95 99	* @param destination Entity to teleport this entity to
96 100	* @param cause The cause of this teleportation
97 101	* @return <code>true</code> if the teleport was successful
98 102	*/
99 103	public boolean teleport(Entity destination, TeleportCause cause);
100 104
101 105	/**
102 106	* Returns a list of entities within a bounding box centered around this
103 107	* entity

Bukkit

Commits

Jira Issues

Add shortcut