ScriptDocument | Documentazione - Roblox Hub Creatori

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 not success then
	warn(`Impossibile aprire il documento dello script: {err}`)
	return
end

local scriptDocument = ScriptEditorService:FindScriptDocument(newScript)
-- Usa un nome di motivo unico per il tuo plugin in modo che non si sovrapponga ai motivi di altri plugin
scriptDocument:AddReadOnlyReasonsAsync({ "MyPluginReview" })
print(`{scriptDocument.Name} è di sola lettura: {scriptDocument:IsReadOnly()}`)

CloseAsync

Resa

Sicurezza Plugin

ScriptDocument:CloseAsync():Tuple

Restituzioni

Tuple

Campioni di codice

ScriptDocument:CloseAsync

--!nocheck

-- Esegui il seguente codice nella Command Bar

local ScriptEditorService = game:GetService("ScriptEditorService")

local documents = ScriptEditorService:GetScriptDocuments()
local scriptDocument
-- Trova il primo documento di script aperto
for _, document in documents do
	-- La Command Bar non può essere chiusa, quindi non selezionarla
	if not document:IsCommandBar() then
		scriptDocument = document
		break
	end
end

if scriptDocument then
	local success, err = scriptDocument:CloseAsync()
	if success then
		print(`Chiuso {scriptDocument.Name}`)
	else
		warn(`Impossibile chiudere {scriptDocument.Name} perché: {err}`)
	end
else
	print("Nessuno script aperto")
end

EditTextAsync

Resa

Sicurezza Plugin

ScriptDocument:EditTextAsync(

newText:string, startLine:number, startCharacter:number, endLine:number, endCharacter:number

):Tuple

Parametri

newText:string

startLine:number

startCharacter:number

endLine:number

endCharacter:number

Restituzioni

Tuple

ForceSetSelectionAsync

Resa

Sicurezza Plugin

ScriptDocument:ForceSetSelectionAsync(

cursorLine:number, cursorCharacter:number, anchorLine:number?, anchorCharacter:number?

):Tuple

Parametri

cursorLine:number

cursorCharacter:number

anchorLine:number?

Valore predefinito: nil

anchorCharacter:number?

Valore predefinito: nil

Restituzioni

Tuple

Campioni di codice

ScriptDocument:ForceSetSelectionAsync()

--!nocheck

-- Esegui il seguente codice nella Command Bar mentre uno script è aperto

local ScriptEditorService = game:GetService("ScriptEditorService")

local function getFirstOpenDocument()
	local documents = ScriptEditorService:GetScriptDocuments()
	for _, document in documents do
		if not document:IsCommandBar() then
			return document
		end
	end
	return nil
end

local scriptDocument = getFirstOpenDocument()

