This site has been archived and made available for preservation purposes. No edits can be made.
KillTimer
(Difference between revisions)
Return to current revision
-
Terminates a timer created by [wiki]CreateTimer[/wiki] or [wiki]CreateTimerEx[/wiki].
[h="2"] Declaration [/h]
[highlight=cpp]
-
-
VAULTSCRIPT vaultmp::Void (*KillTimer)(vaultmp::Timer);
-
+
VAULTSCRIPT VAULTSPACE Void (*VAULTAPI(KillTimer))(VAULTSPACE Timer) _CPP(noexcept);
[/highlight]
[highlight=c]
-
native KillTimer(timer);
[/highlight]
[h="2"] Parameters [/h]
-
-
[b][wiki="Timer"]vaultmp::Timer[/wiki][/b] - the timer ID returned by [wiki]CreateTimer[/wiki]
-
+
[b][wiki="Timer"]Timer[/wiki][/b] - the timer ID returned by [wiki]CreateTimer[/wiki] or [wiki]CreateTimerEx[/wiki]
-
[h="2"] Return value [/h]
None.
-
-
[h="2"] Usage example (C++) [/h]
[highlight=cpp]
vaultmp::Timer timer;
vaultmp::Result VAULTSCRIPT MyTimer()
{
KillTimer(timer);
return 0;
}
vaultmp::Void VAULTSCRIPT exec()
{
timer = CreateTimer(&MyTimer, 5000);
}
[/highlight]
[h="2"] Usage example (PAWN) [/h]
[highlight=c]
new timer;
forward MyTimer();
public MyTimer()
{
KillTimer(timer);
return 0;
}
main()
{
timer = CreateTimer("MyTimer", 5000);
}
[/highlight]
-
[h="2"] Related pages [/h]
[list][*][wiki]CreateTimer[/wiki]
[*][wiki]CreateTimerEx[/wiki]
[/LIST]
[category]VaultMP interface[/category]
[category]Scripting functions[/category]
[category]Misc functions[/category]