ScriptDocument | Documentation - Hub Création Roblox

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(`Échec de l'ouverture du document de script : {err}`)
	return
end

local scriptDocument = ScriptEditorService:FindScriptDocument(newScript)
-- Utilisez un nom de raison unique à votre plugin afin qu'il ne soit pas en conflit avec les raisons d'autres plugins
scriptDocument:AddReadOnlyReasonsAsync({ "MyPluginReview" })
print(`{scriptDocument.Name} est en lecture seule : {scriptDocument:IsReadOnly()}`)

CloseAsync

Rendement

Sécurité des plugins

ScriptDocument:CloseAsync():Tuple

Retours

Tuple

Échantillons de code

ScriptDocument:CloseAsync

--!nocheck

-- Exécutez le code suivant dans la barre de commandes

local ScriptEditorService = game:GetService("ScriptEditorService")

local documents = ScriptEditorService:GetScriptDocuments()
local scriptDocument
-- Trouvez le premier document de script ouvert
for _, document in documents do
	-- La barre de commandes ne peut pas être fermée, donc ne la sélectionnez pas
	if not document:IsCommandBar() then
		scriptDocument = document
		break
	end
end

if scriptDocument then
	local success, err = scriptDocument:CloseAsync()
	if success then
		print(`Fermé {scriptDocument.Name}`)
	else
		warn(`Échec de la fermeture de {scriptDocument.Name} parce que : {err}`)
	end
else
	print("Aucun script ouvert")
end

EditTextAsync

Rendement

Sécurité des plugins

ScriptDocument:EditTextAsync(

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

):Tuple

Paramètres

newText:string

startLine:number

startCharacter:number

endLine:number

endCharacter:number

Retours

Tuple

ForceSetSelectionAsync

Rendement

Sécurité des plugins

ScriptDocument:ForceSetSelectionAsync(

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

):Tuple

Paramètres

cursorLine:number

cursorCharacter:number

anchorLine:number?

Valeur par défaut : nil

anchorCharacter:number?

Valeur par défaut : nil

Retours

Tuple

Échantillons de code

ScriptDocument:ForceSetSelectionAsync()

--!nocheck

-- Exécutez le code suivant dans la barre de commandes pendant qu'un script est ouvert

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
	-- Obtenez le texte de la ligne actuelle du curseur
	local cursorLine = scriptDocument:GetSelection()
	local lineText = scriptDocument:GetLine(cursorLine)
	-- Sélectionnez toute la ligne de texte
	local success, err = scriptDocument:ForceSetSelectionAsync(cursorLine, 1, cursorLine, #lineText + 1)
	if success then
		print("Sélection définie !")
	else
		print(`Échec de la définition de la sélection en raison de : {err}`)
	end
else
	print("Aucun script ouvert")
end

GetLine

Sécurité des plugins

ScriptDocument:GetLine(lineIndex:number?):string

Paramètres

lineIndex:number?

Valeur par défaut : nil

Retours

string

Échantillons de code

ScriptDocument.SelectionChanged et ScriptDocument:GetLine()

--!nocheck

-- Exécutez le code suivant dans la barre de commandes pendant qu'un script est ouvert

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(`Sélectionné : Ligne {positionLine}, Char {positionCharacter}`)
		print(`Ancre : Ligne {anchorLine}, Char {anchorCharacter}`)
		local lineText = scriptDocument:GetLine(positionLine)
		print(`Texte de la ligne sélectionnée : {lineText}`)
	end)
else
	print("Aucun script ouvert")
end

GetLineCount

Sécurité des plugins

ScriptDocument:GetLineCount():number

Retours

number

Échantillons de code

ScriptDocument:GetLineCount()

--!nocheck

-- Exécutez le code suivant dans la barre de commandes pendant qu'un script est ouvert

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(`Le script a {lineCount} lignes !`)
else
	print("Aucun script ouvert")
end

GetReadOnlyReasons

Sécurité des plugins

ScriptDocument:GetReadOnlyReasons():{string}

Retours

{string}

Échantillons de code

ScriptDocument:GetReadOnlyReasons()

local ScriptEditorService = game:GetService("ScriptEditorService")

for _, document in ScriptEditorService:GetScriptDocuments() do
	local reasons = document:GetReadOnlyReasons()
	if #reasons > 0 then
		print(`{document.Name} est en lecture seule à cause de : {table.concat(reasons, ", ")}`)
	end
end

GetScript

Sécurité des plugins

