ScriptContext On DevHub

Summary

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

This class is a service. It is a singleton that may be acquired with GetService.

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

Memory Category	Instances

Tags: [NotCreatable, Service, NotReplicated]

Inherits (1)

Instance

Member index (12)

Type	Member	History
bool	ScriptsDisabled	53 53 468 468
null	AddCoreScriptLocal (string name, Instance parent)	166 573
null	ClearScriptProfilingData ()	538 573
Dictionary	DeserializeScriptProfilerString (string jsonString)	547
Array	GetCoverageStats ()	356
string	GetScriptProfilingData ()	600
null	SaveScriptProfilingData (string filename)	547 573
null	SetTimeout (double seconds)	151 573
null	StartScriptProfiling (int? frequency)	538 562 573
string	StopScriptProfiling ()	538 547 562 562
	Error (string message, string stackTrace, Instance script)	135
	ErrorDetailed (string message, string stackTrace, Instance script, string details, int securityLevel)	417 442
57 members inherited from Instance

Removed member index (17)

Type	Member	History
int	GarbageCollectionFrequency	50 50 49 49 50 50 214
int	GarbageCollectionLimit	50 50 49 49 50 50 214
void	AddCoreScript (int assetId, Instance parent, string name)	272
void	AddStarterScript (int assetId)	273 272 273
Tuple	GetHeapStats (bool clearHighwaterMark = true)	50 49 50 310
Array	GetScriptStats ()	50 50 49 49 50 50 310
void	LibraryRegistrationComplete ()	52 168
void	RegisterDevelopmentLibrary (string libraryName, Instance scriptInstance)	52 168
void	RegisterLibrary (string libraryName, string assetId)	52 168
void	RegisterRobloxLibrary (string libraryName, string assetId)	52 168
void	ResetCoverageCollection ()	356 401
void	SetCollectScriptStats (bool enable = false)	50 49 50 310
void	SetCoverageFilter (Function callback)	356 400
void	StartCoverageCollection ()	356 401
void	StopCoverageCollection ()	356 401
	CamelCaseViolation (Instance object, string member, Instance script)	310
	NonScriptableAccess (string property, Instance script)	76

