Skip to main content

SDK

Functions​

Init​

</>
SDK:Init(Options: Options) → ()

Types

​

interface Options {
DSN: string?--

The DSN for the sentry project to send events to

debug: boolean?--

See SDK.debug (must press the "Show Private")

DefaultIntegrations: boolean?--

Whether to enable the built-in integrations. Defaults to true.

Integrations: {Integration}?
Release: string?
Environment: string?
SampleRate: number?
ServerName: string?--

Defaults to game.JobId or "local"

}
Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "",
            "params": [
                {
                    "name": "Options",
                    "desc": "",
                    "lua_type": "Options"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 30,
                "path": "src/init.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "Options",
            "desc": "",
            "fields": [
                {
                    "name": "DSN",
                    "lua_type": "string?",
                    "desc": "The DSN for the sentry project to send events to"
                },
                {
                    "name": "debug",
                    "lua_type": "boolean?",
                    "desc": "See [SDK.debug] (must press the \"Show Private\")"
                },
                {
                    "name": "DefaultIntegrations",
                    "lua_type": "boolean?",
                    "desc": "Whether to enable the built-in integrations. Defaults to true."
                },
                {
                    "name": "Integrations",
                    "lua_type": "{Integration}?",
                    "desc": ""
                },
                {
                    "name": "Release",
                    "lua_type": "string?",
                    "desc": ""
                },
                {
                    "name": "Environment",
                    "lua_type": "string?",
                    "desc": ""
                },
                {
                    "name": "SampleRate",
                    "lua_type": "number?",
                    "desc": ""
                },
                {
                    "name": "ServerName",
                    "lua_type": "string?",
                    "desc": "Defaults to `game.JobId` or `\"local\"`"
                }
            ],
            "source": {
                "line": 28,
                "path": "src/Defaults.lua"
            }
        }
    ],
    "name": "SDK",
    "desc": "",
    "source": {
        "line": 13,
        "path": "src/init.lua"
    }
}