jojoe77777 119913da30 Modified misleading comment (#1455)
The plugin isn't supposed to extend PluginTask, the task is
2017-10-09 07:52:40 +01:00

78 lines
1.6 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\scheduler;
/**
* WARNING! Tasks created by plugins MUST extend PluginTask
*/
abstract class Task{
/** @var TaskHandler */
private $taskHandler = null;
/**
* @return TaskHandler|null
*/
final public function getHandler(){
return $this->taskHandler;
}
/**
* @return int
*/
final public function getTaskId() : int{
if($this->taskHandler !== null){
return $this->taskHandler->getTaskId();
}
return -1;
}
/**
* @param TaskHandler|null $taskHandler
*/
final public function setHandler(TaskHandler $taskHandler = null){
if($this->taskHandler === null or $taskHandler === null){
$this->taskHandler = $taskHandler;
}
}
/**
* Actions to execute when run
*
* @param int $currentTick
*
* @return void
*/
abstract public function onRun(int $currentTick);
/**
* Actions to execute if the Task is cancelled
*/
public function onCancel(){
}
}