Package com.andrei1058.spigot.signapi

Class SpigotSignAPI

java.lang.Object

com.andrei1058.spigot.signapi.SpigotSignAPI

public class SpigotSignAPI
extends Object

Constructor Summary

Constructors

Constructor	Description
SpigotSignAPI(org.bukkit.plugin.Plugin client)	Initialize the signs lib.

Method Summary

Modifier and Type	Method	Description
boolean	addSign(PacketSign sign)	Add a sign to the list.
PacketSign	createSign(org.bukkit.block.Block block)	Create a sign at the target block.
int	getDelay()	Get packets delay.
List<PacketSign>	getSigns()	Unmodifiable signs list.
boolean	removeSign(PacketSign sign)	Remove a sign from the list.
void	setDelay(int delay)	Change packets delay.

Methods inherited from class java.lang.Object

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

Constructor Details

SpigotSignAPI

public SpigotSignAPI(org.bukkit.plugin.Plugin client)

Initialize the signs lib. This will register a listener on your plugin so it will handle PacketSign.SignClickEvent.

Method Details

createSign

public PacketSign createSign(org.bukkit.block.Block block)

Create a sign at the target block. The block must be already a sign-block.

Returns:

new PacketSign instance.

getSigns

public List<PacketSign> getSigns()

Unmodifiable signs list.

Returns:

unmodifiable signs list.

addSign

public boolean addSign(PacketSign sign)

Add a sign to the list.

Parameters:

sign - - sign to be added.

Returns:

true (as specified by Collection.add(Object))

removeSign

public boolean removeSign(PacketSign sign)

Remove a sign from the list.

Parameters:

sign - - sign to be removed.

Returns:

true (as specified by Collection.remove(Object))

getDelay

public int getDelay()

Get packets delay. This is usually used to send packets when a player joins or teleports.

Returns:

packets delay.

setDelay

public void setDelay(int delay)

Change packets delay. This is usually used to send packets when a player joins or teleports.