A service that manages the execution of all BaseScript objects.
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.
Tags: [NotCreatable, Service, NotReplicated]
History Member 731 ScriptsDisabled : bool 573 AddCoreScriptLocal ( name: string , parent: Instance ) : null 648 CompressLuaApp ( ) : null 715 EnableCoverage ( instance: Instance ) : null 715 GetCoverageStats ( ) : Array 607 GetLuauHeapInstanceReferenceReport ( target: string ) : Dictionary 607 GetLuauHeapMemoryReport ( target: string ) : Dictionary 638 ReportLuaRequireCount ( ) : null 573 SetTimeout ( seconds: double ) : null 462 Error ( message: string , stackTrace: string , script: Instance ) 660 ErrorDetailed ( message: string , stackTrace: string , script: Instance , details: string , securityLevel: int , messageId: string ) 69 members inherited from Instance731 Archivable : bool 731 Attributes : string 731 AttributesReplicate : string 731 AttributesSerialize : BinaryString 731 Capabilities : SecurityCapabilities 731 DataCost : int 731 DefinesCapabilities : bool 731 HistoryId : UniqueId 731 IsInSandbox : bool 731 Name : string 731 Parent : Instance 731 PredictionMode : PredictionMode 731 PropertyStatusStudio : PropertyStatus 731 RobloxLocked : bool 731 Sandboxed : bool 734 SerializedOverrides : BinaryString 731 SourceAssetId : int64 731 Tags : SharedString 731 UniqueId : UniqueId 731 archivable : bool 731 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 707 GetDescendants ( ) : Instances 486 GetFullName ( ) : string 706 GetStyled ( name: string , selector: string? ) : Variant 657 GetStyledPropertyChangedSignal ( property: string ) : RBXScriptSignal 576 GetTags ( ) : Array 576 HasTag ( tag: string ) : bool 486 IsAncestorOf ( descendant: Instance ) : bool 486 IsDescendantOf ( ancestor: Instance ) : bool 664 IsPropertyModified ( property: string ) : bool 698 QueryDescendants ( selector: string ) : Instances 573 Remove ( ) : null 576 RemoveTag ( tag: string ) : null 664 ResetPropertyToDefault ( property: string ) : null 573 SetAttribute ( attribute: string , value: Variant ) : null 462 WaitForChild ( childName: string , timeOut: double ) : Instance 731 children ( ) : Instances 731 clone ( ) : Instance 731 destroy ( ) : null 731 findFirstChild ( name: string , recursive: bool = false ) : Instance 731 getChildren ( ) : Instances 731 isDescendantOf ( ancestor: Instance ) : bool 731 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 ( ) 657 StyledPropertiesChanged ( ) 731 childAdded ( child: Instance ) 6 members inherited from Object731 ClassName : string 731 className : string 647 GetPropertyChangedSignal ( property: string ) : RBXScriptSignal 647 IsA ( className: string ) : bool 731 isA ( className: string ) : bool 647 Changed ( property: string )
This service controls all BaseScript objects. Most of the properties
and methods of this service are locked for internal use.
731
Change Default of ScriptsDisabled
from
to
false 726
Change Default of ScriptsDisabled
from
false
to
715
Change Security of GetCoverageStats
from
RobloxScriptSecurity
to
None 715
Add EnableCoverage678
Remove StopScriptProfiling678
Remove StartScriptProfiling678
Remove SaveScriptProfilingData678
Remove GetScriptProfilingData678
Remove DeserializeScriptProfilerString678
Remove ClearScriptProfilingData660
Change Parameters of ErrorDetailed
from
( message: string , stackTrace: string , script: Instance , details: string , securityLevel: int )
to
( message: string , stackTrace: string , script: Instance , details: string , securityLevel: int , messageId: string ) 648
Add CompressLuaApp638
Add ReportLuaRequireCount613
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 GetLuauHeapMemoryReport607
Add GetLuauHeapInstanceReferenceReport600
Add GetScriptProfilingData587
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 SaveScriptProfilingData547
Add DeserializeScriptProfilerString538
Add StopScriptProfiling538
Add StartScriptProfiling538
Add ClearScriptProfilingData486
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 ErrorDetailed401
Remove StopCoverageCollection401
Remove StartCoverageCollection401
Remove ResetCoverageCollection400
Remove SetCoverageFilter356
Add StopCoverageCollection356
Add StartCoverageCollection356
Add SetCoverageFilter356
Add ResetCoverageCollection356
Add GetCoverageStats310
Remove CamelCaseViolation310
Remove SetCollectScriptStats310
Remove GetScriptStats310
Remove GetHeapStats273
Remove AddStarterScript272
Add AddStarterScript273
Remove AddStarterScript272
Remove AddCoreScript214
Remove GarbageCollectionLimit214
Remove GarbageCollectionFrequency168
Remove RegisterRobloxLibrary168
Remove RegisterLibrary168
Remove RegisterDevelopmentLibrary168
Remove LibraryRegistrationComplete166
Add AddCoreScriptLocal151
Change Security of SetTimeout
from
LocalUserSecurity
to
PluginSecurity 135
Change Security of Error
from
RobloxPlaceSecurity
to
None 76
Remove NonScriptableAccess53
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 NonScriptableAccess47
Add Error47
Add CamelCaseViolation47
Add SetTimeout47
Add SetCollectScriptStats47
Add RegisterRobloxLibrary47
Add RegisterLibrary47
Add RegisterDevelopmentLibrary47
Add LibraryRegistrationComplete47
Add GetScriptStats47
Add GetHeapStats47
Add AddStarterScript47
Add AddCoreScript47
Add ScriptsDisabled47
Add GarbageCollectionLimit47
Add GarbageCollectionFrequency47
Add ScriptContextParameters (0 ) No parameters. Returns (1 ) null
History 1 Requires PluginOrOpenCloud security; not callable from game scripts.
Registers instance as a coverage root so the engine records per-line and
per-function execution coverage for instance and every script descended
from it. Retrieve the recorded data with
ScriptContext:GetCoverageStats() .
History 1 Fires when an unhandled error occurs while running a script, reporting the
error to any listening code. The engine raises this event from its
error-reporting path when a thread terminates with an error, passing the
error message, a formatted stackTrace string, and the script that
was running.
This event does not fire for errors raised by the watchdog when a script
exceeds its execution-time limit (see ScriptContext:SetTimeout() ).
History 3 462
Change ThreadSafety of Error
from
to
Unsafe 135
Change Security of Error
from
RobloxPlaceSecurity
to
None 47
Add Error
History 4 660
Change Parameters of ErrorDetailed
from
( message: string , stackTrace: string , script: Instance , details: string , securityLevel: int )
to
( message: string , stackTrace: string , script: Instance , details: string , securityLevel: int , messageId: string ) 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 ErrorDetailedParameters (0 ) No parameters. Returns (1 ) Array
Requires PluginOrOpenCloud security; not callable from experience
scripts. Returns an array of coverage results, one entry per tracked
script. Each entry is a table with a Script field (the script
Instance ) and a GetHits() function. Calling GetHits() returns
two arrays: per-line hit counts, where -1 marks a line that was never
executed or was excluded, and per-function records containing each
function's Name, Line, and Hits.
Like ScriptContext:EnableCoverage() , this method raises an error
if coverage collection is not enabled.
History 3 GetLuauHeapInstanceReferenceReport
It may behave in a non-standard way.
History 1 Tags: [CustomLuaState]
It may behave in a non-standard way.
History 1 Tags: [CustomLuaState]
Parameters (0 ) No parameters. Returns (1 ) null
History 1
It is not meant to be used, and may have unresolved issues.
History 11 Tags: [Hidden]
Sets the watchdog time limit that the engine applies to running scripts.
The value becomes the per-resumption execution budget: if a thread runs
for longer than seconds since it was last resumed without yielding, the
watchdog aborts it with the runtime error
Script timeout: exhausted allowed execution time.
The timeout defaults to 0, which disables the watchdog so that scripts
may run without any time limit. Call this method with a positive value to
enable enforcement, or pass 0 to turn it back off.
History 4 Parameters (1 ) assetId int Returns (1 ) void
History 4 Parameters (0 ) No parameters. Returns (1 ) null
History 3 DeserializeScriptProfilerString
It may behave in a non-standard way.
History 3 Tags: [CustomLuaState]
GarbageCollectionFrequency
History 4 Parameters (1 ) Default clearHighwaterMark bool true Returns (1 ) Tuple
History 3 Parameters (0 ) No parameters. Returns (1 ) string
History 2 Parameters (0 ) No parameters. Returns (1 ) Array
History 4 LibraryRegistrationCompleteParameters (0 ) No parameters. Returns (1 ) void
History 3 RegisterDevelopmentLibrary
History 3 Parameters (0 ) No parameters. Returns (1 ) void
History 2 Parameters (1 ) Default enable bool false Returns (1 ) void
History 3 Parameters (0 ) No parameters. Returns (1 ) void
History 2 Parameters (1 ) frequency int? Returns (1 ) null
History 4 Parameters (0 ) No parameters. Returns (1 ) void
History 2 Parameters (0 ) No parameters. Returns (1 ) string
History 5