slua_definitions.schema.json

{
    "$schema": "http://json-schema.org/draft/2019-09/schema",
    "$id": "http://raw.githubusercontent.com/secondlife/lsl-definitions/refs/heads/main/slua_definitions.schema.json",
    "$comment": "This schema defines keywords for the Server Lua Language (SLua) of Second Life.",
    "$defs": {
        "identifier": {
            "pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$",
            "type": "string"
        },
        "type": {
            "markdownDescription": "A luau-format type definition.",
            "pattern": "^([ \n?&|,{}\\[\\]()<>:a-zA-Z0-9_]|\"[^\"]*\"|\\.\\.\\.|->)*$",
            "type": "string"
        },
        "selene-type": {
            "title": "A type understood by selene.",
            "description": "See https://kampfkarren.github.io/selene/usage/std.html#properties.",
            "oneOf": [
                {"enum": ["any", "bool", "function", "nil", "number", "string", "table"]},
                {"type": "array", "items": {"type": "string"}},
                {"type": "object", "additionalProperties": false, "properties": {"display": {"type": "string"}}}
            ]
        },
        "deprecated": {
            "markdownDescription": "This function or property has been deprecated.",
            "oneOf": [
                {"type": "boolean" , "const": true},
                {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "reason": {
                            "markdownDescription": "The reason for deprecation.",
                            "type": "string"
                        },
                        "use": {
                            "markdownDescription": "What to use instead.",
                            "type": "string"
                        },
                        "selene-replace": {
                            "markdownDescription": "Pattern replacements for selene.",
                            "type": "array",
                            "items": {"type": "string"}
                        }
                    }
                }
            ]
        },
        "property": {
            "markdownDescription": "A property or constant.",
            "additionalProperties": false,
            "properties": {
                "name": { "$ref": "#/$defs/identifier" },
                "type": { "$ref": "#/$defs/type" },
                "value": {
                    "markdownDescription": "The value of the constant.",
                    "type": ["number", "string"]
                },
                "comment": {
                    "markdownDescription": "A brief description of this constant.",
                    "type": "string"
                },
                "modifiable": {
                    "title": "Passed through to the selene `property` field.",
                    "description": "See https://kampfkarren.github.io/selene/usage/std.html#properties.",
                    "enum": ["read-only", "new-fields", "override-fields", "full-write"],
                    "default": "read-only"
                }
            },
            "required": ["name", "type"],
            "type": "object"
        },
        "type-alias": {
            "markdownDescription": "A type alias.",
            "additionalProperties": false,
            "properties": {
                "name": { "$ref": "#/$defs/identifier" },
                "definition": { "$ref": "#/$defs/type" },
                "selene-type": { "$ref": "#/$defs/selene-type" },
                "comment": {
                    "markdownDescription": "A brief description of this alias.",
                    "type": "string"
                },
                "export": {
                    "const": true,
                    "markdownDescription": "Whether this type is available to users.",
                    "type": "boolean"
                }
            },
            "required": ["name", "definition", "selene-type"],
            "type": "object"
        },
        "function-parameter": {
            "markdownDescription": "A function parameter.",
            "additionalProperties": false,
            "properties": {
                "name": { "oneOf": [
                    { "$ref": "#/$defs/identifier" },
                    { "const": "...", "type": "string" }
                ]},
                "type": { "$ref": "#/$defs/type" },
                "selene-type": { "$ref": "#/$defs/selene-type" },
                "optional": {
                    "title": "Is this parameter optional.",
                    "markdownDescription": "Defaults to true if type ends in `?`, false otherwise.",
                    "type": "boolean"
                },
                "observes": {
                    "title": "Hint for unused variable detection.",
                    "description": "See https://kampfkarren.github.io/selene/usage/std.html#observes.",
                    "enum": ["read-write", "read", "write"],
                    "default": "read-write"
                },
                "comment": {
                    "markdownDescription": "A brief description of this parameter.",
                    "type": "string"
                },
                "default-value": {
                    "markdownDescription": "The default value of this parameter when omitted.",
                    "type": ["string", "number", "boolean", "null"]
                }
            },
            "required": ["name"],
            "type": "object"
        },
        "function-anon": {
            "markdownDescription": "A plain function signature; no name or overloads.",
            "additionalProperties": false,
            "properties": {
                "type-parameters": {
                    "items": {
                        "pattern": "^(\\.\\.\\.)?[_a-zA-Z][_a-zA-Z0-9]*(\\.\\.\\.)?$",
                        "type": "string"
                     },
                    "type": "array"
                },
                "parameters": {
                    "items": { "$ref": "#/$defs/function-parameter" },
                    "type": "array"
                },
                "return-type": { "$ref": "#/$defs/type" },
                "comment": {
                    "markdownDescription": "A brief description of this function.",
                    "type": "string"
                }
            },
            "required": [],
            "type": "object"
        },
        "function-variant": {
            "markdownDescription": "An alternative structure or shape for a function.",
            "additionalProperties": false,
            "properties": {
                "comment": {
                    "markdownDescription": "A brief description of this variant.",
                    "type": "string"
                },
                "parameters": {
                    "items": { "$ref": "#/$defs/function-parameter" },
                    "type": "array"
                },
                "return-type": { "$ref": "#/$defs/type" }
            },
            "type": "object"
        },
        "function": {
            "markdownDescription": "A full function signature.",
            "additionalProperties": false,
            "properties": {
                "name": { "$ref": "#/$defs/identifier" },
                "type-parameters": {
                    "items": {
                        "pattern": "^(\\.\\.\\.)?[_a-zA-Z][_a-zA-Z0-9]*(\\.\\.\\.)?$",
                        "type": "string"
                     },
                    "type": "array"
                },
                "parameters": {
                    "items": { "$ref": "#/$defs/function-parameter" },
                    "type": "array"
                },
                "return-type": { "$ref": "#/$defs/type" },
                "overloads": {
                    "items": { "$ref": "#/$defs/function-anon" },
                    "type": "array"
                },
                "variants": {
                    "items": { "$ref": "#/$defs/function-variant" },
                    "type": "array"
                },
                "deprecated": { "$ref": "#/$defs/deprecated" },
                "local-only": {
                    "const": true,
                    "markdownDescription": "This function is not available in-world, only locally.",
                    "type": "boolean"
                },
                "slua-removed": {
                    "const": true,
                    "markdownDescription": "This function is only present in Luau, not SLua.",
                    "type": "boolean"
                },
                "must-use": {
                    "const": true,
                    "title": "Give a warning if the return value is not used.",
                    "description": "See https://kampfkarren.github.io/selene/usage/std.html#must_use.",
                    "type": "boolean"
                },
                "fastcall": {
                    "const": true,
                    "title": "This function has a dedicated bytecode in the luau vm.",
                    "description": "See https://github.com/secondlife/slua/blob/main/Common/include/Luau/Bytecode.h#L542",
                    "type": "boolean"
                },
                "comment": {
                    "markdownDescription": "A brief description of this function.",
                    "type": "string"
                },
                "typechecker": {
                    "type": "object",
                    "description": "Flags specific to the internals of luau-analyze and luau-lsp.",
                    "additionalProperties": false,
                    "properties": {
                        "builtin": {
                            "const": true,
                            "description": "This function is defined in BuiltinDefinitions.cpp, rather than EmbeddedBuiltinDefinitions.cpp.",
                            "type": "boolean"
                        },
                        "magic": {
                            "const": true,
                            "description": "The typechecker has custom logic for this function. Look for attachMagicFunction in the source code.",
                            "type": "boolean"
                        },
                        "checked": {
                            "const": true,
                            "markdownDescription": "This function's run-time type checks match the typechecker. Functions with checked types report the same errors in --!strict and --!nonstrict modes.",
                            "type": "boolean"
                        }
                    }
                }
            },
            "required": ["name"],
            "type": "object"
        },
        "class": {
            "markdownDescription": "A type with properties and methods.",
            "additionalProperties": false,
            "properties": {
                "name": { "$ref": "#/$defs/identifier" },
                "instance-type": { "$ref": "#/$defs/type" },
                "export": {
                    "const": true,
                    "markdownDescription": "Whether this type is available to users. Only applicable if instance-type is specified.",
                    "type": "boolean"
                },
                "properties": {
                    "items": { "$ref": "#/$defs/property" },
                    "type": "array"
                },
                "functions": {
                    "items": { "$ref": "#/$defs/function" },
                    "type": "array"
                },
                "methods": {
                    "items": { "$ref": "#/$defs/function" },
                    "type": "array"
                },
                "comment": {
                    "markdownDescription": "A brief description of this type.",
                    "type": "string"
                }
            },
            "required": ["name"],
            "type": "object"
        },
        "module": {
            "markdownDescription": "A table with constants and functions.",
            "additionalProperties": false,
            "properties": {
                "name": { "$ref": "#/$defs/identifier" },
                "callable": { "$ref": "#/$defs/function" },
                "constants": {
                    "items": { "$ref": "#/$defs/property" },
                    "type": "array"
                },
                "functions": {
                    "items": { "$ref": "#/$defs/function" },
                    "type": "array"
                },
                "comment": {
                    "markdownDescription": "A brief description of this type.",
                    "type": "string"
                }
            },
            "required": ["name", "comment"],
            "type": "object"
        },
        "metamethod-variant": {
            "markdownDescription": "An alternative structure or shape for a metamethod.",
            "additionalProperties": false,
            "properties": {
                "comment": {
                    "markdownDescription": "A brief description of this variant.",
                    "type": "string"
                },
                "type": {
                    "markdownDescription": "The type of this specific variant.",
                    "type": "string"
                },
                "parameters": {
                    "items": { "$ref": "#/$defs/function-parameter" },
                    "type": "array"
                },
                "return-type": { "$ref": "#/$defs/type" }
            },
            "required": ["type"],
            "type": "object"
        },
        "metamethod-definition": {
            "markdownDescription": "A metamethod signature and description.",
            "additionalProperties": false,
            "properties": {
                "name": {
                    "markdownDescription": "The name of the metamethod.",
                    "pattern": "^__[a-z]+$",
                    "type": "string"
                },
                "comment": {
                    "markdownDescription": "A brief description of this metamethod.",
                    "type": "string"
                },
                "type-parameters": {
                    "items": {
                        "pattern": "^(\\.\\.\\.)?[_a-zA-Z][_a-zA-Z0-9]*(\\.\\.\\.)?$",
                        "type": "string"
                     },
                    "type": "array"
                },
                "type": {
                    "markdownDescription": "The combined or primary type of this metamethod.",
                    "type": "string"
                },
                "parameters": {
                    "items": { "$ref": "#/$defs/function-parameter" },
                    "type": "array"
                },
                "return-type": { "$ref": "#/$defs/type" },
                "variants": {
                    "items": { "$ref": "#/$defs/metamethod-variant" },
                    "type": "array"
                }
            },
            "required": ["name"],
            "type": "object"
        }
    },
    "additionalProperties": false,
    "properties": {
        "version": {
            "markdownDescription": "Only increment with file format changes.",
            "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$",
            "type": "string"
        },
        "base-classes": {
            "items": { "$ref": "#/$defs/class" },
            "type": "array"
        },
        "type-aliases": {
            "items": { "$ref": "#/$defs/type-alias" },
            "type": "array"
        },
        "classes": {
            "items": { "$ref": "#/$defs/class" },
            "type": "array"
        },
        "global-variables": {
            "items": { "$ref": "#/$defs/property" },
            "type": "array"
        },
        "functions": {
            "items": { "$ref": "#/$defs/function" },
            "type": "array"
        },
        "modules": {
            "items": { "$ref": "#/$defs/module" },
            "type": "array"
        },
        "constants": {
            "items": { "$ref": "#/$defs/property" },
            "type": "array"
        },
        "builtin-constants": {
            "items": { "$ref": "#/$defs/property" },
            "type": "array"
        },
        "controls": {
            "markdownDescription": "The Luau keywords.",
            "additionalProperties": false,
            "patternProperties": {
                "^(?:[a-z]+)$": {
                    "properties": {
                        "tooltip": {
                            "markdownDescription": "A brief description of this keyword.",
                            "type": "string"
                        }
                    },
                    "required": ["tooltip"],
                    "type": "object"
                }
            },
            "type": "object"
        },
        "builtin-types": {
            "markdownDescription": "The Luau builtin types.",
            "additionalProperties": false,
            "patternProperties": {
                "^[a-z]*": {
                    "properties": {
                        "tooltip": {
                            "markdownDescription": "A brief description of this type.",
                            "type": "string"
                        }
                    },
                    "required": [
                        "tooltip"
                    ],
                    "type": "object"
                }
            },
            "type": "object"
        },
        "metamethods": {
            "items": { "$ref": "#/$defs/metamethod-definition" },
            "type": "array"
        }
    },
    "required": [
        "version",
        "base-classes",
        "type-aliases",
        "classes",
        "functions",
        "modules",
        "constants",
        "controls",
        "builtin-types",
        "builtin-constants",
        "metamethods"
    ],
    "title": "Second Life SLua Definitions",
    "type": "object"
}