gyurix.scoreboard

Class ScoreboardBar

java.lang.Object

gyurix.scoreboard.ScoreboardBar

Direct Known Subclasses:

NametagBar, Sidebar, Tabbar

public abstract class ScoreboardBar
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
java.util.HashMap<java.lang.String,BarData>	active
BarData	currentData
java.lang.Object	hidePacket
java.util.HashMap<java.lang.String,BarData>	loaded
java.lang.Object	showPacket
java.lang.String	teamNamePrefix

Constructor Summary

Constructors

Constructor and Description
ScoreboardBar(java.lang.String barname, java.lang.String teamNamePrefix, int displaySlot) Construct new ScoreboardBar

Method Summary

Modifier and Type	Method and Description
boolean	activate(org.bukkit.entity.Player plr) Reactivates this ScoreboardBar for the given player, if it is loaded, but deactivated currently
boolean	deActivate(org.bukkit.entity.Player plr) Deactivates this ScoreboardBar for the given player, but keeps it loaded and ready to fast switch back
boolean	drop(org.bukkit.entity.Player plr) Removes the data stored about the given players loaded state (useful for handling player quits)
ScoreboardDisplayMode	getDisplayMode() Get the display mode of the Scoreboard
java.lang.String	getTitle() Gets the title of this scoreboard bar
boolean	isActive(org.bukkit.entity.Player plr) Checks if this ScoreboardBar is active for the given player or not
boolean	isLoaded(org.bukkit.entity.Player plr) Checks if this ScoreboardBar is already loaded for the given player or not
boolean	isVisible() Check if this scoreboard bar is visible or not
boolean	load(org.bukkit.entity.Player plr) Attempts to load this ScoreboardBar for the given player
void	setDisplayMode(ScoreboardDisplayMode mode) Sets the display mode of this Scoreboard, it has no effect on sidebar.
void	setTitle(java.lang.String newtitle) Sets the title of this scoreboard bar.
void	setVisible(boolean visible) Toggles the visibility of this scoreboard bar
boolean	unload(org.bukkit.entity.Player plr) Attempts to unload this ScoreboardBar for the given player
void	update()

Methods inherited from class java.lang.Object

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

Field Detail

active

public final java.util.HashMap<java.lang.String,BarData> active

currentData

public final BarData currentData

loaded

public final java.util.HashMap<java.lang.String,BarData> loaded

showPacket

public final java.lang.Object showPacket

hidePacket

public final java.lang.Object hidePacket

teamNamePrefix

public final java.lang.String teamNamePrefix

Constructor Detail

ScoreboardBar

public ScoreboardBar(java.lang.String barname,
                     java.lang.String teamNamePrefix,
                     int displaySlot)

Construct new ScoreboardBar

Parameters:

barname - - The name of this ScoreboardBar

teamNamePrefix - - The prefix of the Scoreboard team packets

displaySlot - - The slot of this ScoreboardBar (0: list, 1: sidebar, 2: below name)

Method Detail

activate

public boolean activate(org.bukkit.entity.Player plr)

Reactivates this ScoreboardBar for the given player, if it is loaded, but deactivated currently

Parameters:

plr - - Target Player

Returns:

True if this ScoreboardBar was not active for the given player before

deActivate

public boolean deActivate(org.bukkit.entity.Player plr)

Deactivates this ScoreboardBar for the given player, but keeps it loaded and ready to fast switch back

Parameters:

plr - - Target Player

Returns:

True if this ScoreboardBar was active for the given player before

drop

public boolean drop(org.bukkit.entity.Player plr)

Removes the data stored about the given players loaded state (useful for handling player quits)

Parameters:

plr - - Target player

Returns:

True if this ScoreboardBar was loaded for the player before

getDisplayMode

public ScoreboardDisplayMode getDisplayMode()

Get the display mode of the Scoreboard

Returns:

The scoreboards display mode

setDisplayMode

public void setDisplayMode(ScoreboardDisplayMode mode)

Sets the display mode of this Scoreboard, it has no effect on sidebar.

Parameters:

mode - - The new displaymode

getTitle

public java.lang.String getTitle()

Gets the title of this scoreboard bar

Returns:

- The title of this scoreboard bar

setTitle

public void setTitle(java.lang.String newtitle)

Sets the title of this scoreboard bar.

Parameters:

newtitle - - The new title

isActive

public boolean isActive(org.bukkit.entity.Player plr)

Checks if this ScoreboardBar is active for the given player or not

Parameters:

plr - - Target Player

Returns:

True if this ScoreboardBar is active for the given player

isLoaded

public boolean isLoaded(org.bukkit.entity.Player plr)

Checks if this ScoreboardBar is already loaded for the given player or not

Parameters:

plr - - Target Player

Returns:

True if this ScoreboardBar is already loaded for the given player

isVisible

public boolean isVisible()

Check if this scoreboard bar is visible or not

Returns:

The scoreboard bars visibility

setVisible

public void setVisible(boolean visible)

Toggles the visibility of this scoreboard bar

Parameters:

visible - - The new visibility state

load

public boolean load(org.bukkit.entity.Player plr)

Attempts to load this ScoreboardBar for the given player

Parameters:

plr - - Target Player

Returns:

True if this ScoreboardBar hasn't been loaded for the player before

unload

public boolean unload(org.bukkit.entity.Player plr)

Attempts to unload this ScoreboardBar for the given player

Parameters:

plr - - Target Player

Returns:

True if this ScoreboardBar has been loaded for the player before

update

public void update()