Skip to main content

Counter

Functions​

new​

</>
Counter.new() → Counter

Creates a new counter

GetValue​

</>
Counter.GetValue(self: Counter) → number

Returns the current count

Observe​

</>
Counter.Observe(self: Counter) → number

Observes the current count

Add​

</>
Counter.Add(
self: Counter,
amount: number | Observable<number>
) → MaidTask

Adds an amount to the counter.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new counter",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Counter"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 38,
                "path": "src/counter/src/Shared/Counter.lua"
            }
        },
        {
            "name": "GetValue",
            "desc": "Returns the current count",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "Counter"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 53,
                "path": "src/counter/src/Shared/Counter.lua"
            }
        },
        {
            "name": "Observe",
            "desc": "Observes the current count",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "Counter"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 62,
                "path": "src/counter/src/Shared/Counter.lua"
            }
        },
        {
            "name": "Add",
            "desc": "Adds an amount to the counter.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "Counter"
                },
                {
                    "name": "amount",
                    "desc": "",
                    "lua_type": "number | Observable<number>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "MaidTask"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 72,
                "path": "src/counter/src/Shared/Counter.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Counter",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/counter/src/Shared/Counter.lua"
    }
}