s&box docs
API Referenceglobal

Analysisclass

Immutable editor data for one source, input and permission snapshot.

object→Analysis
Namespace
global
Assembly
Sandbox.Engine
Declaration
public sealed class Sandbox.Script.Analysis

Methods4

Showing 4 methods

public Sandbox.Script.CompletionList GetCompletions(int position)PUBLIC

Returns permitted suggestions at a UTF-16 caret offset. Accept a suggestion by replacing ReplacementSpan with its InsertText in this snapshot's source. Queries do not execute host code.

ParameterTypeDescription
positionint—
Returns:CompletionList—

public System.Nullable`1<Sandbox.Script.SignatureHelp> GetSignatureHelp(int position)PUBLIC

Returns parameter help without executing host code. Handles incomplete and nested calls.

ParameterTypeDescription
positionint—
Returns:Nullable<SignatureHelp>—

public System.Nullable`1<Sandbox.Script.Symbol> GetSymbol(int position)PUBLIC

Returns symbol information at a UTF-16 character offset without allocating.

ParameterTypeDescription
positionint—
Returns:Nullable<Symbol>—

public System.Nullable`1<Sandbox.Script.Token> GetToken(int position)PUBLIC

Returns the token covering a UTF-16 character offset, or null for whitespace or EOF.

ParameterTypeDescription
positionint—
Returns:Nullable<Token>—

Properties4

Showing 4 properties

public System.Collections.Generic.IReadOnlyList`1<Sandbox.Script.Diagnostic> Sandbox.Script.Analysis.Diagnostics { get; set; }PUBLICGETSET

Editor diagnostics. An empty list does not guarantee successful execution.

Returns:IReadOnlyList<Diagnostic>—

public System.Collections.Generic.IReadOnlyList`1<Sandbox.Script.Input> Sandbox.Script.Analysis.Inputs { get; set; }PUBLICGETSETINGEST

Host input metadata captured by this snapshot, including inputs not used by the source.

Returns:IReadOnlyList<Input>—

public string Sandbox.Script.Analysis.Source { get; set; }PUBLICGETSET

The exact source text to which all ranges refer.

Returns:string—

public System.Collections.Generic.IReadOnlyList`1<Sandbox.Script.Token> Sandbox.Script.Analysis.Tokens { get; set; }PUBLICGETSET

Lexical ranges for syntax highlighting, excluding whitespace.

Returns:IReadOnlyList<Token>—

RenderTiming

Previous Page

Diagnostics

Next Page

On this page

Methodspublic Sandbox.Script.CompletionList GetCompletions(System.Int32 position)public System.Nullable`1<Sandbox.Script.SignatureHelp> GetSignatureHelp(System.Int32 position)public System.Nullable`1<Sandbox.Script.Symbol> GetSymbol(System.Int32 position)public System.Nullable`1<Sandbox.Script.Token> GetToken(System.Int32 position)Propertiespublic System.Collections.Generic.IReadOnlyList`1<Sandbox.Script.Diagnostic> Sandbox.Script.Analysis.Diagnostics { get; set; }public System.Collections.Generic.IReadOnlyList`1<Sandbox.Script.Input> Sandbox.Script.Analysis.Inputs { get; set; }public System.String Sandbox.Script.Analysis.Source { get; set; }public System.Collections.Generic.IReadOnlyList`1<Sandbox.Script.Token> Sandbox.Script.Analysis.Tokens { get; set; }Metadata