SignChangeEvent
extends BlockEvent
in package
implements
Cancellable
Uses
CancellableTrait
Called when a sign's text is changed by a player.
Interfaces, Classes, Traits and Enums
- Cancellable
- This interface is implemented by an Event subclass if and only if it can be cancelled.
Table of Contents
- MAX_EVENT_CALL_DEPTH = 50
- $block : Block
- $eventName : string|null
- $eventCallDepth : int
- $isCancelled : bool
- $player : Player
- $sign : BaseSign
- $text : SignText
- __construct() : mixed
- call() : void
- Calls event handlers registered for this event.
- cancel() : void
- getBlock() : Block
- getEventName() : string
- getNewText() : SignText
- Returns the text which will be on the sign after the event.
- getOldText() : SignText
- Returns the text currently on the sign.
- getPlayer() : Player
- getSign() : BaseSign
- isCancelled() : bool
- setNewText() : void
- Sets the text to be written on the sign after the event.
- uncancel() : void
Constants
MAX_EVENT_CALL_DEPTH
private
mixed
MAX_EVENT_CALL_DEPTH
= 50
Properties
$block
protected
Block
$block
$eventName
protected
string|null
$eventName
= null
$eventCallDepth
private
static int
$eventCallDepth
= 1
$isCancelled
private
bool
$isCancelled
= false
$player
private
Player
$player
$sign
private
BaseSign
$sign
$text
private
SignText
$text
Methods
__construct()
public
__construct(BaseSign $sign, Player $player, SignText $text) : mixed
Parameters
Return values
mixed —call()
Calls event handlers registered for this event.
public
call() : void
Tags
Return values
void —cancel()
public
cancel() : void
Return values
void —getBlock()
public
getBlock() : Block
Return values
Block —getEventName()
public
final getEventName() : string
Return values
string —getNewText()
Returns the text which will be on the sign after the event.
public
getNewText() : SignText
Return values
SignText —getOldText()
Returns the text currently on the sign.
public
getOldText() : SignText
Return values
SignText —getPlayer()
public
getPlayer() : Player
Return values
Player —getSign()
public
getSign() : BaseSign
Return values
BaseSign —isCancelled()
public
isCancelled() : bool
Return values
bool —setNewText()
Sets the text to be written on the sign after the event.
public
setNewText(SignText $text) : void
Parameters
- $text : SignText
Return values
void —uncancel()
public
uncancel() : void