This site has been archived and made available for preservation purposes. No edits can be made.

KillTimer

(Difference between revisions)
Return to current revision
  1.  
    Terminates a timer created by [wiki]CreateTimer[/wiki] or [wiki]CreateTimerEx[/wiki].
    [h="2"] Declaration [/h]
  2. -
    <code cpp>
    VAULTSCRIPT void (*KillTimer)(vaultmp::Timer);
  3. +
    [highlight=cpp]
    VAULTSCRIPT vaultmp::Void (*KillTimer)(vaultmp::Timer);
  4.  
    native KillTimer(timer);
  5. -
    </code>
  6. +
    [/highlight]
  7.  
    [h="2"] Parameters [/h]
    [b][wiki="Timer"]vaultmp::Timer[/wiki][/b] - the timer ID returned by [wiki]CreateTimer[/wiki]
    [h="2"] Return value [/h]
    None.
    [h="2"] Usage example (C++) [/h]
  8. -
    <code cpp>
  9. +
    [highlight=cpp]
  10.  
    vaultmp::Timer timer;
    vaultmp::Result VAULTSCRIPT MyTimer()
    {
    KillTimer(timer);
    return 0;
    }
  11. -
    void VAULTSCRIPT exec()
  12. +
    vaultmp::Void VAULTSCRIPT exec()
  13.  
    {
    timer = CreateTimer(&MyTimer, 5000);
    }
  14. -
    </code>
  15. +
    [/highlight]
  16.  
    [h="2"] Usage example (PAWN) [/h]
  17. -
    <code c>
  18. +
    [highlight=c]
  19.  
    new timer;
    forward MyTimer();
    public MyTimer()
    {
    KillTimer(timer);
    return 0;
    }
    main()
    {
    timer = CreateTimer("MyTimer", 5000);
    }
  20. -
    </code>
  21. +
    [/highlight]
  22.  
    [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]