16 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

ScriptEditorService

Inherits from: Instance → Object

This service is used for interacting with ScriptDocument instances. It provides methods to open, find, and list script documents that represent scripts currently open in the Studio Script Editor. It also enables plugins to register custom callbacks for autocomplete and script analysis, and fires events when script documents are opened, closed, or changed.

This service is only available in Studio plugins and the command bar (Plugin security level).

Inherits from: Instance

Memory category: Instances

Tags: NotCreatable, Service, NotReplicated

Methods

Inherited from Instance

Inherited from Object

ScriptEditorService:DeregisterAutocompleteCallback

Removes a previously registered autocomplete callback with the name name. The callback must have been registered with ScriptEditorService:RegisterAutocompleteCallback(). Throws an error if no callback with the given name is currently registered.

Parameters

Returns

Code samples: View on Creator Hub (ScriptEditorService-DeregisterAutocompleteCallback).

ScriptEditorService:DeregisterScriptAnalysisCallback

Removes a previously registered Script Analysis callback with the name name. The callback must have been registered with ScriptEditorService:RegisterScriptAnalysisCallback(). Throws an error if no callback with the given name is currently registered.

After the callback is removed, Script Analysis automatically reruns on all open scripts to update diagnostics.

Parameters

Returns

Code samples: View on Creator Hub (ScriptEditorService-DeregisterScriptAnalysisCallback).

ScriptEditorService:FindScriptDocument

Returns the open ScriptDocument corresponding to the given LuaSourceContainer, or nil if the given script is not open.

A ScriptDocument only exists while the script has an open tab in the Script Editor. If the script's editor tab is closed, this method returns nil even if the script instance still exists in the DataModel.

Parameters

Returns

Code samples: View on Creator Hub (ScriptDocument-CloseAsync, ScriptDocument-ViewportChanged).

ScriptEditorService:GetEditorSource

Returns the edit-time source for the given script.

If the script is open in the Script Editor, this method returns the text currently being displayed in the editor. If the script is not open in the editor, the method returns the text that the editor would display if it's opened. The edit-time source is not always be consistent with the Script.Source property.

Parameters

Returns

ScriptEditorService:GetScriptDocuments

Returns an array of the currently open script documents, including the command bar. Each entry is a ScriptDocument representing one open editor tab. The command bar's document can be identified with ScriptDocument:IsCommandBar() if you need to exclude it.

Returns

Code samples: View on Creator Hub (ScriptEditorService-GetScriptDocuments).

ScriptEditorService:OpenScriptDocumentAsync

Requests that a Script Editor open the specified script. Returns (true, nil) if the request succeeds. Returns (false, string) if the request fails, with a string that describes the problem.

If the script is already open, this function succeeds and switches tabs to the associated editor.

Parameters

Returns

Code samples: View on Creator Hub (ScriptEditorService-OpenScriptDocumentAsync).

ScriptEditorService:RegisterAutocompleteCallback

Registers an autocomplete callback callbackFunction named name with priority priority.

When the Script Editor invokes autocomplete, all registered autocomplete callbacks call in order of ascending priority with the autocomplete request and response. Multiple callbacks may share a priority, but then their calling order is unpredictable. Each callback is intended to return a response table with the same format as the response input table. Callbacks shouldn't yield. The first callback invoked receives the internal autocomplete's response as its response table, and subsequent callbacks receive the previous callback's output as their response table. Callbacks may either modify the passed table or return a new table of the same format.

The callbackFunction must have the following type: (Request: table, Response: table) -> table

The Request table has the following format:

type Request = {
  position: {
    line: number,
    character: number
  },
  textDocument: {
    document: ScriptDocument?,
    script: LuaSourceContainer?
  }
}

• position is the one-indexed cursor position where you are autocompleting.
• textDocument.document is the open ScriptDocument you are completing in, if it exists.
• textDocument.script is the LuaSourceContainer you are completing in, if it exists.

If both textDocument.document and textDocument.script are present, then they correspond to each other: req.textDocument.document:GetScript() == req.textDocument.script

The Response table has the following format:

type Response = {
  items: {
    {
      label: string, -- The label
      kind: Enum.CompletionItemKind?,
      tags: {Enum.CompletionItemTag}?,
      detail: string?,
      documentation: {
        value: string,
      }?,
      overloads: number?,
      learnMoreLink: string?,
      codeSample: string?,
      preselect: boolean?,
      textEdit: {
        newText: string,
        insert: { start: { line: number, character: number }, ["end"]: { line: number, character: number } },
        replace: { start: { line: number, character: number }, ["end"]: { line: number, character: number } },
      }?
    }
  }
}

