ScriptDocument

Requests that the editor associated with this document close. Yields the current thread until the editor responds to the request. If the function succeeds, it returns (true, nil). If the function fails, it returns (false, string) as a description of the problem.

This function can't close the command bar.

Replaces the text in the specified range from (startLine, startColumn) to (endLine, endColumn) with newText. If the range is empty, then the function inserts the text at (startLine, startColumn). If the text cursor is within the specified range, the cursor moves to the end position of the edit. Otherwise, the text cursor doesn't move. This function yields the current thread until it receives a reply from the editor about the edit.

If the function succeeds, it returns (true, nil).

The function throws an error if:

• The range is invalid.
• The range would slice one Unicode character, for example replace only some of the bytes of the unicode character.
• The newText itself contains invalid UTF-8.

If the function fails, it returns (false, string). The string is a description of the problem. The most common failure type is a version mismatch. This occurs when you try to call EditTextAsync during the time when the ScriptDocument is out of sync with the contents of the editor. If this happens, you can retry the edit.

Asks the editor to set its cursor selection to the argument values. Both anchor arguments must be passed, or neither. If neither is passed, then they each default to being the same as the corresponding cursor argument. The editor might decline to update its cursor if the text content of the document has changed. Unlike ScriptDocument:RequestSetSelectionAsync(), the editor will not decline to move its cursor if the cursor has moved since the request was made. Returns (true, nil) if the cursor was updated, and (false, string) with an explanation string if it was not. Yields the current thread until the editor replies.

Returns the text of the specified line. When no argument is provided, returns the line of the current cursor position.

Returns the number of lines in the active document.

Returns the underlying LuaSourceContainer instance, if one exists, otherwise nil.

Gets the text selected in the editor, or an empty string if there is no selection.

Returns the last known selection of the Script Editor in the format: CursorLine, CursorChar, AnchorLine, AnchorChar. If the Script Editor has no selection, CursorLine == AnchorLine and CursorChar == AnchorChar.

Gets the larger of the cursor position and anchor. If the editor has no selection, they are the same value.

Gets the smaller of the cursor position and anchor. If the editor has no selection, they are the same value.

Returns text from the open editor. Must be called with 0, 2 or 4 arguments:

• If called with 0 arguments, gets the entire contents of the open editor.
• If called with 2 arguments, gets the text of the document starting at (startLine, startColumn).
• If called with 4 arguments, gets the text of the document starting at (startLine, startColumn) and ending at (endLine, endColumn).

Returns the currently displayed line numbers in the editor change. The editor displays the lines between startLine and endLine, inclusive. The first and last line might only display partially. For example, only the topmost pixel of the last line might be on screen. Furthermore, code folding might hide lines between startLine and endLine.

Returns whether or not the editor has any text selected.

Returns true if the ScriptDocument represents the Command bar. The command bar has special rules and limitations in this API:

• Studio creates the Command bar before running plugins, so it doesn't always fire the opened event, although it does close and reopen as Studio transitions between DataModels.
• You can't edit the Command bar with EditTextAsync for security reasons.

Applies a batch of text edits to the document as a single atomic operation, then yields the current thread until it receives a reply from the editor. Each entry in the edits array is a table describing one replacement, with the same meaning as the arguments to ScriptDocument:EditTextAsync(), and the following fields:

• NewText: The replacement text.
• StartLine: The line of the start of the range to replace.
• StartCharacter: The character of the start of the range to replace.
• EndLine: The line of the end of the range to replace.
• EndCharacter: The character of the end of the range to replace.

The edits are applied together, so either all of them succeed or none of them are applied. Before applying any edit, the function validates every edit and throws an error if:

• Any range is invalid.
• Any range would slice one Unicode character, for example replace only some of the bytes of the unicode character.
• Any NewText itself contains invalid UTF-8.
• The ranges of two edits overlap.

If the function succeeds, it returns (true, nil). If the function fails, it returns (false, string), where the string describes the problem. As with ScriptDocument:EditTextAsync(), the most common failure is a version mismatch, which occurs when the ScriptDocument is momentarily out of sync with the contents of the editor; if this happens, you can retry the edits.

Asks the editor to set its cursor selection to the argument values. Both anchor arguments must be passed, or neither. If neither is passed, then they each default to being the same as the corresponding cursor argument. The editor might decline to update its cursor if the text content of the document has changed, or the cursor has moved since the request was made. Returns (true, nil) if the cursor was updated, and (false, string) with an explanation string if it was not. Yields the current thread until the editor replies.

Applies a batch of line-based text edits to the document that are presented to the user as reviewable inline diffs in the Script Editor gutter. Each entry in the changes array is a table with the following fields:

• Text: The replacement text to insert. Must be a non-empty string unless EndLine is provided.
• StartLine: The 1-indexed line number where the edit begins. If EndLine is omitted, the text is inserted before this line. If EndLine is provided, lines from StartLine through EndLine are replaced.
• EndLine: Optional. The 1-indexed last line of the range to replace (inclusive). Must be greater than or equal to StartLine.

The edits must not overlap or border each other; there must be at least one unchanged line between any two edits. Edits are applied atomically. The function throws an error if any entry has invalid fields. If the function fails due to a version mismatch or other editor-side issue, it returns (false, string).

This method cannot be used on the Command bar.

Fires when the ScriptDocument changes, including immediately after a text change.

Fires when the displayed line numbers in the editor change. See ScriptDocument.GetViewport for details.