Plexus/Plex-FAWE
1
0
Fork 0
mirror of https://github.com/plexusorg/Plex-FAWE.git synced 2025-07-06 20:56:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Javadoc and Formatting fixes. (#619)

Browse Source 
Javadoc and Formatting fixes.

Also, extremely minor code changes which have been tested.
This commit is only part one of two commits that aim to fix problems with formatting in our project. In part two I will modify the Google Java Style Guide (since it closely matches our code style) for our project so there is guidance on how to format and document. 

* Updated PlotSquared URL
* Removed plugin acronyms
* Fixed a typo
* Fixed grammar
* Use modern block id's
* Update YouTube video URL
This commit is contained in:
Matt
2020-10-05 13:41:41 -04:00
committed by GitHub
parent b06d943f7c
commit 96dcb95b7c
393 changed files with 6537 additions and 4700 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
worldedit-core/src/main/java/com/sk89q/worldedit/entity/Player.java
View File

@ -55,7 +55,7 @@ import java.io.File;
import javax.annotation.Nullable;
/**
* Represents a player
* Represents a player.
*/
public interface Player extends Entity, Actor {
@ -356,30 +356,29 @@ public interface Player extends Entity, Actor {
void setSelection(Region region);
/**
* Get the player's current selection (or null)
* Get the player's selection region. If the selection is defined in
* a different world, the {@code IncompleteRegionException}
* exception will be thrown.
*
* @return
* @return a region
* @throws IncompleteRegionException if no region is selected
*/
default Region getSelection() {
try {
return getSession().getSelection(getWorld());
} catch (IncompleteRegionException e) {
return null;
}
default Region getSelection() throws IncompleteRegionException {
return getSession().getSelection(getWorld());
}
/**
* Set the player's WorldEdit selection
* Set the player's WorldEdit selection.
*
* @param selector
* @param selector the selector
*/
default void setSelection(RegionSelector selector) {
getSession().setRegionSelector(getWorld(), selector);
}
/**
* Get the World the player is editing in (may not match the world they are in)<br/> - e.g., If
* they are editing a CFI world.<br/>
* Get the world the player is editing in. The world may or may not match the world they are in.
* For example, if they are editing a CFI world.
*
* @return Editing world
*/
@ -396,7 +395,7 @@ public interface Player extends Entity, Actor {
}
/**
* Unregister this player (deletes all metadata etc) - Usually called on logout
* Unregister this player, deleting all data stored during the logon session.
*/
default void unregister() {
cancel(true);
@ -410,7 +409,7 @@ public interface Player extends Entity, Actor {
void sendTitle(Component title, Component sub);
/**
* Loads any history items from disk: - Should already be called if history on disk is enabled
* Loads any history items from disk: - Should already be called if history on disk is enabled.
*/
default void loadClipboardFromDisk() {
File file = MainUtil.getFile(Fawe.imp().getDirectory(),