Creator
​
Engine API
Release notes
Learn
Engine Class
TestService
Service
Summary
Methods
Check(condition: boolean,description: string,source: Instance,line: number):()
Checkpoint(text: string,source: Instance,line: number):()
Done():()
Error(description: string,source: Instance,line: number):()
Fail(description: string,source: Instance,line: number):()
isFeatureEnabled(name: string):boolean
Message(text: string,source: Instance,line: number):()
RegisterTest(testOptions: Dictionary):TestCase
Require(condition: boolean,description: string,source: Instance,line: number):()
Run():()
Deprecated
RunAsync():()
ScopeTime():Dictionary
TakeSnapshot(snapshotname: string,source: Instance):()
Warn(condition: boolean,description: string,source: Instance,line: number):()
Inherited Members
API Reference
Properties
AutoRuns
Read Parallel
TestService.AutoRuns:boolean
Description
Read Parallel
TestService.Description:string
ErrorCount
Read Only
Not Replicated
Read Parallel
TestService.ErrorCount:number
ExecuteWithStudioRun
Read Parallel
TestService.ExecuteWithStudioRun:boolean
Is30FpsThrottleEnabled
Deprecated
IsPhysicsEnvironmentalThrottled
Read Parallel
TestService.IsPhysicsEnvironmentalThrottled:boolean
IsSleepAllowed
Read Parallel
TestService.IsSleepAllowed:boolean
NumberOfPlayers
Read Parallel
TestService.NumberOfPlayers:number
SimulateSecondsLag
Read Parallel
TestService.SimulateSecondsLag:number
TestCount
Read Only
Not Replicated
Read Parallel
TestService.TestCount:number
ThrottlePhysicsToRealtime
Read Parallel
TestService.ThrottlePhysicsToRealtime:boolean
Timeout
Read Parallel
TestService.Timeout:number
WarnCount
Read Only
Not Replicated
Read Parallel
TestService.WarnCount:number
Methods
Check
TestService:Check(
condition:boolean, description:string, source:Instance, line:number
):()
Parameters
condition:boolean
description:string
source:Instance
Default Value: "nil"
line:number
Default Value: 0
Returns
()
Code Samples
TestService:Check
local TestService = game:GetService("TestService")



TestService:Check(false, "example")
Checkpoint
TestService:Checkpoint(
text:string, source:Instance, line:number
):()
Parameters
text:string
source:Instance
Default Value: "nil"
line:number
Default Value: 0
Returns
()
Code Samples
TestService:Checkpoint
local TestService = game:GetService("TestService")



TestService:Checkpoint("example")
Done
TestService:Done():()
Returns
()
Code Samples
TestService:Done
local TestService = game:GetService("TestService")



TestService:Done()
Error
TestService:Error(
description:string, source:Instance, line:number
):()
Parameters
description:string
source:Instance
Default Value: "nil"
line:number
Default Value: 0
Returns
()
Code Samples
TestService:Error
local TestService = game:GetService("TestService")



TestService:Error("this is an error")
Fail
TestService:Fail(
description:string, source:Instance, line:number
):()
Parameters
description:string
source:Instance
Default Value: "nil"
line:number
Default Value: 0
Returns
()
isFeatureEnabled
TestService:isFeatureEnabled(name:string):boolean
Parameters
name:string
Returns
boolean
Message
TestService:Message(
text:string, source:Instance, line:number
):()
Parameters
text:string
source:Instance
Default Value: "nil"
line:number
Default Value: 0
Returns
()
Code Samples
TestService:Message
local TestService = game:GetService("TestService")



TestService:Message("example")
RegisterTest
TestService:RegisterTest(testOptions:Dictionary):TestCase
Parameters
testOptions:Dictionary
Returns
TestCase
Require
TestService:Require(
condition:boolean, description:string, source:Instance, line:number
):()
Parameters
condition:boolean
description:string
source:Instance
Default Value: "nil"
line:number
Default Value: 0
Returns
()
Code Samples
TestService:Require
local TestService = game:GetService("TestService")



TestService:Require(false, "example")
Run
Deprecated
RunAsync
Yields
Plugin Security
TestService:RunAsync():()
Returns
()
ScopeTime
TestService:ScopeTime():Dictionary
Returns
Dictionary
TakeSnapshot
TestService:TakeSnapshot(
snapshotname:string, source:Instance
):()
Parameters
snapshotname:string
source:Instance
Default Value: "nil"
Returns
()
Warn
TestService:Warn(
condition:boolean, description:string, source:Instance, line:number
):()
Parameters
condition:boolean
description:string
source:Instance
Default Value: "nil"
line:number
Default Value: 0
Returns
()
Code Samples
TestService:Warn
local TestService = game:GetService("TestService")



TestService:Warn(false, "this action is invalid")
Events
ServerCollectConditionalResult
TestService.ServerCollectConditionalResult(
condition:boolean, text:string, script:Instance, line:number
Parameters
condition:boolean
text:string
script:Instance
line:number
ServerCollectResult
TestService.ServerCollectResult(
text:string, script:Instance, line:number
Parameters
text:string
script:Instance
line:number
©2026 Roblox Corporation. Roblox, the Roblox logo and Powering Imagination are among our registered and unregistered trademarks in the U.S. and other countries.
Terms·Privacy·Accessibility·Support
English