Skip to main content

GlobalMetricRegistry

Used to store global metrics for the round

Functions​

new​

</>
GlobalMetricRegistry.new() → GlobalMetricRegistry

Constructs a new GlobalMetricRegistry.

Get​

</>
GlobalMetricRegistry:Get(key: string) → any

Gets a value from the registry

Set​

</>
GlobalMetricRegistry:Set(
key: string,
value: any
) → ()

Sets a value in the registry

Clear​

</>
GlobalMetricRegistry:Clear() → ()

Clears all values from the registry

Destroy​

</>
GlobalMetricRegistry:Destroy() → ()

Destroys the global metric registry

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new GlobalMetricRegistry.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "GlobalMetricRegistry"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 9,
                "path": "src/Registries/GlobalMetricRegistry.lua"
            }
        },
        {
            "name": "Get",
            "desc": "Gets a value from the registry",
            "params": [
                {
                    "name": "key",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 18,
                "path": "src/Registries/GlobalMetricRegistry.lua"
            }
        },
        {
            "name": "Set",
            "desc": "Sets a value in the registry",
            "params": [
                {
                    "name": "key",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 26,
                "path": "src/Registries/GlobalMetricRegistry.lua"
            }
        },
        {
            "name": "Clear",
            "desc": "Clears all values from the registry",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 32,
                "path": "src/Registries/GlobalMetricRegistry.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Destroys the global metric registry",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 43,
                "path": "src/Registries/GlobalMetricRegistry.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "GlobalMetricRegistry",
    "desc": "Used to store global metrics for the round",
    "source": {
        "line": 3,
        "path": "src/Registries/GlobalMetricRegistry.lua"
    }
}