ScriptContext
CreatorHub

Its interface does not cross the network boundary.

Instances of this class cannot be created with Instance.new.

It is a singleton that may be acquired with GetService.

Memory category	Instances

Tags: [NotCreatable, Service, NotReplicated]

Member index 16

History		Member
587		ScriptsDisabled: bool
573		AddCoreScriptLocal(name: string, parent: Instance): null
573		ClearScriptProfilingData(): null
648		CompressLuaApp(): null
613		DeserializeScriptProfilerString(jsonString: string?): Dictionary
462		GetCoverageStats(): Array
607		GetLuauHeapInstanceReferenceReport(target: string): Dictionary
607		GetLuauHeapMemoryReport(target: string): Dictionary
600		GetScriptProfilingData(): string
638		ReportLuaRequireCount(): null
608		SaveScriptProfilingData(jsonString: string, filename: string): string
573		SetTimeout(seconds: double): null
573		StartScriptProfiling(frequency: int?): null
562		StopScriptProfiling(): string
462		Error(message: string, stackTrace: string, script: Instance)
462		ErrorDetailed(message: string, stackTrace: string, script: Instance, details: string, securityLevel: int)
63 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
635		Capabilities: SecurityCapabilities
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
635		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
616		UniqueId: UniqueId
553		archivable: bool
553		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
486		GetDescendants(): Array
486		GetFullName(): string
641		GetStyled(name: string): Variant
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
580		IsPropertyModified(name: string): bool
573		Remove(): null
576		RemoveTag(tag: string): null
580		ResetPropertyToDefault(name: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
648		children(): Instances
553		clone(): Instance
573		destroy(): null
553		findFirstChild(name: string, recursive: bool = false): Instance
648		getChildren(): Instances
553		isDescendantOf(ancestor: Instance): bool
573		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
553		childAdded(child: Instance)
6 members inherited from Object
647		ClassName: string
647		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
650		isA(className: string): bool
647		Changed(property: string)

Removed member index 17

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

Description

This service controls all BaseScript objects. Most of the properties and methods of this service are locked for internal use.

History 93
Hide member changes

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

Members 16

AddCoreScriptLocal
CreatorHub

Parameters (2)
name	string
parent	Instance
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

573 Change ReturnType of AddCoreScriptLocal from void to null
462 Change ThreadSafety of AddCoreScriptLocal from to Unsafe
166 Add AddCoreScriptLocal

ClearScriptProfilingData
CreatorHub

Parameters (0)
No parameters.
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

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

CompressLuaApp
CreatorHub

Parameters (0)
No parameters.
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

648 Add CompressLuaApp

DeserializeScriptProfilerString
CreatorHub

Parameters (1)
jsonString	string?
Returns (1)
Dictionary

It may behave in a non-standard way.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

613 Change Parameters of DeserializeScriptProfilerString from (jsonString: string) to (jsonString: string?)
547 Add DeserializeScriptProfilerString

Tags: [CustomLuaState]

Error
CreatorHub

Parameters (3)
message	string
stackTrace	string
script	Instance

Fired when an error occurs.

Thread safety	Unsafe

History 3

462 Change ThreadSafety of Error from to Unsafe
135 Change Security of Error from RobloxPlaceSecurity to None
47 Add Error

ErrorDetailed
CreatorHub

Parameters (5)
message	string
stackTrace	string
script	Instance
details	string
securityLevel	int

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

462 Change ThreadSafety of ErrorDetailed from to Unsafe
442 Change Parameters of ErrorDetailed from (message: string, stackTrace: string, script: Instance, details: string) to (message: string, stackTrace: string, script: Instance, details: string, securityLevel: int)
417 Add ErrorDetailed

GetCoverageStats
CreatorHub

Parameters (0)
No parameters.
Returns (1)
Array

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

462 Change ThreadSafety of GetCoverageStats from to Unsafe
356 Add GetCoverageStats

GetLuauHeapInstanceReferenceReport
CreatorHub

Parameters (1)
target	string
Returns (1)
Dictionary

It may behave in a non-standard way.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

607 Add GetLuauHeapInstanceReferenceReport

Tags: [CustomLuaState]

GetLuauHeapMemoryReport
CreatorHub

Parameters (1)
target	string
Returns (1)
Dictionary

It may behave in a non-standard way.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

607 Add GetLuauHeapMemoryReport

Tags: [CustomLuaState]

GetScriptProfilingData
CreatorHub

Parameters (0)
No parameters.
Returns (1)
string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

600 Add GetScriptProfilingData

ReportLuaRequireCount
CreatorHub

Parameters (0)
No parameters.
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

638 Add ReportLuaRequireCount

SaveScriptProfilingData
CreatorHub

Parameters (2)
jsonString	string
filename	string
Returns (1)
string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 4

608 Change ReturnType of SaveScriptProfilingData from null to string
608 Change Parameters of SaveScriptProfilingData from (filename: string) to (jsonString: string, filename: string)
573 Change ReturnType of SaveScriptProfilingData from void to null
547 Add SaveScriptProfilingData

ScriptsDisabled
CreatorHub

Type		Default
bool		false

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

Security	LocalUserSecurity
Thread safety	ReadSafe
Category	State
Loaded/Saved	false

History 9

587 Change Default of ScriptsDisabled from true to false
553 Change Default of ScriptsDisabled from to true
486 Change ThreadSafety of ScriptsDisabled from ReadOnly to ReadSafe
468 Change Tags of ScriptsDisabled from [NotReplicated] to [Hidden]
468 Change CanLoad of ScriptsDisabled from true to false
462 Change ThreadSafety of ScriptsDisabled from to ReadOnly
53 Change WriteSecurity of ScriptsDisabled from None to LocalUserSecurity
53 Change ReadSecurity of ScriptsDisabled from None to LocalUserSecurity
47 Add ScriptsDisabled

Tags: [Hidden]

SetTimeout
CreatorHub

Parameters (1)
seconds	double
Returns (1)
null

Limits how long a script is allowed to run without yielding.

Security	PluginSecurity
Thread safety	Unsafe

History 4

573 Change ReturnType of SetTimeout from void to null
462 Change ThreadSafety of SetTimeout from to Unsafe
151 Change Security of SetTimeout from LocalUserSecurity to PluginSecurity
47 Add SetTimeout

StartScriptProfiling
CreatorHub

Parameters (1)
frequency	int?
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

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

StopScriptProfiling
CreatorHub

Parameters (0)
No parameters.
Returns (1)
string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 4

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

Removed members 17

AddCoreScript
CreatorHub

Parameters (3)
assetId	int
parent	Instance
name	string
Returns (1)
void

Security	RobloxScriptSecurity

History 2

272 Remove AddCoreScript
47 Add AddCoreScript

AddStarterScript
CreatorHub

Parameters (1)
assetId	int
Returns (1)
void

Security	LocalUserSecurity

History 4

CamelCaseViolation
CreatorHub

Parameters (3)
object	Instance
member	string
script	Instance

Security	RobloxScriptSecurity

History 2

310 Remove CamelCaseViolation
47 Add CamelCaseViolation

GarbageCollectionFrequency
CreatorHub

Type		Default
int

Security	RobloxScriptSecurity
Category
Loaded/Saved	false

History 4

214 Remove GarbageCollectionFrequency
50 Change WriteSecurity of GarbageCollectionFrequency from LocalUserSecurity to RobloxScriptSecurity
50 Change ReadSecurity of GarbageCollectionFrequency from LocalUserSecurity to RobloxScriptSecurity
47 Add GarbageCollectionFrequency

GarbageCollectionLimit
CreatorHub

Type		Default
int

Security	RobloxScriptSecurity
Category
Loaded/Saved	false

History 4

214 Remove GarbageCollectionLimit
50 Change WriteSecurity of GarbageCollectionLimit from LocalUserSecurity to RobloxScriptSecurity
50 Change ReadSecurity of GarbageCollectionLimit from LocalUserSecurity to RobloxScriptSecurity
47 Add GarbageCollectionLimit

GetHeapStats
CreatorHub

Parameters (1)		Default
clearHighwaterMark	bool	true
Returns (1)
Tuple

Security	RobloxScriptSecurity

History 3

310 Remove GetHeapStats
50 Change Security of GetHeapStats from LocalUserSecurity to RobloxScriptSecurity
47 Add GetHeapStats

GetScriptStats
CreatorHub

Parameters (0)
No parameters.
Returns (1)
Array

Security	RobloxScriptSecurity

History 4

310 Remove GetScriptStats
50 Change Security of GetScriptStats from LocalUserSecurity to RobloxScriptSecurity
50 Change ReturnType of GetScriptStats from Tuple to Array
47 Add GetScriptStats

LibraryRegistrationComplete
CreatorHub

Parameters (0)
No parameters.
Returns (1)
void

Security	RobloxScriptSecurity

History 3

168 Remove LibraryRegistrationComplete
52 Change Security of LibraryRegistrationComplete from LocalUserSecurity to RobloxScriptSecurity
47 Add LibraryRegistrationComplete

NonScriptableAccess
CreatorHub

Parameters (2)
property	string
script	Instance

Security	RobloxScriptSecurity

History 2

76 Remove NonScriptableAccess
47 Add NonScriptableAccess

RegisterDevelopmentLibrary
CreatorHub

Parameters (2)
libraryName	string
scriptInstance	Instance
Returns (1)
void

Security	RobloxScriptSecurity

History 3

168 Remove RegisterDevelopmentLibrary
52 Change Security of RegisterDevelopmentLibrary from LocalUserSecurity to RobloxScriptSecurity
47 Add RegisterDevelopmentLibrary

RegisterLibrary
CreatorHub

Parameters (2)
libraryName	string
assetId	string
Returns (1)
void

Security	RobloxScriptSecurity

History 3

168 Remove RegisterLibrary
52 Change Security of RegisterLibrary from LocalUserSecurity to RobloxScriptSecurity
47 Add RegisterLibrary

RegisterRobloxLibrary
CreatorHub

Parameters (2)
libraryName	string
assetId	string
Returns (1)
void

Security	RobloxScriptSecurity

History 3

168 Remove RegisterRobloxLibrary
52 Change Security of RegisterRobloxLibrary from LocalUserSecurity to RobloxScriptSecurity
47 Add RegisterRobloxLibrary

ResetCoverageCollection
CreatorHub

Parameters (0)
No parameters.
Returns (1)
void

Security	RobloxScriptSecurity

History 2

401 Remove ResetCoverageCollection
356 Add ResetCoverageCollection

SetCollectScriptStats
CreatorHub

Parameters (1)		Default
enable	bool	false
Returns (1)
void

Security	RobloxScriptSecurity

History 3

310 Remove SetCollectScriptStats
50 Change Security of SetCollectScriptStats from LocalUserSecurity to RobloxScriptSecurity
47 Add SetCollectScriptStats

SetCoverageFilter
CreatorHub

Parameters (1)
callback	Function
Returns (1)
void

Security	RobloxScriptSecurity

History 2

400 Remove SetCoverageFilter
356 Add SetCoverageFilter

StartCoverageCollection
CreatorHub

Parameters (0)
No parameters.
Returns (1)
void

Security	RobloxScriptSecurity

History 2

401 Remove StartCoverageCollection
356 Add StartCoverageCollection

StopCoverageCollection
CreatorHub

Parameters (0)
No parameters.
Returns (1)
void

Security	RobloxScriptSecurity

History 2

401 Remove StopCoverageCollection
356 Add StopCoverageCollection

Engine API

Website

Related

History 3

History 2

History 1

History 2

History 3

History 3

History 2

History 1

History 1

History 1

History 1

History 4

History 9

History 4

History 3

History 4

History 2

History 4

History 2

History 4

History 4

History 3

History 4

History 3

History 2

History 3

History 3

History 3

History 2

History 3

History 2

History 2

History 2