PandacubeFr/BungeeCord
1
0
Fork 0
Code Releases Activity

Fix formatting in a bunch of files.

Browse Source
This commit is contained in:
md_5
2015-02-14 18:36:58 +11:00
parent 2055c98ebe
commit 61cee2d27c
14 changed files with 63 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
api/src/main/java/net/md_5/bungee/api/Title.java
View File

@@ -4,17 +4,18 @@ import net.md_5.bungee.api.chat.BaseComponent;
import net.md_5.bungee.api.connection.ProxiedPlayer;
/**
* Represents a configuration of a title.
* A title in Minecraft consists of a main title and a sub title.
* It will {@link #fadeIn(int)}, {@link #stay(int)}, and {@link #fadeOut(int)}
* for a specified amount of time.
* In most cases you will want to {@link #reset()} the current title first so
* your title won't be affected by a previous one.
* Represents a configuration of a title. A title in Minecraft consists of a
* main title and a sub title. It will {@link #fadeIn(int)}, {@link #stay(int)},
* and {@link #fadeOut(int)} for a specified amount of time. In most cases you
* will want to {@link #reset()} the current title first so your title won't be
* affected by a previous one.
* <p>
* You can create a new configuration by calling {@link ProxyServer#createTitle()}.
* You can create a new configuration by calling
* {@link ProxyServer#createTitle()}.
*/
public interface Title
{
/**
* Set the title to send to the player.
*
@@ -31,7 +32,6 @@ public interface Title
*/
public Title title(BaseComponent... text);
/**
* Set the subtitle to send to the player.
*
@@ -48,12 +48,11 @@ public interface Title
*/
public Title subTitle(BaseComponent... text);
/**
* Set the duration in ticks of the fade in effect of the title.
* Once this period of time is over the title will stay for the amount
* of time specified in {@link #stay(int)}.
* The default value for the official Minecraft version is 20 (1 second).
* Set the duration in ticks of the fade in effect of the title. Once this
* period of time is over the title will stay for the amount of time
* specified in {@link #stay(int)}. The default value for the official
* Minecraft version is 20 (1 second).
*
* @param ticks The amount of ticks (1/20 second) for the fade in effect.
* @return This title configuration.
@@ -62,9 +61,9 @@ public interface Title
/**
* Set the duration in ticks how long the title should stay on the screen.
* Once this period of time is over the title will fade out using the duration
* specified in {@link #fadeOut(int)}.
* The default value for the official Minecraft version is 60 (3 seconds).
* Once this period of time is over the title will fade out using the
* duration specified in {@link #fadeOut(int)}. The default value for the
* official Minecraft version is 60 (3 seconds).
*
* @param ticks The amount of ticks (1/20 second) for the fade in effect.
* @return This title configuration.
@@ -72,35 +71,33 @@ public interface Title
public Title stay(int ticks);
/**
* Set the duration in ticks of the fade out effect of the title.
* The default value for the official Minecraft version is 20 (1 second).
* Set the duration in ticks of the fade out effect of the title. The
* default value for the official Minecraft version is 20 (1 second).
*
* @param ticks The amount of ticks (1/20 second) for the fade out effect.
* @return This title configuration.
*/
public Title fadeOut(int ticks);
/**
* Remove the currently displayed title from the player's screen.
* This will keep the currently used display times and will only remove the title.
* Remove the currently displayed title from the player's screen. This will
* keep the currently used display times and will only remove the title.
*
* @return This title configuration.
*/
public Title clear();
/**
* Remove the currently displayed title from the player's screen
* and set the configuration back to the default values.
* Remove the currently displayed title from the player's screen and set the
* configuration back to the default values.
*
* @return This title configuration.
*/
public Title reset();
/**
* Send this title configuration to the specified player.
* This is the same as calling {@link ProxiedPlayer#sendTitle(Title)}.
* Send this title configuration to the specified player. This is the same
* as calling {@link ProxiedPlayer#sendTitle(Title)}.
*
* @param player The player to send the title to.
* @return This title configuration.

13
api/src/main/java/net/md_5/bungee/api/connection/ProxiedPlayer.java
View File

@@ -175,14 +175,15 @@ public interface ProxiedPlayer extends Connection, CommandSender
/**
* Gets whether this player is using a FML client.
* <p>
* This method is only reliable if BungeeCord links Minecraft 1.8 servers
* together, as Bungee can pick up whether a user is a Forge user with the
* This method is only reliable if BungeeCord links Minecraft 1.8 servers
* together, as Bungee can pick up whether a user is a Forge user with the
* initial handshake. If this is used for a 1.7 network, this might return
* <code>false</code> even if the user is a FML user, as Bungee can only
* determine this information if a handshake successfully completes.
* </p>
* @return <code>true</code> if it is known that the user is using a FML
* client, <code>false</code> otherwise.
*
* @return <code>true</code> if it is known that the user is using a FML
* client, <code>false</code> otherwise.
*/
boolean isForgeUser();
@@ -195,7 +196,7 @@ public interface ProxiedPlayer extends Connection, CommandSender
* <p>
* Consumers of this API should be aware that an empty mod list does
* <em>not</em> indicate that a user is not a Forge user, and so should not
* use this API to check for this. See the {@link #isForgeUser()
* use this API to check for this. See the {@link #isForgeUser()
* isForgeUser} method instead.
* </p>
* <p>
@@ -204,7 +205,7 @@ public interface ProxiedPlayer extends Connection, CommandSender
* place to do so as this event occurs after a FML handshake has completed,
* if any has occurred.
* </p>
*
*
* @return A {@link Map} of mods, where the key is the name of the mod, and
* the value is the version. Returns an empty list if the FML handshake has
* not occurred for this {@link ProxiedPlayer} yet.