Skip to main content

Config

BasicCustomization

A module for configuring various aspects of the sandbox.

Properties​

AllowParallelLuau​

This item is read only and cannot be modified. Read OnlyAdvancedCustomization
</>
Config.AllowParallelLuau: boolean

Whether the sandbox will allow Actors (Parallel Luau) to be used in the sandbox. Default: false.

When this is false, any call to the sandboxer from an Actor will error. Each Actor creates its own instance of this module, so if this is problematic (and it likely will be because of memory usage), set this to false. When this is true, the sandboxer will work as expected in Actors, but it may cause performance issues and increased memory usage. task.synchronize() and task.desynchronize() will work as usual, but errors regarding property sets while in parallel mode might not make sense.

TrackInstances​

This item is read only and cannot be modified. Read OnlyBasicCustomization
</>
Config.TrackInstances: boolean

Whether the sandbox should track Instances. Default: false.

If this is enabled, the sandbox will keep track of all Instances that are created in the sandbox. It will also track all Instances that are accessed in the sandbox.

This will allow for forcible cleanup of Instances that are created in the sandbox, but it may cause performance issues if there are a lot of Instances being created.

TrackRBXScriptConnections​

This item is read only and cannot be modified. Read OnlyBasicCustomization
</>
Config.TrackRBXScriptConnections: boolean

Whether the sandbox should track RBXScriptConnections. Default: false.

If this is enabled, the sandbox will keep track of all RBXScriptConnections that are created in the sandbox. This will allow for forcible cleanup of RBXScriptConnections that are created in the sandbox, but it may cause performance issues if there are a lot of RBXScriptConnections being created.

Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "AllowParallelLuau",
            "desc": "Whether the sandbox will allow Actors (Parallel Luau)\nto be used in the sandbox. **Default:** `false`.\n\nWhen this is `false`, any call to the sandboxer from an\nActor will error. Each Actor creates its own instance of\nthis module, so if this is problematic (and it likely will\nbe because of memory usage), set this to `false`. \nWhen this is `true`, the sandboxer will work as expected in \nActors, but it may cause performance issues and increased \nmemory usage. `task.synchronize()` and `task.desynchronize()` \nwill work as usual, but errors regarding property sets while\nin parallel mode might not make sense.",
            "lua_type": "boolean",
            "tags": [
                "Advanced",
                "Customization"
            ],
            "readonly": true,
            "source": {
                "line": 50,
                "path": "src/Config.luau"
            }
        },
        {
            "name": "TrackInstances",
            "desc": "Whether the sandbox should track `Instance`s. **Default:** `false`.\n\nIf this is enabled, the sandbox will keep track of all `Instance`s\nthat are created in the sandbox. It will also track all `Instance`s \nthat are accessed in the sandbox.\n\nThis will allow for forcible cleanup of `Instance`s that are created \nin the sandbox, but it may cause performance issues if there are a lot \nof `Instance`s being created.",
            "lua_type": "boolean",
            "tags": [
                "Basic",
                "Customization"
            ],
            "readonly": true,
            "source": {
                "line": 69,
                "path": "src/Config.luau"
            }
        },
        {
            "name": "TrackRBXScriptConnections",
            "desc": "Whether the sandbox should track `RBXScriptConnection`s.\n**Default:** `false`.\n\nIf this is enabled, the sandbox will keep track of all \n`RBXScriptConnection`s that are created in the sandbox.\nThis will allow for forcible cleanup of `RBXScriptConnection`s \nthat are created in the sandbox, but it may cause performance \nissues if there are a lot of `RBXScriptConnection`s being created.",
            "lua_type": "boolean",
            "tags": [
                "Basic",
                "Customization"
            ],
            "readonly": true,
            "source": {
                "line": 87,
                "path": "src/Config.luau"
            }
        }
    ],
    "types": [],
    "name": "Config",
    "desc": "A module for configuring various aspects of the sandbox.",
    "tags": [
        "Basic",
        "Customization"
    ],
    "source": {
        "line": 28,
        "path": "src/Config.luau"
    }
}