600 Add ScriptContext.GetScriptProfilingData
573 Change ReturnType of ScriptContext.AddCoreScriptLocal from void to null
573 Change ReturnType of ScriptContext.ClearScriptProfilingData from void to null
573 Change ReturnType of ScriptContext.SaveScriptProfilingData from void to null
573 Change ReturnType of ScriptContext.SetTimeout from void to null
573 Change ReturnType of ScriptContext.StartScriptProfiling from void to null
562 Change Parameters of ScriptContext.StartScriptProfiling from () to (int? frequency)
562 Change ReturnType of ScriptContext.StopScriptProfiling from Dictionary to string
562 Change Tags of ScriptContext.StopScriptProfiling from [CustomLuaState] to []
547 Add ScriptContext.DeserializeScriptProfilerString
547 Add ScriptContext.SaveScriptProfilingData
547 Change ReturnType of ScriptContext.StopScriptProfiling from string to Dictionary
538 Add ScriptContext.ClearScriptProfilingData
538 Add ScriptContext.StartScriptProfiling
538 Add ScriptContext.StopScriptProfiling
468 Change CanLoad of ScriptContext.ScriptsDisabled from true to false
468 Change Tags of ScriptContext.ScriptsDisabled from [NotReplicated] to [Hidden]
442 Change Parameters of ScriptContext.ErrorDetailed from (string message, string stackTrace, Instance script, string details) to (string message, string stackTrace, Instance script, string details, int securityLevel)
417 Add ScriptContext.ErrorDetailed
401 Remove ScriptContext.ResetCoverageCollection
401 Remove ScriptContext.StartCoverageCollection
401 Remove ScriptContext.StopCoverageCollection
400 Remove ScriptContext.SetCoverageFilter
356 Add ScriptContext.GetCoverageStats
356 Add ScriptContext.ResetCoverageCollection
356 Add ScriptContext.SetCoverageFilter
356 Add ScriptContext.StartCoverageCollection
356 Add ScriptContext.StopCoverageCollection
310 Remove ScriptContext.GetHeapStats
310 Remove ScriptContext.GetScriptStats
310 Remove ScriptContext.SetCollectScriptStats
310 Remove ScriptContext.CamelCaseViolation
273 Remove ScriptContext.AddStarterScript
272 Add ScriptContext.AddStarterScript
273 Remove ScriptContext.AddStarterScript
272 Remove ScriptContext.AddCoreScript
214 Remove ScriptContext.GarbageCollectionFrequency
214 Remove ScriptContext.GarbageCollectionLimit
168 Remove ScriptContext.LibraryRegistrationComplete
168 Remove ScriptContext.RegisterDevelopmentLibrary
168 Remove ScriptContext.RegisterLibrary
168 Remove ScriptContext.RegisterRobloxLibrary
166 Add ScriptContext.AddCoreScriptLocal
151 Change Security of ScriptContext.SetTimeout from LocalUserSecurity to PluginSecurity
135 Change Security of ScriptContext.Error from RobloxPlaceSecurity to None
76 Remove ScriptContext.NonScriptableAccess
53 Change ReadSecurity of ScriptContext.ScriptsDisabled from None to LocalUserSecurity
53 Change WriteSecurity of ScriptContext.ScriptsDisabled from None to LocalUserSecurity
52 Change Security of ScriptContext.LibraryRegistrationComplete from LocalUserSecurity to RobloxScriptSecurity
52 Change Security of ScriptContext.RegisterDevelopmentLibrary from LocalUserSecurity to RobloxScriptSecurity
52 Change Security of ScriptContext.RegisterLibrary from LocalUserSecurity to RobloxScriptSecurity
52 Change Security of ScriptContext.RegisterRobloxLibrary from LocalUserSecurity to RobloxScriptSecurity
50 Change ReadSecurity of ScriptContext.GarbageCollectionFrequency from LocalUserSecurity to RobloxScriptSecurity
50 Change WriteSecurity of ScriptContext.GarbageCollectionFrequency from LocalUserSecurity to RobloxScriptSecurity
50 Change ReadSecurity of ScriptContext.GarbageCollectionLimit from LocalUserSecurity to RobloxScriptSecurity
50 Change WriteSecurity of ScriptContext.GarbageCollectionLimit from LocalUserSecurity to RobloxScriptSecurity
50 Change Security of ScriptContext.GetHeapStats from LocalUserSecurity to RobloxScriptSecurity
50 Change ReturnType of ScriptContext.GetScriptStats from Tuple to Array
50 Change Security of ScriptContext.GetScriptStats from LocalUserSecurity to RobloxScriptSecurity
50 Change Security of ScriptContext.SetCollectScriptStats from LocalUserSecurity to RobloxScriptSecurity
49 Change ReadSecurity of ScriptContext.GarbageCollectionFrequency from RobloxScriptSecurity to LocalUserSecurity
49 Change WriteSecurity of ScriptContext.GarbageCollectionFrequency from RobloxScriptSecurity to LocalUserSecurity
49 Change ReadSecurity of ScriptContext.GarbageCollectionLimit from RobloxScriptSecurity to LocalUserSecurity
49 Change WriteSecurity of ScriptContext.GarbageCollectionLimit from RobloxScriptSecurity to LocalUserSecurity
49 Change Security of ScriptContext.GetHeapStats from RobloxScriptSecurity to LocalUserSecurity
49 Change ReturnType of ScriptContext.GetScriptStats from Array to Tuple
49 Change Security of ScriptContext.GetScriptStats from RobloxScriptSecurity to LocalUserSecurity
49 Change Security of ScriptContext.SetCollectScriptStats from RobloxScriptSecurity to LocalUserSecurity
50 Change ReadSecurity of ScriptContext.GarbageCollectionFrequency from LocalUserSecurity to RobloxScriptSecurity
50 Change WriteSecurity of ScriptContext.GarbageCollectionFrequency from LocalUserSecurity to RobloxScriptSecurity
50 Change ReadSecurity of ScriptContext.GarbageCollectionLimit from LocalUserSecurity to RobloxScriptSecurity
50 Change WriteSecurity of ScriptContext.GarbageCollectionLimit from LocalUserSecurity to RobloxScriptSecurity
50 Change Security of ScriptContext.GetHeapStats from LocalUserSecurity to RobloxScriptSecurity
50 Change ReturnType of ScriptContext.GetScriptStats from Tuple to Array
50 Change Security of ScriptContext.GetScriptStats from LocalUserSecurity to RobloxScriptSecurity
50 Change Security of ScriptContext.SetCollectScriptStats from LocalUserSecurity to RobloxScriptSecurity

Members

AddCoreScriptLocal On DevHub

Parameters	2

Name	Type	Default
name	string	none
parent	Instance	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of ScriptContext.AddCoreScriptLocal from void to null
166 Add ScriptContext.AddCoreScriptLocal

ClearScriptProfilingData On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of ScriptContext.ClearScriptProfilingData from void to null
538 Add ScriptContext.ClearScriptProfilingData

DeserializeScriptProfilerString On DevHub

Parameters	1

Name	Type	Default
jsonString	string	none

Return Type	Dictionary
Security	RobloxScriptSecurity

History

547 Add ScriptContext.DeserializeScriptProfilerString

Tags: [CustomLuaState]

