Files
PocketMine-MP/src/pocketmine/event/block/SignChangeEvent.php
Tim (robske_110) 42fb1d1fef Improve usability of Sign API (#1202)
* Improve usability of Sign API

* PHP

* Throw exceptions if out of range

* Fix phpdocs

* Formatting, additional checks in the SignChangeEvent.

* Blame php storm

* require line count to always be 4

* Adjust exception message
2017-07-19 15:22:04 +01:00

98 lines
2.2 KiB
PHP

<?php
/*
*
* ____ _ _ __ __ _ __ __ ____
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* @author PocketMine Team
* @link http://www.pocketmine.net/
*
*
*/
declare(strict_types=1);
namespace pocketmine\event\block;
use pocketmine\block\Block;
use pocketmine\event\Cancellable;
use pocketmine\Player;
/**
* Called when a sign is changed by a player.
*/
class SignChangeEvent extends BlockEvent implements Cancellable{
public static $handlerList = null;
/** @var Player */
private $player;
/** @var string[] */
private $lines = [];
/**
* @param Block $theBlock
* @param Player $thePlayer
* @param string[] $theLines
*/
public function __construct(Block $theBlock, Player $thePlayer, array $theLines){
parent::__construct($theBlock);
$this->player = $thePlayer;
$this->lines = $theLines;
}
/**
* @return Player
*/
public function getPlayer(){
return $this->player;
}
/**
* @return string[]
*/
public function getLines(){
return $this->lines;
}
/**
* @param int $index 0-3
*
* @return string
*/
public function getLine($index){
if($index < 0 or $index > 3){
throw new \InvalidArgumentException("Index must be in the range 0-3!");
}
return $this->lines[$index];
}
/**
* @param string[] $lines
*/
public function setLines(array $lines){
if(count($lines) !== 4){
throw new \InvalidArgumentException("Array size must be 4!");
}
$this->lines = $lines;
}
/**
* @param int $index 0-3
* @param string $line
*/
public function setLine($index, $line){
if($index < 0 or $index > 3){
throw new \InvalidArgumentException("Index must be in the range 0-3!");
}
$this->lines[$index] = $line;
}
}