Skip to main content

DebounceTimer

DebounceTimer

Functions​

new​

</>
DebounceTimer.new(length: number) → DebounceTimer

SetLength​

</>
DebounceTimer.SetLength(
length: number
) → ()

Gets the length

Restart​

</>
DebounceTimer.Restart(self: DebounceTimer) → ()

Restarts the timer

IsRunning​

</>
DebounceTimer.IsRunning(self: DebounceTimer) → boolean

Returns whether or not the timer is running.

GetTimeRemaining​

</>
DebounceTimer.GetTimeRemaining(self: DebounceTimer) → number

Returns the amount of time remaining in the timer.

IsDone​

</>
DebounceTimer.IsDone(self: DebounceTimer) → boolean

Returns if the timer is done

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [
                {
                    "name": "length",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "DebounceTimer"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "src/debounce/src/Shared/DebounceTimer.lua"
            }
        },
        {
            "name": "SetLength",
            "desc": "Gets the length",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "DebounceTimer"
                },
                {
                    "name": "length",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 35,
                "path": "src/debounce/src/Shared/DebounceTimer.lua"
            }
        },
        {
            "name": "Restart",
            "desc": "Restarts the timer",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "DebounceTimer"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 42,
                "path": "src/debounce/src/Shared/DebounceTimer.lua"
            }
        },
        {
            "name": "IsRunning",
            "desc": "Returns whether or not the timer is running.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "DebounceTimer"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 50,
                "path": "src/debounce/src/Shared/DebounceTimer.lua"
            }
        },
        {
            "name": "GetTimeRemaining",
            "desc": "Returns the amount of time remaining in the timer.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "DebounceTimer"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 58,
                "path": "src/debounce/src/Shared/DebounceTimer.lua"
            }
        },
        {
            "name": "IsDone",
            "desc": "Returns if the timer is done",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "DebounceTimer"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 71,
                "path": "src/debounce/src/Shared/DebounceTimer.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "DebounceTimer",
    "desc": "DebounceTimer",
    "source": {
        "line": 6,
        "path": "src/debounce/src/Shared/DebounceTimer.lua"
    }
}