PlayerEditBookEvent
extends PlayerEvent
in package
implements
Cancellable
Uses
CancellableTrait
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
- ACTION_ADD_PAGE = 1
- ACTION_DELETE_PAGE = 2
- ACTION_REPLACE_PAGE = 0
- ACTION_SIGN_BOOK = 4
- ACTION_SWAP_PAGES = 3
- MAX_EVENT_CALL_DEPTH = 50
- $eventName : string|null
- $player : Player
- $action : int
- $eventCallDepth : int
- $isCancelled : bool
- $modifiedPages : array<string|int, int>
- $newBook : WritableBookBase
- $oldBook : WritableBookBase
- __construct() : mixed
- call() : void
- Calls event handlers registered for this event.
- cancel() : void
- getAction() : int
- Returns the action of the event.
- getEventName() : string
- getModifiedPages() : array<string|int, int>
- Returns an array containing the page IDs of modified pages.
- getNewBook() : WritableBookBase
- Returns the book after it was modified.
- getOldBook() : WritableBookBase
- Returns the book before it was modified.
- getPlayer() : Player
- isCancelled() : bool
- setNewBook() : void
- Sets the new book as the given instance.
- uncancel() : void
Constants
ACTION_ADD_PAGE
public
mixed
ACTION_ADD_PAGE
= 1
ACTION_DELETE_PAGE
public
mixed
ACTION_DELETE_PAGE
= 2
ACTION_REPLACE_PAGE
public
mixed
ACTION_REPLACE_PAGE
= 0
ACTION_SIGN_BOOK
public
mixed
ACTION_SIGN_BOOK
= 4
ACTION_SWAP_PAGES
public
mixed
ACTION_SWAP_PAGES
= 3
MAX_EVENT_CALL_DEPTH
private
mixed
MAX_EVENT_CALL_DEPTH
= 50
Properties
$eventName
protected
string|null
$eventName
= null
$player
protected
Player
$player
$action
private
int
$action
$eventCallDepth
private
static int
$eventCallDepth
= 1
$isCancelled
private
bool
$isCancelled
= false
$modifiedPages
private
array<string|int, int>
$modifiedPages
$newBook
private
WritableBookBase
$newBook
$oldBook
private
WritableBookBase
$oldBook
Methods
__construct()
public
__construct(Player $player, WritableBookBase $oldBook, WritableBookBase $newBook, int $action, array<string|int, int> $modifiedPages) : mixed
Parameters
- $player : Player
- $oldBook : WritableBookBase
- $newBook : WritableBookBase
- $action : int
- $modifiedPages : array<string|int, int>
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 —getAction()
Returns the action of the event.
public
getAction() : int
Return values
int —getEventName()
public
final getEventName() : string
Return values
string —getModifiedPages()
Returns an array containing the page IDs of modified pages.
public
getModifiedPages() : array<string|int, int>
Return values
array<string|int, int> —getNewBook()
Returns the book after it was modified.
public
getNewBook() : WritableBookBase
The new book may be a written book, if the book was signed.
Return values
WritableBookBase —getOldBook()
Returns the book before it was modified.
public
getOldBook() : WritableBookBase
Return values
WritableBookBase —getPlayer()
public
getPlayer() : Player
Return values
Player —isCancelled()
public
isCancelled() : bool
Return values
bool —setNewBook()
Sets the new book as the given instance.
public
setNewBook(WritableBookBase $book) : void
Parameters
- $book : WritableBookBase
Return values
void —uncancel()
public
uncancel() : void