LLTimers.every

LLTimers.every (self: LLTimersProto, seconds: number, handler: (...any)->()) -> EventHandler

Start a timer that ticks at defined interval

Example

local handler = function(scheduledTime: number, delay: number) : ()
  -- Your code
end

LLTimers:every(3.14, handler)
Raw function spec json 
{
  "def": "func",
  "name": "every",
  "energy": 0,
  "must_use": false,
  "sleep": 0,
  "signatures": [
    {
      "def": "signature",
      "result": [
        {
          "name": "",
          "def": "result",
          "desc": "",
          "variadic": false,
          "type": [
            {
              "def": "custom",
              "value": "EventHandler"
            }
          ],
          "optional": false
        }
      ],
      "args": [
        {
          "def": "arg",
          "name": "self",
          "desc": "self",
          "type": [
            {
              "def": "custom",
              "value": "LLTimersProto"
            }
          ],
          "variadic": false,
          "optional": false
        },
        {
          "def": "arg",
          "name": "seconds",
          "desc": "interval in seconds",
          "type": [
            {
              "def": "simple",
              "value": "number"
            }
          ],
          "variadic": false,
          "optional": false
        },
        {
          "def": "arg",
          "name": "handler",
          "desc": "handler function",
          "type": [
            {
              "def": "function",
              "value": {
                "def": "signature",
                "result": [
                  {
                    "name": "",
                    "def": "result",
                    "desc": "",
                    "variadic": false,
                    "type": [
                      {
                        "def": "simple",
                        "value": "()"
                      }
                    ],
                    "optional": false
                  }
                ],
                "args": [
                  {
                    "def": "arg",
                    "name": "scheduledTime",
                    "desc": "The time the timer was meant to fire, see `ll.GetTime`",
                    "type": [
                      {
                        "def": "simple",
                        "value": "number"
                      }
                    ],
                    "variadic": false,
                    "optional": false
                  },
                  {
                    "def": "arg",
                    "name": "delay",
                    "desc": "The interval specified for this timer",
                    "type": [
                      {
                        "def": "simple",
                        "value": "number"
                      }
                    ],
                    "variadic": false,
                    "optional": false
                  }
                ]
              }
            }
          ],
          "variadic": false,
          "optional": false
        }
      ]
    }
  ],
  "desc": "Start a timer that ticks at defined interval",
  "link": null,
  "takesSelf": true,
  "private": false
}

< Back to LLTimers