ScriptDocument On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.

This item is not replicated. Its interface does not cross the network boundary.

Memory Category	Instances

Tags: [NotCreatable, NotReplicated]

Inherits (1)

Instance

Member index (18)

Type	Member	History
Tuple	CloseAsync ()	543
Tuple	EditTextAsync (string newText, int startLine, int startCharacter, int endLine, int endCharacter)	530 531 531 532 533
Tuple	ForceSetSelectionAsync (int cursorLine, int cursorCharacter, int? anchorLine = nil, int? anchorCharacter = nil)	540
string	GetInternalUri ()	531
string	GetLine (int? lineIndex = nil)	532 536
int	GetLineCount ()	532
LuaSourceContainer	GetScript ()	532
string	GetSelectedText ()	538
Tuple	GetSelection ()	534
Tuple	GetSelectionEnd ()	538
Tuple	GetSelectionStart ()	538
string	GetText (int? startLine = nil, int? startCharacter = nil, int? endLine = nil, int? endCharacter = nil)	532 532 536
Tuple	GetViewport ()	541
bool	HasSelectedText ()	538
bool	IsCommandBar ()	531 532
Tuple	RequestSetSelectionAsync (int cursorLine, int cursorCharacter, int? anchorLine = nil, int? anchorCharacter = nil)	540
	SelectionChanged (int64 positionLine, int64 positionCharacter, int64 anchorLine, int64 anchorCharacter)	534
	ViewportChanged (int64 startLine, int64 endLine)	541
57 members inherited from Instance

Removed member index (1)

Type		Member	History
int		GetNumLines ()	532

543 Add ScriptDocument.CloseAsync
541 Add ScriptDocument.GetViewport
541 Add ScriptDocument.ViewportChanged
540 Add ScriptDocument.ForceSetSelectionAsync
540 Add ScriptDocument.RequestSetSelectionAsync
538 Add ScriptDocument.GetSelectedText
538 Add ScriptDocument.GetSelectionEnd
538 Add ScriptDocument.GetSelectionStart
538 Add ScriptDocument.HasSelectedText
536 Change Parameters of ScriptDocument.GetLine from (int lineIndex = -1234567) to (int? lineIndex = nil)
536 Change Parameters of ScriptDocument.GetText from (int startLine = -1234567, int startCharacter = -1234567, int endLine = -1234567, int endCharacter = -1234567) to (int? startLine = nil, int? startCharacter = nil, int? endLine = nil, int? endCharacter = nil)
534 Add ScriptDocument.GetSelection
534 Add ScriptDocument.SelectionChanged
533 Change Parameters of ScriptDocument.EditTextAsync from (string newText, int startLine, int startCharacter, int endLine = -1, int endCharacter = -1) to (string newText, int startLine, int startCharacter, int endLine, int endCharacter)
532 Change Security of ScriptDocument.EditTextAsync from RobloxScriptSecurity to PluginSecurity
532 Add ScriptDocument.GetLine
532 Add ScriptDocument.GetLineCount
532 Remove ScriptDocument.GetNumLines
532 Change Security of ScriptDocument.GetScript from RobloxScriptSecurity to PluginSecurity
532 Change Parameters of ScriptDocument.GetText from () to (int startLine = -1234567, int startCharacter = -1234567, int endLine = -1234567, int endCharacter = -1234567)
532 Change Security of ScriptDocument.GetText from RobloxScriptSecurity to PluginSecurity
532 Change Security of ScriptDocument.IsCommandBar from RobloxScriptSecurity to PluginSecurity
531 Change Parameters of ScriptDocument.EditTextAsync from (string newText, int startLine, int startCharacter, int endLine, int endCharacter) to (string newText, int startLine, int startCharacter, int endLine = -1, int endCharacter = -1)
531 Change ReturnType of ScriptDocument.EditTextAsync from bool to Tuple
531 Add ScriptDocument.GetInternalUri
531 Add ScriptDocument.IsCommandBar
530 Add ScriptDocument.EditTextAsync
528 Add ScriptDocument

Members

CloseAsync On DevHub

This function yields. It will block the calling thread until completion.

Parameters	0

Name	Type	Default
No parameters.

Return Type	Tuple
Security	PluginSecurity

History

543 Add ScriptDocument.CloseAsync

Tags: [Yields]

EditTextAsync On DevHub

This function yields. It will block the calling thread until completion.

Parameters	5

Name	Type	Default
newText	string	none
startLine	int	none
startCharacter	int	none
endLine	int	none
endCharacter	int	none

Return Type	Tuple
Security	PluginSecurity

History

