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

KillTimer

(Difference between revisions)
Return to current revision
Current Revision 08-14-2012, 08:56 PM
  1. -
    Kills a timer created by [[CreateTimer]].

    == Declaration ==
    <code cpp>
    VAULTSCRIPT void (*KillTimer)(vaultmp::Timer);
  2. +
    Terminates a timer created by [wiki]CreateTimer[/wiki] or [wiki]CreateTimerEx[/wiki].
    [h="2"] Declaration [/h]
    [highlight=cpp]
    VAULTSCRIPT VAULTSPACE Void (*VAULTAPI(KillTimer))(VAULTSPACE Timer) _CPP(noexcept);
    [/highlight]
    [highlight=c]
  3.  
    native KillTimer(timer);
  4. -
    </code>
    == Parameters ==

    '''[[Timer|vaultmp::Timer]]''' - the timer ID returned by [[CreateTimer]]

    == Return value ==

  5. +
    [/highlight]
    [h="2"] Parameters [/h]
    [b][wiki="Timer"]Timer[/wiki][/b] - the timer ID returned by [wiki]CreateTimer[/wiki] or [wiki]CreateTimerEx[/wiki]
    [h="2"] Return value [/h]
  6.  
    None.
  7. -

    == Usage example (C++) ==

    <code cpp>
    vaultmp::Timer timer;

    void MyTimer()
    {
    KillTimer(timer);
    }

    void VAULTSCRIPT exec()
    {
    timer = CreateTimer(&MyTimer, 5000);
    }
    </code>

    == Usage example (PAWN) ==

    <code c>
    new timer;
    forward MyTimer();

    public MyTimer()
    {
    KillTimer(timer);
    }

    main()
    {
    timer = CreateTimer("MyTimer", 5000);
    }
    </code>
  8. +
    [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]