org.mcsg.double0negative.tabapi

Class TabAPI

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

org.mcsg.double0negative.tabapi.TabAPI

All Implemented Interfaces:

org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.event.Listener, org.bukkit.plugin.Plugin

public class TabAPI
extends org.bukkit.plugin.java.JavaPlugin
implements org.bukkit.event.Listener

TabAPI Provides a simple interface for adding custom text to displace on the minecraft tab menu on a player/plugin basis

Author:

Double0negative

Constructor Summary

Constructors

Constructor and Description
TabAPI()

Method Summary

Methods

Modifier and Type	Method and Description
static void	clearTab(org.bukkit.entity.Player p) Clear a players tab menu
static void	disableTabForPlayer(org.bukkit.entity.Player p) Returns the tab list to the vanilla tab list for a player.
void	onDisable()
void	onEnable()
void	PlayerJoin(org.bukkit.event.player.PlayerJoinEvent e)
void	PlayerLeave(org.bukkit.event.player.PlayerQuitEvent e)
static void	resetTabList(org.bukkit.entity.Player p) Resets tab to normal tab.
static void	setPriority(org.bukkit.plugin.Plugin plugin, org.bukkit.entity.Player player, int pri) Priorities -2 = no longer active, remove -1 = background, only show if nothing else is there 0 = normal 1 = high priority 2 = always show, only use if MUST show
static void	setTabString(org.bukkit.plugin.Plugin plugin, org.bukkit.entity.Player p, int x, int y, java.lang.String msg) Set the tab for a player.
static void	updateAll()
static void	updatePlayer(org.bukkit.entity.Player p) Updates a players tab A tab will be updated with the tab from the highest priority plugin

Methods inherited from class org.bukkit.plugin.java.JavaPlugin

getCommand, getConfig, getDatabase, getDatabaseClasses, getDataFolder, getDefaultWorldGenerator, getDescription, getLogger, getPluginLoader, getResource, getServer, isEnabled, isInitialized, isNaggable, onCommand, onLoad, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setNaggable, toString

Methods inherited from class org.bukkit.plugin.PluginBase

equals, getName, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TabAPI

public TabAPI()

Method Detail

onEnable

public void onEnable()

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

Overrides:

onEnable in class org.bukkit.plugin.java.JavaPlugin

onDisable

public void onDisable()

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

Overrides:

onDisable in class org.bukkit.plugin.java.JavaPlugin

setPriority

public static void setPriority(org.bukkit.plugin.Plugin plugin,
               org.bukkit.entity.Player player,
               int pri)

Priorities -2 = no longer active, remove -1 = background, only show if nothing else is there 0 = normal 1 = high priority 2 = always show, only use if MUST show

disableTabForPlayer

public static void disableTabForPlayer(org.bukkit.entity.Player p)

Returns the tab list to the vanilla tab list for a player. If another plugin holds higher priority, this does notning

Parameters:

p -

resetTabList

public static void resetTabList(org.bukkit.entity.Player p)

Resets tab to normal tab.

Parameters:

p -

setTabString

public static void setTabString(org.bukkit.plugin.Plugin plugin,
                org.bukkit.entity.Player p,
                int x,
                int y,
                java.lang.String msg)

Set the tab for a player. If the plugin the tab is being set from does not have a priority, It will automatically be give a base priority of 0

Parameters:

plugin -

p -

x -

y -

msg -

updatePlayer

public static void updatePlayer(org.bukkit.entity.Player p)

Updates a players tab A tab will be updated with the tab from the highest priority plugin

Parameters:

p -

clearTab

public static void clearTab(org.bukkit.entity.Player p)

Clear a players tab menu

Parameters:

p -

updateAll

public static void updateAll()

PlayerJoin

public void PlayerJoin(org.bukkit.event.player.PlayerJoinEvent e)

PlayerLeave

public void PlayerLeave(org.bukkit.event.player.PlayerQuitEvent e)