• Response.items is an array of the completion items. The order of this array is insignificant, and it resorts in the editor as the user types.
• Response.items[n].label is the label of the item which display in the autocomplete menu.
• Response.items[n].kind specifies what type of autocomplete item this is. Primarily this controls the icon given to the item in the editor. Not all kinds have a unique icon. If not specified, the editor uses the "Text" icon. Unsupported kinds default to displaying the "Property" icon.
• Response.items[n].tags specifies an array of tags describing this completion item. See the CompletionItemTag for details on their function.
• Response.items[n].details specifies a string describing details about the completion item. For default items, this is a string representation of their type. Note that, in order for the documentation widget to display, documentation must be present, but documentation.value may be empty.
• Response.items[n].documentation specifies the main body of the documentation in its value field. documentation is present, even if value is empty, so the documentation window displays if either details or overloads are specified.
• Response.items[n].overloads specifies the number of overloads of a function autocompletion.
• Response.items[n].learnMoreLink links to a relevant page on the creator docs. This URL must be a https request to create.roblox.com; no other URLs display in the editor.
• Response.items[n].codeSample specifies a sample use of the completion item. documentation must be non-empty to display this field.
• Response.items[n].preselect If true, the editor sorts this completion item ahead of all others and selects it for the user by default. No effect if false or missing.
• Response.items[n].textEdit If present, accepting the completion applies this text edit - inserting or replacing the span between the positions start and end with newText.

If a callback returns a malformed result or encounters an error, the editor discards the modified Response table and uses the built-in autocomplete result list.

Parameters

Returns

Code samples: View on Creator Hub (ScriptEditorService-RegisterAutocompleteCallback).

ScriptEditorService:RegisterScriptAnalysisCallback

Registers a Script Analysis callback callbackFunction named name with priority. When Script Analysis in Studio runs, all registered callbacks call in order of ascending priority. Each callback is intended to return a response table matching the format specified below. Callbacks should not yield.

The request table has the following format, where script is the LuaSourceContainer that is going to be analyzed.

type Request = {
  script: LuaSourceContainer?
}

The response table has the following format, where diagnostics is an array of diagnostic tables. Each diagnostic table has the entries listed below.

type Response = {
  diagnostics: {
    {
      range: {
        start: {
          line: number,
          character: number,
        },
        ["end"]: {
          line: number,
          character: number,
        }
      },
      code: string?,
      message: string,
      severity: Enum.Severity?,
      codeDescription: { href: string }?
    }
  }
}

• range represents a text range that should be highlighted by the linter, providing what line/character to start highlighting and what line/character to stop highlighting.
• code is a label for the message.
• message is a warning message to be displayed for the line. This will also appear on a tooltip when the user hovers their cursor over the line in the Script Editor.
• severity is a Severity value for the diagnostics. This determines how the diagnostic is categorized in the Script Analysis tool in Studio, as well as how text is highlighted in the Script Editor.
• codeDescription links to a relevant page on the creator docs. This URL must be an https request to create.roblox.com; no other URLs display in the editor.

Parameters

Returns

Code samples: View on Creator Hub (ScriptEditorService-RegisterScriptAnalysisCallback).

ScriptEditorService:UpdateSourceAsync

Returns the edit-time Script.Source for the given script.

This function calls the passed callback using the old contents of the script to calculate the new contents of the script.

If the script is open in the Script Editor, then it issues a request to the editor to update its source. The editor may reject this update if the Script.Source property was out of date with the user's version of the script when this function was called, in which case the callback will be re-invoked and the attempt will be repeated.

The callback may not yield. If the callback returns nil, the operation is cancelled. This function yields until the operation is cancelled or succeeds.

If the script is not open in the editor, the new content updates to the script source, which is the text the editor would display if it is opened.

Parameters

Returns

Code samples: View on Creator Hub (ScriptEditorService-UpdateSourceAsync).

Events

Inherited from Instance

Inherited from Object

ScriptEditorService.TextDocumentDidChange

Fires just after a ScriptDocument changes. The textChanged is an array of change structures of the format:

{ range : { start : { line : number, character : number }, end : { line : number, character : number } }, text: string }

Parameters

Code samples: View on Creator Hub (ScriptEditorService-TextDocumentDidChange).

ScriptEditorService.TextDocumentDidClose

Fires just before a ScriptDocument object is destroyed, which happens right after the script editor closes. After this event fires, the ScriptDocument enters a "Closed" state, and trying to call its methods throws an error. ScriptDocument objects aren't reusable, even if the script editor reopens the same script.

Parameters

Code samples: View on Creator Hub (ScriptEditorService-TextDocumentDidClose).

ScriptEditorService.TextDocumentDidOpen

Fires just after a ScriptDocument object is created and parented to the service, which happens right after the script editor opens. The ScriptDocument passed to the handler is fully initialized and ready to read or modify. This event also fires for the command bar document.

Parameters

Code samples: View on Creator Hub (ScriptEditorService-TextDocumentDidOpen).

Properties

Inherited from Instance

Inherited from Object