TaskHandler Class Reference

Public Member Functions
	__construct ($timingName, Task $task, $taskId, $delay=-1, $period=-1)
	isCancelled ()
	getNextRun ()
	setNextRun ($ticks)
	getTaskId ()
	getTask ()
	getDelay ()
	isDelayed ()
	isRepeating ()
	getPeriod ()
	cancel ()
	remove ()
	run ($currentTick)
	getTaskName ()

Data Fields
	$timings
	$timingName = null

Protected Attributes
	$task
	$taskId
	$delay
	$period
	$nextRun
	$cancelled = false

Constructor & Destructor Documentation

__construct()

__construct	(		$timingName,
		Task	$task,
			$taskId,
			$delay = -1,
			$period = -1
	)

Parameters

string	$timingName
Task	$task
int	$taskId
int	$delay
int	$period

                                                                                            {
        $this->task = $task;
        $this->taskId = $taskId;
        $this->delay = $delay;
        $this->period = $period;
        $this->timingName = $timingName === null ? "Unknown" : $timingName;
        $this->timings = Timings::getPluginTaskTimings($this, $period);
        $this->task->setHandler($this);
    }

Member Function Documentation

cancel()

cancel

(

)

WARNING: Do not use this, it's only for internal use. Changes to this function won't be recorded on the version.

                            {
        if(!$this->isCancelled()){
            $this->task->onCancel();
        }
        $this->remove();
    }

getDelay()

getDelay

(

)

Returns

int

                              {
        return $this->delay;
    }

getNextRun()

getNextRun

(

)

Returns

int

                                {
        return $this->nextRun;
    }

getPeriod()

getPeriod

(

)

Returns

int

                               {
        return $this->period;
    }

getTask()

getTask

(

)

Returns

Task

                             {
        return $this->task;
    }

getTaskId()

getTaskId

(

)

Returns

int

                               {
        return $this->taskId;
    }

getTaskName()

getTaskName

(

)

Returns

string

                                 {
        if($this->timingName !== null){
            return $this->timingName;
        }

        return get_class($this->task);
    }

isCancelled()

isCancelled

(

)

Returns

bool

                                 {
        return $this->cancelled === true;
    }

isDelayed()

isDelayed

(

)

Returns

bool

                               {
        return $this->delay > 0;
    }

isRepeating()

isRepeating

(

)

Returns

bool

                                 {
        return $this->period > 0;
    }

remove()

remove

(

)

                            {
        $this->cancelled = true;
        $this->task->setHandler(null);
    }

run()

run

(

$currentTick

)

Parameters

int

$currentTick

                                     {
        $this->task->onRun($currentTick);
    }

setNextRun()

setNextRun

(

$ticks

)

Parameters

int

$ticks

                                      {
        $this->nextRun = $ticks;
    }

Field Documentation

$cancelled

$cancelled = false

protected

$delay

$delay

protected

$nextRun

$nextRun

protected

$period

$period

protected

$task

$task

protected

$taskId

$taskId

protected

$timingName

$timingName = null

$timings

$timings

---

The documentation for this class was generated from the following file:

• src/pocketmine/scheduler/TaskHandler.php