Error On DevHub

Parameters	3

Name	Type	Default
message	string	none
stackTrace	string	none
script	Instance	none

History

135 Change Security of ScriptContext.Error from RobloxPlaceSecurity to None

ErrorDetailed On DevHub

Parameters	5

Name	Type	Default
message	string	none
stackTrace	string	none
script	Instance	none
details	string	none
securityLevel	int	none

Security	RobloxScriptSecurity

History

442 Change Parameters of ScriptContext.ErrorDetailed from (string message, string stackTrace, Instance script, string details) to (string message, string stackTrace, Instance script, string details, int securityLevel)
417 Add ScriptContext.ErrorDetailed

GetCoverageStats On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	Array
Security	RobloxScriptSecurity

History

356 Add ScriptContext.GetCoverageStats

GetScriptProfilingData On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

600 Add ScriptContext.GetScriptProfilingData

SaveScriptProfilingData On DevHub

Parameters	1

Name	Type	Default
filename	string	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of ScriptContext.SaveScriptProfilingData from void to null
547 Add ScriptContext.SaveScriptProfilingData

ScriptsDisabled On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

Value Type	bool
Security	LocalUserSecurity
Category	State
Can Load	false
Can Save	false

History

468 Change CanLoad of ScriptContext.ScriptsDisabled from true to false
468 Change Tags of ScriptContext.ScriptsDisabled from [NotReplicated] to [Hidden]
53 Change ReadSecurity of ScriptContext.ScriptsDisabled from None to LocalUserSecurity
53 Change WriteSecurity of ScriptContext.ScriptsDisabled from None to LocalUserSecurity

Tags: [Hidden]

SetTimeout On DevHub

Parameters	1

Name	Type	Default
seconds	double	none

Return Type	null
Security	PluginSecurity

History

573 Change ReturnType of ScriptContext.SetTimeout from void to null
151 Change Security of ScriptContext.SetTimeout from LocalUserSecurity to PluginSecurity

StartScriptProfiling On DevHub

Parameters	1

Name	Type	Default
frequency	int?	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of ScriptContext.StartScriptProfiling from void to null
562 Change Parameters of ScriptContext.StartScriptProfiling from () to (int? frequency)
538 Add ScriptContext.StartScriptProfiling

StopScriptProfiling On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

562 Change ReturnType of ScriptContext.StopScriptProfiling from Dictionary to string
562 Change Tags of ScriptContext.StopScriptProfiling from [CustomLuaState] to []
547 Change ReturnType of ScriptContext.StopScriptProfiling from string to Dictionary
538 Add ScriptContext.StopScriptProfiling

Removed members

AddCoreScript

Parameters	3

Name	Type	Default
assetId	int	none
parent	Instance	none
name	string	none

Return Type	void
Security	RobloxScriptSecurity

History

272 Remove ScriptContext.AddCoreScript

AddStarterScript

Parameters	1

Name	Type	Default
assetId	int	none

Return Type	void
Security	LocalUserSecurity

History

273 Remove ScriptContext.AddStarterScript
272 Add ScriptContext.AddStarterScript
273 Remove ScriptContext.AddStarterScript

CamelCaseViolation

Parameters	3

Name	Type	Default
object	Instance	none
member	string	none
script	Instance	none

Security	RobloxScriptSecurity

History

310 Remove ScriptContext.CamelCaseViolation

GarbageCollectionFrequency

Value Type	int
Security	RobloxScriptSecurity
Category
Can Load	false
Can Save	false

History

214 Remove ScriptContext.GarbageCollectionFrequency
50 Change ReadSecurity of ScriptContext.GarbageCollectionFrequency from LocalUserSecurity to RobloxScriptSecurity
50 Change WriteSecurity of ScriptContext.GarbageCollectionFrequency from LocalUserSecurity to RobloxScriptSecurity
49 Change ReadSecurity of ScriptContext.GarbageCollectionFrequency from RobloxScriptSecurity to LocalUserSecurity
49 Change WriteSecurity of ScriptContext.GarbageCollectionFrequency from RobloxScriptSecurity to LocalUserSecurity
50 Change ReadSecurity of ScriptContext.GarbageCollectionFrequency from LocalUserSecurity to RobloxScriptSecurity
50 Change WriteSecurity of ScriptContext.GarbageCollectionFrequency from LocalUserSecurity to RobloxScriptSecurity

GarbageCollectionLimit

Value Type	int
Security	RobloxScriptSecurity
Category
Can Load	false
Can Save	false

History