ScriptDocument:GetScript():LuaSourceContainer

Retours

LuaSourceContainer

Échantillons de code

ScriptDocument:GetScript()

--!nocheck

-- Exécutez le code suivant dans la barre de commandes pendant qu'un script est ouvert

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 actuellement ouvert : {openScript:GetFullName()}`)
else
	print("Aucun script ouvert")
end

GetSelectedText

Sécurité des plugins

ScriptDocument:GetSelectedText():string

Retours

string

Échantillons de code

ScriptDocument:HasSelectedText() et :GetSelectedText()

--!nocheck

-- Exécutez le code suivant dans la barre de commandes pendant qu'un script est ouvert

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(`Texte actuellement sélectionné : {selectedText}`)
		else
			print("Aucun texte actuellement sélectionné")
		end
	end)
else
	print("Aucun script ouvert")
end

GetSelection

Sécurité des plugins

ScriptDocument:GetSelection():Tuple

Retours

Tuple

GetSelectionEnd

Sécurité des plugins

ScriptDocument:GetSelectionEnd():Tuple

Retours

Tuple

Échantillons de code

ScriptDocument:GetSelectionStart() et :GetSelectionEnd()

--!nocheck

-- Exécutez le code suivant dans la barre de commandes pendant qu'un script est ouvert

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(`Début de la sélection : Ligne {startLine}, Char {startCharacter}`)
	print(`Fin de la sélection : Ligne {endLine}, Char {endCharacter}`)
else
	print("Aucun script ouvert")
end

GetSelectionStart

Sécurité des plugins

ScriptDocument:GetSelectionStart():Tuple

Retours

Tuple

Échantillons de code

ScriptDocument:GetSelectionStart() et :GetSelectionEnd()

--!nocheck

-- Exécutez le code suivant dans la barre de commandes pendant qu'un script est ouvert

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(`Début de la sélection : Ligne {startLine}, Char {startCharacter}`)
	print(`Fin de la sélection : Ligne {endLine}, Char {endCharacter}`)
else
	print("Aucun script ouvert")
end

GetText

Sécurité des plugins

ScriptDocument:GetText(

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

):string

Paramètres

startLine:number?

Valeur par défaut : nil

startCharacter:number?

Valeur par défaut : nil

endLine:number?

Valeur par défaut : nil

endCharacter:number?

Valeur par défaut : nil

Retours

string

Échantillons de code

ScriptDocument:GetText()

--!nocheck

-- Exécutez le code suivant dans la barre de commandes pendant qu'un script est ouvert

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(`Contenu du script : {text}`)
else
	print("Aucun script ouvert")
end

GetViewport

Sécurité des plugins

ScriptDocument:GetViewport():Tuple

Retours

Tuple

Échantillons de code

ScriptDocument:GetViewport

--!nocheck

-- Exécutez le code suivant dans la barre de commandes pendant qu'un script est ouvert

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(`Actuellement en train de visualiser les lignes {firstLine} à {lastLine}`)
else
	print("Aucun script ouvert")
end

HasSelectedText

Sécurité des plugins

ScriptDocument:HasSelectedText():boolean

Retours

boolean

Échantillons de code

ScriptDocument:HasSelectedText() et :GetSelectedText()

--!nocheck

-- Exécutez le code suivant dans la barre de commandes pendant qu'un script est ouvert

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(`Texte actuellement sélectionné : {selectedText}`)
		else
			print("Aucun texte actuellement sélectionné")
		end
	end)
else
	print("Aucun script ouvert")
end

IsCommandBar

Sécurité des plugins

ScriptDocument:IsCommandBar():boolean

Retours

boolean

Échantillons de code

ScriptDocument:IsCommandBar()

--!nocheck

-- Exécutez le code suivant dans la barre de commande

local ScriptEditorService = game:GetService("ScriptEditorService")

local documents = ScriptEditorService:GetScriptDocuments()

for _, document in documents do
	if document:IsCommandBar() then
		print("Document de la barre de commande:", document)
	end
end

IsReadOnly

Sécurité des plugins

ScriptDocument:IsReadOnly():boolean

Retours

boolean

Échantillons de code

ScriptDocument:IsReadOnly()

local ScriptEditorService = game:GetService("ScriptEditorService")

for _, document in ScriptEditorService:GetScriptDocuments() do
	if document:IsReadOnly() then
		print(`{document.Name} est en lecture seule`)
	else
		print(`{document.Name} est modifiable`)
	end
end

MultiEditTextAsync

Rendement

Sécurité des plugins

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

Paramètres

edits:{any}

Retours

Tuple

RemoveReadOnlyReasonsAsync

Rendement

Sécurité des plugins

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

Paramètres

reasons:{any}

Retours

()

Échantillons de code

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(`Échec de l'ouverture du document de script : {err}`)
	return
