mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-06-30 23:29:54 +00:00
Code Issues Projects Releases Wiki Activity

Added internal use warning for TaskHandler::cancel()

Browse Source 
It is confusing for some developers to whether to use this function or `ServerScheduler::cancelTask($taskId)`. It is better to add warning in the documentation.
This commit is contained in:
PEMapModder 2014-12-01 16:25:37 +08:00
parent 1963d8fde0
commit 941961f5ef
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/pocketmine/scheduler/TaskHandler.php
View File

@ -127,6 +127,10 @@ class TaskHandler{
return $this->period; return $this->period;
} }
/**
* WARNING: Do not use this, it's only for internal use.
* Changes to this function won't be recorded on the version.
*/
public function cancel(){ public function cancel(){
if(!$this->isCancelled()){ if(!$this->isCancelled()){
$this->task->onCancel(); $this->task->onCancel();
@ -156,4 +160,4 @@ class TaskHandler{
return get_class($this->task); return get_class($this->task);
} }
} }