PHP Class pocketmine\scheduler\TaskHandler

Show file Open project: iTXTech/Genisys Class Usage Examples

Public Properties

Property Type Description
$timingName
$timings pocketmine\event\TimingsHandler

Protected Properties

Property Type Description
$cancelled boolean
$delay integer
$nextRun integer
$period integer
$task Task
$taskId integer

Public Methods

Method Description
__construct ( string $timingName, Task $task, integer $taskId, integer $delay, integer $period )
cancel ( ) WARNING: Do not use this, it's only for internal use.
getDelay ( ) : integer
getNextRun ( ) : integer
getPeriod ( ) : integer
getTask ( ) : Task
getTaskId ( ) : integer
getTaskName ( ) : string
isCancelled ( ) : boolean
isDelayed ( ) : boolean
isRepeating ( ) : boolean
remove ( )
run ( integer $currentTick )
setNextRun ( integer $ticks )

Method Details

__construct() public method

public __construct ( string $timingName, Task $task, integer $taskId, integer $delay, integer $period )
$timingName string
$task Task
$taskId integer
$delay integer
$period integer

cancel() public method

Changes to this function won't be recorded on the version.
public cancel ( )

getDelay() public method

public getDelay ( ) : integer
return integer

getNextRun() public method

public getNextRun ( ) : integer
return integer

getPeriod() public method

public getPeriod ( ) : integer
return integer

getTask() public method

public getTask ( ) : Task
return Task

getTaskId() public method

public getTaskId ( ) : integer
return integer

getTaskName() public method

public getTaskName ( ) : string
return string

isCancelled() public method

public isCancelled ( ) : boolean
return boolean

isDelayed() public method

public isDelayed ( ) : boolean
return boolean

isRepeating() public method

public isRepeating ( ) : boolean
return boolean

remove() public method

public remove ( )

run() public method

public run ( integer $currentTick )
$currentTick integer

setNextRun() public method

public setNextRun ( integer $ticks )
$ticks integer

Property Details

$cancelled protected property

protected bool $cancelled
return boolean

$delay protected property

protected int $delay
return integer

$nextRun protected property

protected int $nextRun
return integer

$period protected property

protected int $period
return integer

$task protected property

protected Task,pocketmine\scheduler $task
return Task

$taskId protected property

protected int $taskId
return integer

$timingName public property

public $timingName

$timings public property

public TimingsHandler,pocketmine\event $timings
return pocketmine\event\TimingsHandler