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. -
    Kills a timer created by [[CreateTimer]].

    == Declaration ==
    <code cpp>
    VAULTSCRIPT void (*KillTimer)(vaultmp::Timer);
    native KillTimer(timer);
    </code>
    == Parameters ==

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

    == Return value ==

    None.

    == 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>