LLEvents.off

LLEvents.off (self: LLEventsProto, eventName: EventName, handler: EventHandler) -> boolean

Clear a event handler

Example

local handler = function(...any) : ()
  -- Your code
end

LLEvents:off(EventName, handler)
Raw function spec json 
{
  "def": "func",
  "name": "off",
  "energy": 0,
  "must_use": false,
  "sleep": 0,
  "signatures": [
    {
      "def": "signature",
      "result": [
        {
          "name": "",
          "def": "result",
          "desc": "",
          "variadic": false,
          "type": [
            {
              "def": "simple",
              "value": "boolean"
            }
          ],
          "optional": false
        }
      ],
      "args": [
        {
          "def": "arg",
          "name": "self",
          "desc": "self",
          "type": [
            {
              "def": "custom",
              "value": "LLEventsProto"
            }
          ],
          "variadic": false,
          "optional": false
        },
        {
          "def": "arg",
          "name": "eventName",
          "desc": "name of the Event to hook",
          "type": [
            {
              "def": "custom",
              "value": "EventName"
            }
          ],
          "variadic": false,
          "optional": false
        },
        {
          "def": "arg",
          "name": "handler",
          "desc": "The name of the function to handle the event",
          "type": [
            {
              "def": "custom",
              "value": "EventHandler"
            }
          ],
          "variadic": false,
          "optional": false
        }
      ]
    }
  ],
  "desc": "Clear a event handler",
  "link": null,
  "takesSelf": true,
  "private": false
}

< Back to LLEvents