Classe do mecanismo
ScriptEditorService
*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.
Resumo
Métodos
DeregisterAutocompleteCallback(name: string):() |
DeregisterScriptAnalysisCallback(name: string):() |
GetEditorSource(script: LuaSourceContainer):string |
OpenScriptDocumentAsync(script: LuaSourceContainer,options: Dictionary):Tuple |
RegisterAutocompleteCallback(name: string,priority: number,callbackFunction: function):() |
RegisterScriptAnalysisCallback(name: string,priority: number,callbackFunction: function):() |
UpdateSourceAsync(script: LuaSourceContainer,callback: function):() |
Eventos
TextDocumentDidChange(document: ScriptDocument,changesArray: Variant):RBXScriptSignal |
TextDocumentDidClose(oldDocument: ScriptDocument):RBXScriptSignal |
TextDocumentDidOpen(newDocument: ScriptDocument):RBXScriptSignal |
Referência API
Métodos
DeregisterAutocompleteCallback
Parâmetros
Devolução
()
Amostras de código
DeregisterAutocompleteCallback()
local ScriptEditorService = game:GetService("ScriptEditorService")
-- Cancelar a callback de autocompletar
ScriptEditorService:DeregisterAutocompleteCallback("foo")DeregisterScriptAnalysisCallback
FindScriptDocument
Parâmetros
Devolução
Amostras de código
ScriptDocument:FecharAsync
--!nocheck
-- Execute o seguinte código na Barra de Comando
local ScriptEditorService = game:GetService("ScriptEditorService")
local documents = ScriptEditorService:GetScriptDocuments()
local scriptDocument
-- Encontre o primeiro documento de script aberto
for _, document in documents do
-- A Barra de Comando não pode ser fechada, então não a selecione
if not document:IsCommandBar() then
scriptDocument = document
break
end
end
if scriptDocument then
local success, err = scriptDocument:CloseAsync()
if success then
print(`Fechado {scriptDocument.Name}`)
else
warn(`Falha ao fechar {scriptDocument.Name} porque: {err}`)
end
else
print("Nenhum script aberto")
endConectando ao ScriptDocument.ViewportChanged
--!nocheck
--[[
Para executar:
1. Certifique-se de que a visualização Output está aberta
2. Execute o código abaixo na Command Bar
3. Role para cima e para baixo na janela de Script aberta
As declarações de impressão do evento ViewportChanged aparecerão na saída
]]
local Workspace = game:GetService("Workspace")
local ScriptEditorService = game:GetService("ScriptEditorService")
-- Crie um texto que abranja muitas linhas
local dummyText = string.rep("-- Dummy Text\n", 60)
-- Crie um script contendo o texto dummy e abra-o
local otherScript = Instance.new("Script")
otherScript.Source = dummyText
otherScript.Parent = Workspace
local success, err = ScriptEditorService:OpenScriptDocumentAsync(otherScript)
if not success then
warn(`Falha ao abrir o script porque: {err}`)
return
end
-- Obtenha uma referência ao script aberto
local scriptDocument = ScriptEditorService:FindScriptDocument(otherScript)
local function onViewportChanged(startLine: number, endLine: number)
print(`Viewport do Script Alterado - startLine: {startLine}, endLine: {endLine}`)
end
-- Conecte o evento ViewportChanged à função acima que imprime a linha inicial e a linha final da viewport atualizada
scriptDocument.ViewportChanged:Connect(onViewportChanged)GetEditorSource
Parâmetros
Devolução
GetScriptDocuments
Devolução
Amostras de código
Imprima o nome de todos os scripts
--!nocheck
-- Execute o seguinte código na Barra de Comando
local ScriptEditorService = game:GetService("ScriptEditorService")
local scriptDocuments = ScriptEditorService:GetScriptDocuments()
for _, scriptDocument in scriptDocuments do
-- Imprime o nome de cada script
if not scriptDocument:IsCommandBar() then
print(scriptDocument.Name)
end
endOpenScriptDocumentAsync
Parâmetros
| Valor Padrão: "nil" |
Devolução
Amostras de código
AbrirScriptDocumentoAssíncrono()
--!nocheck
-- Execute o seguinte código na Barra de Comando
local ScriptEditorService = game:GetService("ScriptEditorService")
local Workspace = game:GetService("Workspace")
local newScript = Instance.new("Script")
newScript.Parent = Workspace
local success, err = ScriptEditorService:OpenScriptDocumentAsync(newScript)
if success then
print("Documento de script aberto")
else
print(`Falha ao abrir o documento de script: {err}`)
endRegisterAutocompleteCallback
Devolução
()
Amostras de código
RegistrarCallbackDeAutocomplete() e DesregistrarCallbackDeAutocomplete()
--!nocheck
-- Execute o seguinte código na Barra de Comando
local ScriptEditorService = game:GetService("ScriptEditorService")
type Request = {
position: {
line: number,
character: number,
},
textDocument: {
document: ScriptDocument?,
script: LuaSourceContainer?,
},
}
type Response = {
items: {
{
label: string,
kind: Enum.CompletionItemKind?,
tags: { Enum.CompletionItemTag }?,
detail: string?,
documentation: {
value: string,
}?,
overloads: number?,
learnMoreLink: string?,
codeSample: string?,
preselect: boolean?,
textEdit: {
newText: string,
replace: {
start: { line: number, character: number },
["end"]: { line: number, character: number },
},
}?,
}
},
}
local autocompleteCallback = function(request: Request, response: Response): Response
local item = {
label = "foo",
preselect = true,
}
table.insert(response.items, item)
return response
end
ScriptEditorService:RegisterAutocompleteCallback("foo", 1, autocompleteCallback)
-- Para desregistrar o callback, execute o seguinte código na Barra de Comando
ScriptEditorService:DeregisterAutocompleteCallback("foo")RegisterScriptAnalysisCallback
Devolução
()
Amostras de código
RegistrarAnáliseDeScript()
type Request = {
["script"]: LuaSourceContainer,
}
type Response = {
diagnostics: {
{
range: {
start: {
line: number,
character: number,
},
["end"]: {
line: number,
character: number,
},
},
code: string?,
message: string,
severity: Enum.Severity?,
codeDescription: { href: string }?,
}
},
}
local ScriptEditorService = game:GetService("ScriptEditorService")
ScriptEditorService:RegisterScriptAnalysisCallback("foo", 1, function(Req: Request): Response
local response = {
diagnostics = {},
}
local lineNo = 1
-- Iterar linha por linha
for text, newline in Req.script.Source:gmatch("([^\r\n]*)([\r\n]*)") do
local startIndex, endIndex = string.find(text, "Foo")
if startIndex and endIndex then
table.insert(response.diagnostics, {
range = {
["start"] = {
line = lineNo,
character = startIndex,
},
["end"] = {
line = lineNo,
character = endIndex,
},
},
code = "FooFinder",
message = "Foo encontrado aqui!",
severity = Enum.Severity.Warning,
})
end
lineNo = lineNo + #newline:gsub("\n+", "\0%0\0"):gsub(".%z.", "."):gsub("%z", "")
end
return response
end)UpdateSourceAsync
Parâmetros
Devolução
()
Eventos
TextDocumentDidChange
ScriptEditorService.TextDocumentDidChange(
Parâmetros
changesArray:Variant |
Amostras de código
ScriptEditorService.TextDocumentDidChange
--!nocheck
-- Execute o código a seguir na Barra de Comando
local ScriptEditorService = game:GetService("ScriptEditorService")
ScriptEditorService.TextDocumentDidChange:Connect(function(scriptDocument, changes)
print("Alterado", scriptDocument, changes)
end)TextDocumentDidClose
Parâmetros
Amostras de código
ScriptEditorService.TextDocumentDidClose
--!nocheck
-- Execute o seguinte código na Barra de Comando
local ScriptEditorService = game:GetService("ScriptEditorService")
ScriptEditorService.TextDocumentDidClose:Connect(function(scriptDocument)
print("Fechado", scriptDocument)
end)TextDocumentDidOpen
Parâmetros
Amostras de código
ScriptEditorService.TextDocumentDidOpen
--!nocheck
-- Execute o seguinte código na Barra de Comando
local ScriptEditorService = game:GetService("ScriptEditorService")
ScriptEditorService.TextDocumentDidOpen:Connect(function(scriptDocument)
print("Aberto", scriptDocument)
end)