gyurix.api

Class TitleAPI

java.lang.Object

gyurix.api.TitleAPI

public class TitleAPI
extends java.lang.Object

TitleAPI - API for managing title, subtitle and actionbar messages for server versions 1.8.8 and later

Constructor Summary

Constructors

Constructor and Description
TitleAPI()

Method Summary

Modifier and Type	Method and Description
static void	clear(java.util.Collection<? extends org.bukkit.entity.Player> players) Clears the title message of the given collection of players
static void	clear(org.bukkit.entity.Player... players) Clears the title message of the given players
static void	reset(java.util.Collection<? extends org.bukkit.entity.Player> players) Resets the title message of the given collection of players
static void	reset(org.bukkit.entity.Player... players) Resets the title message of the given players
static void	set(java.lang.String title, java.lang.String subtitle, int fadeIn, int showtime, int fadeOut, java.util.Collection<? extends org.bukkit.entity.Player> players) Sends a title message to the given collection of players
static void	set(java.lang.String title, java.lang.String subtitle, int fadeIn, int showtime, int fadeOut, org.bukkit.entity.Player... players) Sends a title message to the given players
static void	setShowTime(int fadein, int show, int fadeout, java.util.Collection<? extends org.bukkit.entity.Player> players) Sets the title timings of the given collection of players
static void	setShowTime(int fadein, int show, int fadeout, org.bukkit.entity.Player... players) Sets the title timings of the given players
static void	setSubTitle(java.lang.String subtitle, java.util.Collection<? extends org.bukkit.entity.Player> players) Sets the subtitle of the given collection of players.
static void	setSubTitle(java.lang.String subtitle, org.bukkit.entity.Player... players) Sets the subtitle of the given players.
static void	setTitle(java.lang.String title, java.util.Collection<? extends org.bukkit.entity.Player> players) Sets the title of the given collection of players and shows the title message.
static void	setTitle(java.lang.String title, org.bukkit.entity.Player... players) Sets the title of the given players and shows the title message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TitleAPI

public TitleAPI()

Method Detail

clear

public static void clear(java.util.Collection<? extends org.bukkit.entity.Player> players)

Clears the title message of the given collection of players

Parameters:

players - - The collection of players whose title bar should be cleared

clear

public static void clear(org.bukkit.entity.Player... players)

Clears the title message of the given players

Parameters:

players - - The players whose title bar should be cleared

reset

public static void reset(java.util.Collection<? extends org.bukkit.entity.Player> players)

Resets the title message of the given collection of players

Parameters:

players - - The players whose title bar should be reset

reset

public static void reset(org.bukkit.entity.Player... players)

Resets the title message of the given players

Parameters:

players - - The players whose title bar should be reset

set

public static void set(java.lang.String title,
                       java.lang.String subtitle,
                       int fadeIn,
                       int showtime,
                       int fadeOut,
                       java.util.Collection<? extends org.bukkit.entity.Player> players)

Sends a title message to the given collection of players

Parameters:

title - - Title text of the title message

subtitle - - Subtitle text of the title message

fadeIn - - Fade in time in ticks (1 tick = 0.05 sec)

showtime - - Show time in ticks

fadeOut - - Fade out time in ticks

players - - Receivers of the title message

set

public static void set(java.lang.String title,
                       java.lang.String subtitle,
                       int fadeIn,
                       int showtime,
                       int fadeOut,
                       org.bukkit.entity.Player... players)

Sends a title message to the given players

Parameters:

title - - Title text of the title message

subtitle - - Subtitle text of the title message

fadeIn - - Fade in time in ticks (1 tick = 0.05 sec)

showtime - - Show time in ticks

fadeOut - - Fade out time in ticks

players - - Receivers of the title message

setShowTime

public static void setShowTime(int fadein,
                               int show,
                               int fadeout,
                               java.util.Collection<? extends org.bukkit.entity.Player> players)

Sets the title timings of the given collection of players

Parameters:

fadein - - Fade in time in ticks (1 tick = 0.05 sec)

show - - Show time in ticks

fadeout - - Fade out time in ticks

players - - Players whose title timings should be changed

setShowTime

public static void setShowTime(int fadein,
                               int show,
                               int fadeout,
                               org.bukkit.entity.Player... players)

Sets the title timings of the given players

Parameters:

fadein - - Fade in time in ticks (1 tick = 0.05 sec)

show - - Show time in ticks

fadeout - - Fade out time in ticks

players - - Players whose title timings should be changed

setSubTitle

public static void setSubTitle(java.lang.String subtitle,
                               java.util.Collection<? extends org.bukkit.entity.Player> players)

Sets the subtitle of the given collection of players. Subtitle will only become visible when the title is shown using the set title method. If you only want to show a subtitle without any title, you should call the setTitle method with empty String passed as title argument

Parameters:

subtitle - - The new subtitle of the title message

players - - Players whose subtitle should be changed

setSubTitle

public static void setSubTitle(java.lang.String subtitle,
                               org.bukkit.entity.Player... players)

Sets the subtitle of the given players. Subtitle will only become visible when the title is shown using the set title method. If you only want to show a subtitle without any title, you should call the setTitle method with empty String passed as title argument

Parameters:

subtitle - - The new subtitle of the title message

players - - Players whose subtitle should be changed

setTitle

public static void setTitle(java.lang.String title,
                            java.util.Collection<? extends org.bukkit.entity.Player> players)

Sets the title of the given collection of players and shows the title message. Make sure to set the subtitle and the title timings before using this method.

Parameters:

title - - The showable title message

players - - Receivers of the title message

setTitle

public static void setTitle(java.lang.String title,
                            org.bukkit.entity.Player... players)

Sets the title of the given players and shows the title message. Make sure to set the subtitle and the title timings before using this method.

Parameters:

title - - The showable title message

players - - Receivers of the title message