Commits

Doc authored and md_5 committed 7d1f5b64cbf
SPIGOT-6780: Improve documentation for World#spawnFallingBlock
No tags

src/main/java/org/bukkit/World.java

Modified
1210 1210 /**
1211 1211 * Gets a list of all applied {@link BlockPopulator}s for this World
1212 1212 *
1213 1213 * @return List containing any or none BlockPopulators
1214 1214 */
1215 1215 @NotNull
1216 1216 public List<BlockPopulator> getPopulators();
1217 1217
1218 1218 /**
1219 1219 * Spawn a {@link FallingBlock} entity at the given {@link Location} of
1220 - * the specified {@link Material}. The material dictates what is falling.
1220 + * the specified {@link MaterialData}. The MaterialData dictates what is falling.
1221 1221 * When the FallingBlock hits the ground, it will place that block.
1222 1222 * <p>
1223 1223 * The Material must be a block type, check with {@link Material#isBlock()
1224 - * material.isBlock()}. The Material may not be air.
1224 + * data.getItemType().isBlock()}. The Material may not be air.
1225 1225 *
1226 1226 * @param location The {@link Location} to spawn the FallingBlock
1227 1227 * @param data The block data
1228 1228 * @return The spawned {@link FallingBlock} instance
1229 1229 * @throws IllegalArgumentException if {@link Location} or {@link
1230 1230 * MaterialData} are null or {@link Material} of the {@link MaterialData} is not a block
1231 1231 */
1232 1232 @NotNull
1233 1233 public FallingBlock spawnFallingBlock(@NotNull Location location, @NotNull MaterialData data) throws IllegalArgumentException;
1234 1234
1235 1235 /**
1236 1236 * Spawn a {@link FallingBlock} entity at the given {@link Location} of
1237 - * the specified {@link Material}. The material dictates what is falling.
1237 + * the specified {@link BlockData}. The BlockData dictates what is falling.
1238 1238 * When the FallingBlock hits the ground, it will place that block.
1239 - * <p>
1240 - * The Material must be a block type, check with {@link Material#isBlock()
1241 - * material.isBlock()}. The Material may not be air.
1242 1239 *
1243 1240 * @param location The {@link Location} to spawn the FallingBlock
1244 - * @param data The block data
1241 + * @param data The {@link BlockData} of the FallingBlock to spawn
1245 1242 * @return The spawned {@link FallingBlock} instance
1246 1243 * @throws IllegalArgumentException if {@link Location} or {@link
1247 1244 * BlockData} are null
1248 1245 */
1249 1246 @NotNull
1250 1247 public FallingBlock spawnFallingBlock(@NotNull Location location, @NotNull BlockData data) throws IllegalArgumentException;
1251 1248
1252 1249 /**
1253 1250 * Spawn a {@link FallingBlock} entity at the given {@link Location} of the
1254 1251 * specified {@link Material}. The material dictates what is falling.

Everything looks good. We'll let you know here if there's anything you should know about.

Add shortcut