SetTimer

SetTimer

Description:

Function SetTimer sets a 'timer' to call a function after some time. Can be set to repeat.

Timer intervals are not accurate (roughly 25% off). Timer IDs are never used twice. You can use KillTimer() on a timer ID and it won't matter if it's running or not. The function that should be called, must be public, meaning it has to be forwarded. The use of many timers will result in increased memory/cpu usage.

Parameters:

(funcname[], interval, repeating)

string

funcname

Name of the function to call as a string. This must be a public function (forwarded). A null string here will crash the server.

int

interval

Interval in milliseconds.

bool

repeating

Boolean (true/false) on whether the timer should repeat or not.

Return Values:

The ID of the timer that was started. Timer IDs start at 1.

Examples:

Example 1

forward message();
 
public OnGameModeInit()
{
    print("Starting timer...");
    SetTimer("message", 1000, false); // Set a timer of 1000 miliseconds (1 second)
}
 
public message()
{
    print("1 second has passed.");
}

Related Functions

The following functions may be useful, as they are related to this function in one way or another.

• SetTimerEx: Set a timer with parameters.
• KillTimer: Stop a timer.