if scriptDocument then
	-- Ottieni il testo sulla riga corrente del cursore
	local cursorLine = scriptDocument:GetSelection()
	local lineText = scriptDocument:GetLine(cursorLine)
	-- Forza la selezione dell'intera riga di testo
	local success, err = scriptDocument:ForceSetSelectionAsync(cursorLine, 1, cursorLine, #lineText + 1)
	if success then
		print("Selezione impostata!")
	else
		print(`Impossibile impostare la selezione perché: {err}`)
	end
else
	print("Nessuno script aperto")
end

GetLine

Sicurezza Plugin

ScriptDocument:GetLine(lineIndex:number?):string

Parametri

lineIndex:number?

Valore predefinito: nil

Restituzioni

string

Campioni di codice

ScriptDocument.SelectionChanged e ScriptDocument:GetLine()

--!nocheck

-- Esegui il seguente codice nella Command Bar mentre uno script è aperto

local ScriptEditorService = game:GetService("ScriptEditorService")

local function getFirstOpenDocument()
	local documents = ScriptEditorService:GetScriptDocuments()
	for _, document in documents do
		if not document:IsCommandBar() then
			return document
		end
	end
	return nil
end

local scriptDocument = getFirstOpenDocument()

if scriptDocument then
	scriptDocument.SelectionChanged:Connect(function(positionLine, positionCharacter, anchorLine, anchorCharacter)
		print(`Selezionato: Linea {positionLine}, Carattere {positionCharacter}`)
		print(`Ancora: Linea {anchorLine}, Carattere {anchorCharacter}`)
		local lineText = scriptDocument:GetLine(positionLine)
		print(`Testo della linea selezionata: {lineText}`)
	end)
else
	print("Nessuno script aperto")
end

GetLineCount

Sicurezza Plugin

ScriptDocument:GetLineCount():number

Restituzioni

number

Campioni di codice

ScriptDocument:GetLineCount()

--!nocheck

-- Esegui il seguente codice nella Command Bar mentre uno script è aperto

local ScriptEditorService = game:GetService("ScriptEditorService")

local function getFirstOpenDocument()
	local documents = ScriptEditorService:GetScriptDocuments()
	for _, document in documents do
		if not document:IsCommandBar() then
			return document
		end
	end
	return nil
end

local scriptDocument = getFirstOpenDocument()

if scriptDocument then
	local lineCount = scriptDocument:GetLineCount()
	print(`Lo script ha {lineCount} righe!`)
else
	print("Nessuno script aperto")
end

GetReadOnlyReasons

Sicurezza Plugin

ScriptDocument:GetReadOnlyReasons():{string}

Restituzioni

{string}

Campioni di codice

ScriptDocument:GetReadOnlyReasons()

local ScriptEditorService = game:GetService("ScriptEditorService")

for _, document in ScriptEditorService:GetScriptDocuments() do
	local reasons = document:GetReadOnlyReasons()
	if #reasons > 0 then
		print(`{document.Name} è di sola lettura a causa di: {table.concat(reasons, ", ")}`)
	end
end

GetScript

Sicurezza Plugin

ScriptDocument:GetScript():LuaSourceContainer

Restituzioni

LuaSourceContainer

Campioni di codice

ScriptDocument:GetScript()

--!nocheck

-- Esegui il seguente codice nella Command Bar mentre uno script è aperto

local ScriptEditorService = game:GetService("ScriptEditorService")

local function getFirstOpenDocument()
	local documents = ScriptEditorService:GetScriptDocuments()
	for _, document in documents do
		if not document:IsCommandBar() then
			return document
		end
	end
	return nil
end

local scriptDocument = getFirstOpenDocument()

if scriptDocument then
	local openScript = scriptDocument:GetScript()
	print(`Script attualmente aperto: {openScript:GetFullName()}`)
else
	print("Nessuno script aperto")
end

GetSelectedText

Sicurezza Plugin

ScriptDocument:GetSelectedText():string

Restituzioni

string

Campioni di codice

ScriptDocument:HasSelectedText() e :GetSelectedText()

--!nocheck

-- Esegui il seguente codice nella Command Bar mentre uno script è aperto

local ScriptEditorService = game:GetService("ScriptEditorService")

local function getFirstOpenDocument()
	local documents = ScriptEditorService:GetScriptDocuments()
	for _, document in documents do
		if not document:IsCommandBar() then
			return document
		end
	end
	return nil
end

local scriptDocument = getFirstOpenDocument()

if scriptDocument then
	scriptDocument.SelectionChanged:Connect(function()
		if scriptDocument:HasSelectedText() then
			local selectedText = scriptDocument:GetSelectedText()
			print(`Testo attualmente selezionato: {selectedText}`)
		else
			print("Nessun testo attualmente selezionato")
		end
	end)
else
	print("Nessuno script aperto")
end

GetSelection

Sicurezza Plugin

ScriptDocument:GetSelection():Tuple

Restituzioni

Tuple

GetSelectionEnd

Sicurezza Plugin

ScriptDocument:GetSelectionEnd():Tuple

Restituzioni

Tuple

Campioni di codice

ScriptDocument:GetSelectionStart() e :GetSelectionEnd()

--!nocheck

-- Esegui il seguente codice nella Command Bar mentre uno script è aperto

local ScriptEditorService = game:GetService("ScriptEditorService")

local function getFirstOpenDocument()
	local documents = ScriptEditorService:GetScriptDocuments()
	for _, document in documents do
		if not document:IsCommandBar() then
			return document
		end
	end
	return nil
end

local scriptDocument = getFirstOpenDocument()

if scriptDocument then
	local startLine, startCharacter = scriptDocument:GetSelectionStart()
	local endLine, endCharacter = scriptDocument:GetSelectionEnd()
	print(`Inizio selezione: Riga {startLine}, Carattere {startCharacter}`)
	print(`Fine selezione: Riga {endLine}, Carattere {endCharacter}`)
else
	print("Nessuno script aperto")
end

GetSelectionStart

Sicurezza Plugin

ScriptDocument:GetSelectionStart():Tuple

Restituzioni

Tuple

Campioni di codice

ScriptDocument:GetSelectionStart() e :GetSelectionEnd()

--!nocheck

-- Esegui il seguente codice nella Command Bar mentre uno script è aperto

local ScriptEditorService = game:GetService("ScriptEditorService")

local function getFirstOpenDocument()
	local documents = ScriptEditorService:GetScriptDocuments()
	for _, document in documents do
		if not document:IsCommandBar() then
			return document
		end
	end
	return nil
end

local scriptDocument = getFirstOpenDocument()

if scriptDocument then
	local startLine, startCharacter = scriptDocument:GetSelectionStart()
	local endLine, endCharacter = scriptDocument:GetSelectionEnd()
	print(`Inizio selezione: Riga {startLine}, Carattere {startCharacter}`)
	print(`Fine selezione: Riga {endLine}, Carattere {endCharacter}`)
else
	print("Nessuno script aperto")
end

GetText

Sicurezza Plugin

ScriptDocument:GetText(

startLine:number?, startCharacter:number?, endLine:number?, endCharacter:number?

):string

Parametri

startLine:number?

Valore predefinito: nil

startCharacter:number?

Valore predefinito: nil

endLine:number?

Valore predefinito: nil

endCharacter:number?

Valore predefinito: nil

Restituzioni

string

Campioni di codice

ScriptDocument:GetText()

--!nocheck

-- Esegui il seguente codice nella Command Bar mentre uno script è aperto

local ScriptEditorService = game:GetService("ScriptEditorService")

local function getFirstOpenDocument()
	local documents = ScriptEditorService:GetScriptDocuments()
	for _, document in documents do
		if not document:IsCommandBar() then
			return document
		end
	end
	return nil
end

local scriptDocument = getFirstOpenDocument()

if scriptDocument then
	local text = scriptDocument:GetText()
	print(`Contenuti dello script: {text}`)
else
	print("Nessuno script aperto")
end

GetViewport

Sicurezza Plugin

ScriptDocument:GetViewport():Tuple

Restituzioni

Tuple

Campioni di codice

ScriptDocument:GetViewport

--!nocheck

-- Esegui il seguente codice nella Command Bar mentre uno script è aperto

local ScriptEditorService = game:GetService("ScriptEditorService")

local function getFirstOpenDocument()
	local documents = ScriptEditorService:GetScriptDocuments()
	for _, document in documents do
		if not document:IsCommandBar() then
			return document
		end
	end
	return nil
end

local scriptDocument = getFirstOpenDocument()

if scriptDocument then
	local firstLine, lastLine = scriptDocument:GetViewport()
	print(`Attualmente visualizzando le righe {firstLine} a {lastLine}`)
else
	print("Nessuno script aperto")
end

HasSelectedText

Sicurezza Plugin

ScriptDocument:HasSelectedText():boolean

Restituzioni

boolean

Campioni di codice

ScriptDocument:HasSelectedText() e :GetSelectedText()

--!nocheck

-- Esegui il seguente codice nella Command Bar mentre uno script è aperto

local ScriptEditorService = game:GetService("ScriptEditorService")

local function getFirstOpenDocument()
	local documents = ScriptEditorService:GetScriptDocuments()
	for _, document in documents do
		if not document:IsCommandBar() then
			return document
		end
	end
	return nil
end

local scriptDocument = getFirstOpenDocument()

if scriptDocument then
	scriptDocument.SelectionChanged:Connect(function()
		if scriptDocument:HasSelectedText() then
			local selectedText = scriptDocument:GetSelectedText()
			print(`Testo attualmente selezionato: {selectedText}`)
		else
			print("Nessun testo attualmente selezionato")
		end
	end)
else
	print("Nessuno script aperto")
end

IsCommandBar

Sicurezza Plugin

ScriptDocument:IsCommandBar():boolean

Restituzioni

boolean

Campioni di codice

ScriptDocument:IsCommandBar()

--!nocheck

-- Esegui il seguente codice nella Command Bar

local ScriptEditorService = game:GetService("ScriptEditorService")

local documents = ScriptEditorService:GetScriptDocuments()

for _, document in documents do
	if document:IsCommandBar() then
		print("Documento della barra dei comandi:", document)
	end
end

IsReadOnly

Sicurezza Plugin

ScriptDocument:IsReadOnly():boolean

Restituzioni

boolean

Campioni di codice

ScriptDocument:IsReadOnly()

local ScriptEditorService = game:GetService("ScriptEditorService")

for _, document in ScriptEditorService:GetScriptDocuments() do
	if document:ÈSolaLettura() then
		print(`{document.Name} è in sola lettura`)
	else
		print(`{document.Name} è modificabile`)
	end
end

MultiEditTextAsync

Resa

Sicurezza Plugin

ScriptDocument:MultiEditTextAsync(edits:{any}):Tuple

Parametri

edits:{any}

Restituzioni

Tuple

RemoveReadOnlyReasonsAsync

Resa

Sicurezza Plugin

ScriptDocument:RemoveReadOnlyReasonsAsync(reasons:{any}):()

Parametri

reasons:{any}

Restituzioni

()

Campioni di codice

ScriptDocument:RemoveReadOnlyReasonsAsync()

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 not success then
	warn(`Impossibile aprire il documento dello script: {err}`)
	return
end

local scriptDocument = ScriptEditorService:FindScriptDocument(newScript)
scriptDocument:AddReadOnlyReasonsAsync({ "MyPluginReview", "MyPluginLocked" })

-- L'editor rimane in sola lettura mentre qualsiasi altro motivo rimane attivo
scriptDocument:RemoveReadOnlyReasonsAsync({ "MyPluginReview" })
print(`Sola lettura dopo aver rimosso un motivo: {scriptDocument:IsReadOnly()}`)

scriptDocument:RemoveReadOnlyReasonsAsync({ "MyPluginLocked" })
print(`Sola lettura dopo aver rimosso tutti i motivi: {scriptDocument:IsReadOnly()}`)

RequestSetSelectionAsync

Resa

Sicurezza Plugin

ScriptDocument:RequestSetSelectionAsync(

cursorLine:number, cursorCharacter:number, anchorLine:number?, anchorCharacter:number?

):Tuple

Parametri

cursorLine:number

cursorCharacter:number

anchorLine:number?

Valore predefinito: nil

anchorCharacter:number?

Valore predefinito: nil

Restituzioni

Tuple

Campioni di codice

ScriptDocument:RequestSetSelectionAsync()

--!nocheck

-- Esegui il seguente codice nella Command Bar mentre uno script è aperto

local ScriptEditorService = game:GetService("ScriptEditorService")

local function getFirstOpenDocument()
	local documents = ScriptEditorService:GetScriptDocuments()
	for _, document in documents do
		if not document:IsCommandBar() then
			return document
		end
	end
	return nil
end

local scriptDocument = getFirstOpenDocument()

if scriptDocument then
	-- Ottieni il testo sulla riga corrente del cursore
	local cursorLine = scriptDocument:GetSelection()
	local lineText = scriptDocument:GetLine(cursorLine)
	-- Forza la selezione dell'intera riga di testo
	local success, err = scriptDocument:RequestSetSelectionAsync(cursorLine, 1, cursorLine, #lineText + 1)
	if success then
		print("Selezione impostata!")
	else
		print(`Impossibile impostare la selezione perché: {err}`)
	end
else
	print("Nessuno script aperto")
end

ReviewableTextEditsAsync

Resa

Sicurezza Plugin

ScriptDocument:ReviewableTextEditsAsync(changes:{any}):Tuple

Parametri

changes:{any}

Restituzioni

Tuple

Eventi

SelectionChanged

Sicurezza Plugin

ScriptDocument.SelectionChanged(

positionLine:number, positionCharacter:number, anchorLine:number, anchorCharacter:number

):RBXScriptSignal

Parametri

positionLine:number

positionCharacter:number

anchorLine:number

anchorCharacter:number

Campioni di codice

ScriptDocument.SelectionChanged e ScriptDocument:GetLine()

--!nocheck

-- Esegui il seguente codice nella Command Bar mentre uno script è aperto

local ScriptEditorService = game:GetService("ScriptEditorService")

local function getFirstOpenDocument()
	local documents = ScriptEditorService:GetScriptDocuments()
	for _, document in documents do
		if not document:IsCommandBar() then
			return document
		end
	end
	return nil
end

local scriptDocument = getFirstOpenDocument()

if scriptDocument then
	scriptDocument.SelectionChanged:Connect(function(positionLine, positionCharacter, anchorLine, anchorCharacter)
		print(`Selezionato: Linea {positionLine}, Carattere {positionCharacter}`)
		print(`Ancora: Linea {anchorLine}, Carattere {anchorCharacter}`)
		local lineText = scriptDocument:GetLine(positionLine)
		print(`Testo della linea selezionata: {lineText}`)
	end)
else
	print("Nessuno script aperto")
end

ViewportChanged

Sicurezza Plugin

ScriptDocument.ViewportChanged(

startLine:number, endLine:number

):RBXScriptSignal

Parametri

startLine:number

endLine:number

Campioni di codice

Collegamento a ScriptDocument.ViewportChanged

--!nocheck

--[[
	Per eseguire:
		1. Assicurati che la vista Output sia aperta
		2. Esegui il codice qui sotto nella Command Bar
		3. Scorri su e giù nella finestra dello Script aperta

	Le istruzioni di stampa dall'evento ViewportChanged appariranno nell'Output
]]

local Workspace = game:GetService("Workspace")
local ScriptEditorService = game:GetService("ScriptEditorService")

-- Crea un testo che si estende su più righe
local dummyText = string.rep("-- Dummy Text\n", 60)

-- Crea uno script contenente il testo fittizio e aprilo
local otherScript = Instance.new("Script")
otherScript.Source = dummyText
otherScript.Parent = Workspace
local success, err = ScriptEditorService:OpenScriptDocumentAsync(otherScript)
if not success then
	warn(`Impossibile aprire lo script perché: {err}`)
	return
end

-- Ottieni un riferimento allo script aperto
local scriptDocument = ScriptEditorService:FindScriptDocument(otherScript)

local function onViewportChanged(startLine: number, endLine: number)
	print(`Viewport dello Script Cambiato - startLine: {startLine}, endLine: {endLine}`)
end
-- Collega l'evento ViewportChanged alla funzione sopra che stampa la linea di inizio e fine del viewport aggiornato
scriptDocument.ViewportChanged:Connect(onViewportChanged)