533 Change Parameters of ScriptDocument.EditTextAsync from (string newText, int startLine, int startCharacter, int endLine = -1, int endCharacter = -1) to (string newText, int startLine, int startCharacter, int endLine, int endCharacter)
532 Change Security of ScriptDocument.EditTextAsync from RobloxScriptSecurity to PluginSecurity
531 Change Parameters of ScriptDocument.EditTextAsync from (string newText, int startLine, int startCharacter, int endLine, int endCharacter) to (string newText, int startLine, int startCharacter, int endLine = -1, int endCharacter = -1)
531 Change ReturnType of ScriptDocument.EditTextAsync from bool to Tuple
530 Add ScriptDocument.EditTextAsync

Tags: [Yields]

ForceSetSelectionAsync On DevHub

This function yields. It will block the calling thread until completion.

Parameters	4

Name	Type	Default
cursorLine	int	none
cursorCharacter	int	none
anchorLine	int?	nil
anchorCharacter	int?	nil

Return Type	Tuple
Security	PluginSecurity

History

540 Add ScriptDocument.ForceSetSelectionAsync

Tags: [Yields]

GetInternalUri On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

531 Add ScriptDocument.GetInternalUri

GetLine On DevHub

Parameters	1

Name	Type	Default
lineIndex	int?	nil

Return Type	string
Security	PluginSecurity

History

536 Change Parameters of ScriptDocument.GetLine from (int lineIndex = -1234567) to (int? lineIndex = nil)
532 Add ScriptDocument.GetLine

GetLineCount On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	int
Security	PluginSecurity

History

532 Add ScriptDocument.GetLineCount

GetScript On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	LuaSourceContainer
Security	PluginSecurity

History

532 Change Security of ScriptDocument.GetScript from RobloxScriptSecurity to PluginSecurity

GetSelectedText On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	PluginSecurity

History

538 Add ScriptDocument.GetSelectedText

GetSelection On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Tuple
Security	PluginSecurity

History

534 Add ScriptDocument.GetSelection

GetSelectionEnd On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Tuple
Security	PluginSecurity

History

538 Add ScriptDocument.GetSelectionEnd

GetSelectionStart On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Tuple
Security	PluginSecurity

History

538 Add ScriptDocument.GetSelectionStart

GetText On DevHub

Parameters	4

Name	Type	Default
startLine	int?	nil
startCharacter	int?	nil
endLine	int?	nil
endCharacter	int?	nil

Return Type	string
Security	PluginSecurity

History

536 Change Parameters of ScriptDocument.GetText from (int startLine = -1234567, int startCharacter = -1234567, int endLine = -1234567, int endCharacter = -1234567) to (int? startLine = nil, int? startCharacter = nil, int? endLine = nil, int? endCharacter = nil)
532 Change Parameters of ScriptDocument.GetText from () to (int startLine = -1234567, int startCharacter = -1234567, int endLine = -1234567, int endCharacter = -1234567)
532 Change Security of ScriptDocument.GetText from RobloxScriptSecurity to PluginSecurity

GetViewport On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Tuple
Security	PluginSecurity

History

541 Add ScriptDocument.GetViewport

HasSelectedText On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	PluginSecurity

History

538 Add ScriptDocument.HasSelectedText

IsCommandBar On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	PluginSecurity

History

532 Change Security of ScriptDocument.IsCommandBar from RobloxScriptSecurity to PluginSecurity
531 Add ScriptDocument.IsCommandBar

RequestSetSelectionAsync On DevHub

This function yields. It will block the calling thread until completion.

Parameters	4

Name	Type	Default
cursorLine	int	none
cursorCharacter	int	none
anchorLine	int?	nil
anchorCharacter	int?	nil

Return Type	Tuple
Security	PluginSecurity

History

540 Add ScriptDocument.RequestSetSelectionAsync

Tags: [Yields]

SelectionChanged On DevHub

Parameters	4

Name	Type	Default
positionLine	int64	none
positionCharacter	int64	none
anchorLine	int64	none
anchorCharacter	int64	none

Security	PluginSecurity

History

534 Add ScriptDocument.SelectionChanged

ViewportChanged On DevHub

Parameters	2

Name	Type	Default
startLine	int64	none
endLine	int64	none

Security	PluginSecurity

History

541 Add ScriptDocument.ViewportChanged

Removed members

GetNumLines

Parameters	0

Name	Type	Default
No parameters.

Return Type	int
Security	RobloxScriptSecurity

History

532 Remove ScriptDocument.GetNumLines

Relevant classes (1)

LuaSourceContainer

Relevant members (4)

ScriptEditorService.FindScriptDocument
ScriptEditorService.TextDocumentDidChange (document)
ScriptEditorService.TextDocumentDidClose (oldDocument)
ScriptEditorService.TextDocumentDidOpen (newDocument)