mirror/WorldEdit
2
0
Fork 0
mirror of https://github.com/EngineHub/WorldEdit.git synced 2025-03-07 13:48:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

Slightly improve usability of LocalSession#getSelection. (#1714)

Browse Source 
Allow the World param to be null, throwing IncompleteRegionException.

This allows calling `getSelection(getSelectionWorld())` without having
to separately null-check the World.
Also, add a convenience overload which does so: `getSelection()`.
This commit is contained in:
wizjany 2021-03-25 00:06:05 -04:00 committed by GitHub
parent 6941d955bd
commit acd63daddf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
worldedit-core/src/main/java/com/sk89q/worldedit/LocalSession.java
View File

@ -391,17 +391,34 @@ public boolean isSelectionDefined(World world) {
/**
* Get the selection region. If you change the region, you should
* call learnRegionChanges(). If the selection is defined in
* a different world, the {@code IncompleteRegionException}
* exception will be thrown.
* call learnRegionChanges(). If the selection is not fully defined,
* the {@code IncompleteRegionException} exception will be thrown.
*
* <p>Note that this method will return a region in the current selection world,
* which is not guaranteed to be the player's world or even the current world
* override. If you require a specific world, use the
* {@link LocalSession#getSelection(World)} overload instead.
*
* @return the selected region
* @throws IncompleteRegionException if the region is not fully defined
*/
public Region getSelection() throws IncompleteRegionException {
return getSelection(getSelectionWorld());
}
/**
* Get the selection region. If you change the region, you should
* call learnRegionChanges(). If the selection is defined in
* a different world, or the selection isn't fully defined,
* the {@code IncompleteRegionException} exception will be thrown.
*
* @param world the world
* @return a region
* @throws IncompleteRegionException if no region is selected
* @throws IncompleteRegionException if no region is selected, or the provided world is null
*/
public Region getSelection(World world) throws IncompleteRegionException {
checkNotNull(world);
if (selector.getIncompleteRegion().getWorld() == null || !selector.getIncompleteRegion().getWorld().equals(world)) {
public Region getSelection(@Nullable World world) throws IncompleteRegionException {
if (world == null || selector.getIncompleteRegion().getWorld() == null
|| !selector.getIncompleteRegion().getWorld().equals(world)) {
throw new IncompleteRegionException();
}
return selector.getRegion();
@ -412,6 +429,7 @@ public Region getSelection(World world) throws IncompleteRegionException {
*
* @return the the world of the selection
*/
@Nullable
public World getSelectionWorld() {
return selector.getIncompleteRegion().getWorld();
}