Reference API Roblox

Engine API

Website

Related

Reference API Roblox

RunContext

Controls the execution context of a Script, determining whether it runs as server, client, plugin, or legacy container-based code.

Items 4

HistoryNameValueDescription
534Legacy0

Runs with legacy container-based behavior that depends on the script type, such as LocalScript or Script.

534Server1

Runs on the server.

534Client2

Runs on the client.

534Plugin3

Runs as a descendant of Plugin instances.

Description

The RunContext enum is used with the BaseScript.RunContext property to specify the context in which a Script executes. The default value is RunContext.Legacy, which preserves the original container-based behavior where a Script runs on the server and a LocalScript runs on the client depending on its placement in the instance hierarchy.

Setting a non-Legacy value allows a Script to run explicitly on the server, client, or as plugin code, regardless of container placement. LocalScript objects cannot use this property — only Script objects support non-Legacy run contexts.

Changing this property while the script is running terminates any active threads and restarts the script under the new context if conditions permit.

History 5

Settings