214 Remove ScriptContext.GarbageCollectionLimit
50 Change ReadSecurity of ScriptContext.GarbageCollectionLimit from LocalUserSecurity to RobloxScriptSecurity
50 Change WriteSecurity of ScriptContext.GarbageCollectionLimit from LocalUserSecurity to RobloxScriptSecurity
49 Change ReadSecurity of ScriptContext.GarbageCollectionLimit from RobloxScriptSecurity to LocalUserSecurity
49 Change WriteSecurity of ScriptContext.GarbageCollectionLimit from RobloxScriptSecurity to LocalUserSecurity
50 Change ReadSecurity of ScriptContext.GarbageCollectionLimit from LocalUserSecurity to RobloxScriptSecurity
50 Change WriteSecurity of ScriptContext.GarbageCollectionLimit from LocalUserSecurity to RobloxScriptSecurity

GetHeapStats

Parameters	1

Name	Type	Default
clearHighwaterMark	bool	true

Return Type	Tuple
Security	RobloxScriptSecurity

History

310 Remove ScriptContext.GetHeapStats
50 Change Security of ScriptContext.GetHeapStats from LocalUserSecurity to RobloxScriptSecurity
49 Change Security of ScriptContext.GetHeapStats from RobloxScriptSecurity to LocalUserSecurity
50 Change Security of ScriptContext.GetHeapStats from LocalUserSecurity to RobloxScriptSecurity

GetScriptStats

Parameters	0

Name	Type	Default
No parameters.

Return Type	Array
Security	RobloxScriptSecurity

History

310 Remove ScriptContext.GetScriptStats
50 Change ReturnType of ScriptContext.GetScriptStats from Tuple to Array
50 Change Security of ScriptContext.GetScriptStats from LocalUserSecurity to RobloxScriptSecurity
49 Change ReturnType of ScriptContext.GetScriptStats from Array to Tuple
49 Change Security of ScriptContext.GetScriptStats from RobloxScriptSecurity to LocalUserSecurity
50 Change ReturnType of ScriptContext.GetScriptStats from Tuple to Array
50 Change Security of ScriptContext.GetScriptStats from LocalUserSecurity to RobloxScriptSecurity

LibraryRegistrationComplete

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

168 Remove ScriptContext.LibraryRegistrationComplete
52 Change Security of ScriptContext.LibraryRegistrationComplete from LocalUserSecurity to RobloxScriptSecurity

NonScriptableAccess

Parameters	2

Name	Type	Default
property	string	none
script	Instance	none

Security	RobloxScriptSecurity

History

76 Remove ScriptContext.NonScriptableAccess

RegisterDevelopmentLibrary

Parameters	2

Name	Type	Default
libraryName	string	none
scriptInstance	Instance	none

Return Type	void
Security	RobloxScriptSecurity

History

168 Remove ScriptContext.RegisterDevelopmentLibrary
52 Change Security of ScriptContext.RegisterDevelopmentLibrary from LocalUserSecurity to RobloxScriptSecurity

RegisterLibrary

Parameters	2

Name	Type	Default
libraryName	string	none
assetId	string	none

Return Type	void
Security	RobloxScriptSecurity

History

168 Remove ScriptContext.RegisterLibrary
52 Change Security of ScriptContext.RegisterLibrary from LocalUserSecurity to RobloxScriptSecurity

RegisterRobloxLibrary

Parameters	2

Name	Type	Default
libraryName	string	none
assetId	string	none

Return Type	void
Security	RobloxScriptSecurity

History

168 Remove ScriptContext.RegisterRobloxLibrary
52 Change Security of ScriptContext.RegisterRobloxLibrary from LocalUserSecurity to RobloxScriptSecurity

ResetCoverageCollection

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

401 Remove ScriptContext.ResetCoverageCollection
356 Add ScriptContext.ResetCoverageCollection

SetCollectScriptStats

Parameters	1

Name	Type	Default
enable	bool	false

Return Type	void
Security	RobloxScriptSecurity

History

310 Remove ScriptContext.SetCollectScriptStats
50 Change Security of ScriptContext.SetCollectScriptStats from LocalUserSecurity to RobloxScriptSecurity
49 Change Security of ScriptContext.SetCollectScriptStats from RobloxScriptSecurity to LocalUserSecurity
50 Change Security of ScriptContext.SetCollectScriptStats from LocalUserSecurity to RobloxScriptSecurity

SetCoverageFilter

Parameters	1

Name	Type	Default
callback	Function	none

Return Type	void
Security	RobloxScriptSecurity

History

400 Remove ScriptContext.SetCoverageFilter
356 Add ScriptContext.SetCoverageFilter

StartCoverageCollection

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

401 Remove ScriptContext.StartCoverageCollection
356 Add ScriptContext.StartCoverageCollection

StopCoverageCollection

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

401 Remove ScriptContext.StopCoverageCollection
356 Add ScriptContext.StopCoverageCollection

Relevant classes (1)

Instance