SPIGOT-1036: Add API to manipulate sendTitle timings.

By: md_5 <git@md-5.net>
This commit is contained in:
Bukkit/Spigot 2016-12-16 09:48:08 +11:00
parent 70550c8dce
commit 3a7985cb33

View file

@ -1121,22 +1121,37 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
* values are null, they will not be sent and the display will remain
* unchanged. If they are empty strings, the display will be updated as
* such. If the strings contain a new line, only the first line will be
* sent.
* sent. The titles will be displayed with the client's default timings.
*
* @param title Title text
* @param subtitle Subtitle text
* @deprecated API subject to change
* @deprecated API behavior subject to change
*/
@Deprecated
public void sendTitle(String title, String subtitle);
/**
* Resets the title displayed to the player.
* @deprecated API subject to change.
* Sends a title and a subtitle message to the player. If either of these
* values are null, they will not be sent and the display will remain
* unchanged. If they are empty strings, the display will be updated as
* such. If the strings contain a new line, only the first line will be
* sent. All timings values may take a value of -1 to indicate that they
* will use the last value sent (or the defaults if no title has been
* displayed).
*
* @param title Title text
* @param subtitle Subtitle text
* @param fadeIn time in ticks for titles to fade in. Defaults to 10.
* @param stay time in ticks for titles to stay. Defaults to 70.
* @param fadeOut time in ticks for titles to fade out. Defaults to 20.
*/
@Deprecated
public void resetTitle();
public void sendTitle(String title, String subtitle, int fadeIn, int stay, int fadeOut);
/**
* Resets the title displayed to the player. This will clear the displayed
* title / subtitle and reset timings to their default values.
*/
public void resetTitle();
/**
* Spawns the particle (the number of times specified by count)