mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-04-19 23:44:17 +00:00
Code Issues Projects Releases Wiki Activity

Task: Remove currentTick parameter (#3498)

Browse Source 
This parameter is not used for the vast majority of task use cases and just serves as extra useless boilerplate code, especially for closure-based tasks.
This use case can be replaced using Server->getTick() in the cases where it matters.
This commit is contained in:
Dylan T 2020-05-16 15:28:45 +01:00 committed by GitHub
parent 38e28f91e8
commit 67666db827
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/scheduler/CancellableClosureTask.php
View File

@ -32,8 +32,8 @@ use pocketmine\utils\Utils;
* Example usage:
*
* ```
* TaskScheduler->scheduleTask(new CancellableClosureTask(function(int $currentTick) : bool{
* echo "HI on $currentTick\n";
* TaskScheduler->scheduleTask(new CancellableClosureTask(function() : bool{
* echo "HI\n";
* $continue = false;
* return $continue; //stop repeating
* });
@ -47,20 +47,20 @@ class CancellableClosureTask extends Task{
/**
* @var \Closure
* @phpstan-var \Closure(int $currentTick) : bool
* @phpstan-var \Closure() : bool
*/
private $closure;
/**
* CancellableClosureTask constructor.
*
* The closure should follow the signature callback(int $currentTick) : bool. The return value will be used to
* The closure should follow the signature callback() : bool. The return value will be used to
* decide whether to continue repeating.
*
* @phpstan-param \Closure(int $currentTick) : bool $closure
* @phpstan-param \Closure() : bool $closure
*/
public function __construct(\Closure $closure){
Utils::validateCallableSignature(function(int $currentTick) : bool{ return false; }, $closure);
Utils::validateCallableSignature(function() : bool{ return false; }, $closure);
$this->closure = $closure;
}
@ -68,8 +68,8 @@ class CancellableClosureTask extends Task{
return Utils::getNiceClosureName($this->closure);
}
public function onRun(int $currentTick) : void{
if(!($this->closure)($currentTick)){
public function onRun() : void{
if(!($this->closure)()){
$this->getHandler()->cancel();
}
}

16
src/scheduler/ClosureTask.php
View File

@ -31,8 +31,8 @@ use pocketmine\utils\Utils;
* Example usage:
*
* ```
* TaskScheduler->scheduleTask(new ClosureTask(function(int $currentTick) : void{
* echo "HI on $currentTick\n";
* TaskScheduler->scheduleTask(new ClosureTask(function() : void{
* echo "HI\n";
* });
* ```
*/
@ -40,16 +40,16 @@ class ClosureTask extends Task{
/**
* @var \Closure
* @phpstan-var \Closure(int) : void
* @phpstan-var \Closure() : void
*/
private $closure;
/**
* @param \Closure $closure Must accept only ONE parameter, $currentTick
* @phpstan-param \Closure(int) : void $closure
* @param \Closure $closure Must accept zero parameters
* @phpstan-param \Closure() : void $closure
*/
public function __construct(\Closure $closure){
Utils::validateCallableSignature(function(int $currentTick) : void{}, $closure);
Utils::validateCallableSignature(function() : void{}, $closure);
$this->closure = $closure;
}
@ -57,7 +57,7 @@ class ClosureTask extends Task{
return Utils::getNiceClosureName($this->closure);
}
public function onRun(int $currentTick) : void{
($this->closure)($currentTick);
public function onRun() : void{
($this->closure)();
}
}

2
src/scheduler/Task.php
View File

@ -60,7 +60,7 @@ abstract class Task{
*
* @return void
*/
abstract public function onRun(int $currentTick);
abstract public function onRun();
/**
* Actions to execute if the Task is cancelled

4
src/scheduler/TaskHandler.php
View File

@ -116,10 +116,10 @@ class TaskHandler{
$this->task->setHandler(null);
}
public function run(int $currentTick) : void{
public function run() : void{
$this->timings->startTiming();
try{
$this->task->onRun($currentTick);
$this->task->onRun();
}finally{
$this->timings->stopTiming();
}

2
src/scheduler/TaskScheduler.php
View File

@ -147,7 +147,7 @@ class TaskScheduler{
unset($this->tasks[$task->getTaskId()]);
continue;
}
$task->run($this->currentTick);
$task->run();
if($task->isRepeating()){
$task->setNextRun($this->currentTick + $task->getPeriod());
$this->queue->insert($task, $this->currentTick + $task->getPeriod());

2
tests/plugins/TesterPlugin/src/pmmp/TesterPlugin/CheckTestCompletionTask.php
View File

@ -34,7 +34,7 @@ class CheckTestCompletionTask extends Task{
$this->plugin = $plugin;
}
public function onRun(int $currentTick){
public function onRun(){
$test = $this->plugin->getCurrentTest();
if($test === null){
if(!$this->plugin->startNextTest()){