Package org.bukkit.event.block
Class SignChangeEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.block.BlockEvent
org.bukkit.event.block.SignChangeEvent
- All Implemented Interfaces:
Cancellable
Called when a sign is changed by a player.
If a Sign Change event is cancelled, the sign will not be changed.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.block.BlockEvent
block
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic @NotNull HandlerList
getLine
(int index) Deprecated.getLines()
Deprecated.in favour oflines()
Gets the player changing the sign involved in this event.getSide()
Returns which side is changed.boolean
Gets the cancellation state of this event.line
(int index) Gets a single line of text from the sign involved in this event.void
Sets a single line for the sign involved in this eventlines()
Gets all of the lines of text from the sign involved in this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.void
Deprecated.in favour ofline(int, net.kyori.adventure.text.Component)
Methods inherited from class org.bukkit.event.block.BlockEvent
getBlock
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
SignChangeEvent
-
SignChangeEvent
@Deprecated public SignChangeEvent(@NotNull @NotNull Block theBlock, @NotNull @NotNull Player player, @NotNull List<Component> adventure$lines) Deprecated. -
SignChangeEvent
@Deprecated public SignChangeEvent(@NotNull @NotNull Block theBlock, @NotNull @NotNull Player thePlayer, @NotNull @NotNull String[] theLines) Deprecated. -
SignChangeEvent
@Deprecated public SignChangeEvent(@NotNull @NotNull Block theBlock, @NotNull @NotNull Player thePlayer, @NotNull @NotNull String[] theLines, @NotNull @NotNull Side side) Deprecated.
-
-
Method Details
-
getPlayer
Gets the player changing the sign involved in this event.- Returns:
- the Player involved in this event
-
lines
Gets all of the lines of text from the sign involved in this event.- Returns:
- the String array for the sign's lines new text
-
line
Gets a single line of text from the sign involved in this event.- 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
-
line
Sets a single line for the sign involved in this event- Parameters:
index
- index of the line to setline
- text to set- Throws:
IndexOutOfBoundsException
- thrown when the provided index is > 3 or < 0
-
getLines
Deprecated.in favour oflines()
Gets all of the lines of text from the sign involved in this event.- Returns:
- the String array for the sign's lines new text
-
getLine
Deprecated.in favour ofline(int)
Gets a single line of text from the sign involved in this event.- 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
@Deprecated public void setLine(int index, @Nullable @Nullable String line) throws IndexOutOfBoundsException Deprecated.in favour ofline(int, net.kyori.adventure.text.Component)
Sets a single line for the sign involved in this event- Parameters:
index
- index of the line to setline
- text to set- Throws:
IndexOutOfBoundsException
- thrown when the provided index is > 3 or < 0
-
getSide
Returns which side is changed.- Returns:
- the affected side of the sign
-
isCancelled
public boolean isCancelled()Description copied from interface:Cancellable
Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins- Specified by:
isCancelled
in interfaceCancellable
- Returns:
- true if this event is cancelled
-
setCancelled
public void setCancelled(boolean cancel) Description copied from interface:Cancellable
Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.- Specified by:
setCancelled
in interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-
line(int)