\ManiaControl\CallbacksTimerListening

Model Class for a Timer Listening

Summary

Methods
Properties
Constants
getUsageInformation()
__construct()
checkValidCallback()
triggerCallback()
triggerCallbackWithParams()
getUserFunction()
tick()
isTimeReached()
$listener
$method
$deltaTime
$oneTime
$lastTrigger
$instantCall
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$listener

$listener : 

Type

$method

$method : 

Type

$deltaTime

$deltaTime : 

Type

$oneTime

$oneTime : 

Type

$lastTrigger

$lastTrigger : 

Type

$instantCall

$instantCall : 

Type

Methods

getUsageInformation()

getUsageInformation() 

Gets Information about the Class, and a List of the Public Method

__construct()

__construct(\ManiaControl\Callbacks\TimerListener  $listener, mixed  $method, float  $milliSeconds, boolean  $oneTime = false, boolean  $instantCall = true) 

Construct a new Timer Listening

Parameters

\ManiaControl\Callbacks\TimerListener $listener
mixed $method
float $milliSeconds
boolean $oneTime
boolean $instantCall

checkValidCallback()

checkValidCallback(object  $listener, mixed  $method) : boolean

Check if the given Listener and Method build a valid Callback

Parameters

object $listener
mixed $method

Returns

boolean

triggerCallback()

triggerCallback() 

Trigger the Listener's Method

triggerCallbackWithParams()

triggerCallbackWithParams(array  $params) : mixed

Trigger the Listener's Method with the given Array of Params

Parameters

array $params

Returns

mixed

getUserFunction()

getUserFunction() : callable

Get the Callable User Function

Returns

callable

tick()

tick() 

Increase last Trigger Time

isTimeReached()

isTimeReached(float  $time = null) : boolean

Check if the desired Time is reached

Parameters

float $time

Returns

boolean