Function TimerCancel

engine/script/src/script_timer.cpp:664–675

cancel a timer * * You may cancel a timer from inside a timer callback. * Cancelling a timer that is already executed or cancelled is safe. * * @name timer.cancel * @param handle [type:number] the timer handle returned by timer.delay() * @return true [type:boolean] if the timer was active, false if the timer is already cancelled / complete * @examples *

     *
     */
    static int TimerCancel(lua_State* L)
    {
        int top = lua_gettop(L);
        const int handle = luaL_checkint(L, 1);

        dmScript::HTimerWorld timer_world = CheckTimerWorld(L);

        bool cancelled = dmScript::CancelTimer(timer_world, (dmScript::HTimer)handle);
        lua_pushboolean(L, cancelled ? 1 : 0);
        assert(top + 1 == lua_gettop(L));
        return 1;
    }

    /*# trigger a callback
     *