(Difference between revisions)
Return to current revision
-
Creates a timer.
[h="2"] Declaration [/h]
[highlight=cpp]
VAULTSCRIPT VAULTSPACE Timer (*VAULTAPI(CreateTimer))(VAULTSPACE RawFunction(), VAULTSPACE Interval) _CPP(noexcept);
[/highlight]
[highlight=c]
native CreateTimer(const func{}, interval);
[/highlight]
[h="2"] Parameters [/h]
-
-
[b][wiki="Function"]vaultmp::Function[/wiki][/b] (C++ only) - the function of the timer
[b]func[/b] (PAWN only) - the name of the timer's function
[b][wiki="Interval"]vaultmp::Interval[/wiki][/b] - the timer interval in milliseconds
-
+
[b][wiki="Function"]Function[/wiki][/b] - the function of the timer
[b][wiki="Interval"]Interval[/wiki][/b] - the timer interval in milliseconds
-
[h="2"] Return value [/h]
-
-
Returns a [wiki="Timer"]vaultmp::Timer[/wiki] referring to the newly created timer.
-
+
Returns a [wiki="Timer"]Timer[/wiki] referring to the newly created timer.
-
[h="2"] Usage example (C++) [/h]
[highlight=cpp]
-
-
vaultmp::Result VAULTSCRIPT MyTimer()
-
+
Result VAULTSCRIPT MyTimer()
-
{
// Timer function
-
-
return 0;
-
+
return static_cast<Result>(0);
-
}
-
-
vaultmp::Void VAULTSCRIPT exec()
-
+
Void VAULTSCRIPT exec() noexcept
-
{
-
-
CreateTimer(&MyTimer, 5000);
-
+
CreateTimer(MyTimer, static_cast<Interval>(5000));
-
}
[/highlight]
[h="2"] Usage example (PAWN) [/h]
[highlight=c]
forward MyTimer();
public MyTimer()
{
// Timer function
return 0;
}
main()
{
CreateTimer("MyTimer", 5000);
}
[/highlight]
[h="2"] Related pages [/h]
[list][*][wiki]CreateTimerEx[/wiki]
[*][wiki]KillTimer[/wiki]
[/LIST]
[category]VaultMP interface[/category]
[category]Scripting functions[/category]
[category]Misc functions[/category]