SetTimer

From SA-MP Wiki

Jump to: navigation, search


Description:

Sets a 'timer' to call a function after some time. Can be set to repeat.


Parameters:
(funcname[], interval, repeating)
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.
intervalInterval in milliseconds.
repeatingBoolean (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.


Image:32px-Ambox_warning_orange.png

Notes

  • Timer intervals are not accurate (roughly 25% off). There are fixes available here and here.
  • 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.


Example Usage:

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.

Personal tools
In other languages