Package de.eimmer.ereignis.block

Class SchildAenderungEreignis

java.lang.Object

de.eimmer.ereignis.Ereignis

de.eimmer.ereignis.block.BlockEreignis

de.eimmer.ereignis.block.SchildAenderungEreignis

All Implemented Interfaces:

Abbrechbar

public class SchildAenderungEreignis
extends BlockEreignis
implements Abbrechbar

Called when a sign is changed by a spieler.

If a Sign Change ereignis is cancelled, the sign will not be changed.

Nested Class Summary

Nested classes/interfaces inherited from class de.eimmer.ereignis.Ereignis

Ereignis.Result

Field Summary

Fields inherited from class de.eimmer.ereignis.block.BlockEreignis

block

Constructor Summary

Constructors

Constructor	Description
SchildAenderungEreignis(Block theBlock, Spieler theSpieler, String[] theLines)	Deprecated.
SchildAenderungEreignis(Block theBlock, Spieler theSpieler, String[] theLines, Side side)

Method Summary

Modifier and Type	Method	Description
static HandhaberListe	getHandlerList()
HandhaberListe	getHandlers()
String	getLine(int index)	Gets a single line of text from the sign involved in this ereignis.
String[]	getLines()	Gets all of the lines of text from the sign involved in this ereignis.
Spieler	getPlayer()	Gets the spieler changing the sign involved in this ereignis.
Side	getSide()	Returns which side is changed.
boolean	isCancelled()	Gets the cancellation state of this ereignis.
void	setCancelled(boolean cancel)	Sets the cancellation state of this ereignis.
void	setLine(int index, String line)	Sets a single line for the sign involved in this ereignis

Methods inherited from class de.eimmer.ereignis.block.BlockEreignis

getBlock

Methods inherited from class de.eimmer.ereignis.Ereignis

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

SchildAenderungEreignis

@Deprecated
public SchildAenderungEreignis(@NotNull
 Block theBlock,
 @NotNull
 Spieler theSpieler,
 @NotNull
 String[] theLines)

Deprecated.

SchildAenderungEreignis

public SchildAenderungEreignis(@NotNull
 Block theBlock,
 @NotNull
 Spieler theSpieler,
 @NotNull
 String[] theLines,
 @NotNull
 Side side)

Method Details

getPlayer

@NotNull
public Spieler getPlayer()

Gets the spieler changing the sign involved in this ereignis.

Returns:

the Spieler involved in this ereignis

getLines

@NotNull
public String[] getLines()

Gets all of the lines of text from the sign involved in this ereignis.

Returns:

the String array for the sign's lines new text

getLine

@Nullable
public String getLine(int index)
               throws IndexOutOfBoundsException

Gets a single line of text from the sign involved in this ereignis.

Parameters:

index - index of the line to get

Returns:

the String containing the line of text associated with the provided index

Throws:

IndexOutOfBoundsException - thrown when the provided index is > 3 or < 0

setLine

public void setLine(int index,
 @Nullable
 String line)
             throws IndexOutOfBoundsException

Sets a single line for the sign involved in this ereignis

Parameters:

index - index of the line to set

line - text to set

Throws:

IndexOutOfBoundsException - thrown when the provided index is > 3 or < 0

getSide

@NotNull
public Side getSide()

Returns which side is changed.

Returns:

the affected side of the sign

isCancelled

public boolean isCancelled()

Description copied from interface: Abbrechbar

Gets the cancellation state of this ereignis. A cancelled ereignis will not be executed in the server, but will still pass to other plugins

Specified by:

isCancelled in interface Abbrechbar

Returns:

true if this ereignis is cancelled

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Abbrechbar

Sets the cancellation state of this ereignis. A cancelled ereignis will not be executed in the server, but will still pass to other plugins.

Specified by:

setCancelled in interface Abbrechbar

Parameters:

cancel - true if you wish to cancel this ereignis

getHandlers

@NotNull
public HandhaberListe getHandlers()

Specified by:

getHandlers in class Ereignis

getHandlerList

@NotNull
public static HandhaberListe getHandlerList()