end

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

-- L'éditeur reste en lecture seule tant qu'une autre raison reste active
scriptDocument:RemoveReadOnlyReasonsAsync({ "MyPluginReview" })
print(`Lecture seule après avoir supprimé une raison : {scriptDocument:IsReadOnly()}`)

scriptDocument:RemoveReadOnlyReasonsAsync({ "MyPluginLocked" })
print(`Lecture seule après avoir supprimé toutes les raisons : {scriptDocument:IsReadOnly()}`)

RequestSetSelectionAsync

Rendement

Sécurité des plugins

ScriptDocument:RequestSetSelectionAsync(

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

):Tuple

Paramètres

cursorLine:number

cursorCharacter:number

anchorLine:number?

Valeur par défaut : nil

anchorCharacter:number?

Valeur par défaut : nil

Retours

Tuple

Échantillons de code

ScriptDocument:RequestSetSelectionAsync()

--!nocheck

-- Exécutez le code suivant dans la barre de commandes pendant qu'un script est ouvert

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
	-- Obtenez le texte de la ligne actuelle du curseur
	local cursorLine = scriptDocument:GetSelection()
	local lineText = scriptDocument:GetLine(cursorLine)
	-- Sélectionnez toute la ligne de texte
	local success, err = scriptDocument:RequestSetSelectionAsync(cursorLine, 1, cursorLine, #lineText + 1)
	if success then
		print("Sélection définie !")
	else
		print(`Échec de la définition de la sélection en raison de : {err}`)
	end
else
	print("Aucun script ouvert")
end

ReviewableTextEditsAsync

Rendement

Sécurité des plugins

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

Paramètres

changes:{any}

Retours

Tuple

Événements

SelectionChanged

Sécurité des plugins

ScriptDocument.SelectionChanged(

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

):RBXScriptSignal

Paramètres

positionLine:number

positionCharacter:number

anchorLine:number

anchorCharacter:number

Échantillons de code

ScriptDocument.SelectionChanged et ScriptDocument:GetLine()

--!nocheck

-- Exécutez le code suivant dans la barre de commandes pendant qu'un script est ouvert

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(`Sélectionné : Ligne {positionLine}, Char {positionCharacter}`)
		print(`Ancre : Ligne {anchorLine}, Char {anchorCharacter}`)
		local lineText = scriptDocument:GetLine(positionLine)
		print(`Texte de la ligne sélectionnée : {lineText}`)
	end)
else
	print("Aucun script ouvert")
end

ViewportChanged

Sécurité des plugins

ScriptDocument.ViewportChanged(

startLine:number, endLine:number

):RBXScriptSignal

Paramètres

startLine:number

endLine:number

Échantillons de code

Connexion à ScriptDocument.ViewportChanged

--!nocheck

--[[
	Pour exécuter :
		1. Assurez-vous que la vue de sortie est ouverte
		2. Exécutez le code ci-dessous dans la barre de commande
		3. Faites défiler vers le haut et vers le bas dans la fenêtre de script ouverte

	Les instructions d'impression de l'événement ViewportChanged apparaîtront dans la sortie
]]

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

-- Créer un texte qui s'étend sur plusieurs lignes
local dummyText = string.rep("-- Dummy Text\n", 60)

-- Créer un script contenant le texte fictif et l'ouvrir
local otherScript = Instance.new("Script")
otherScript.Source = dummyText
otherScript.Parent = Workspace
local success, err = ScriptEditorService:OpenScriptDocumentAsync(otherScript)
if not success then
	warn(`Échec de l'ouverture du script en raison de : {err}`)
	return
end

-- Obtenir une référence au script ouvert
local scriptDocument = ScriptEditorService:FindScriptDocument(otherScript)

local function onViewportChanged(startLine: number, endLine: number)
	print(`Changement de vue du script - startLine: {startLine}, endLine: {endLine}`)
end
-- Connecter l'événement ViewportChanged à la fonction ci-dessus qui imprime la ligne de début et la ligne de fin de la vue mise à jour
scriptDocument.ViewportChanged:Connect(onViewportChanged)