TestService
CreatorHub

A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.

It is a singleton that may be acquired with GetService.

Memory category	Instances

Tags: [Service]

Member index 33

History		Member
553		AutoRuns: bool
486		Description: string
553		ErrorCount: int
553		ExecuteWithStudioRun: bool
660		Is30FpsThrottleEnabled: bool
640		IsPhysicsEnvironmentalThrottled: bool
553		IsSleepAllowed: bool
553		NumberOfPlayers: int
553		SimulateSecondsLag: double
553		TestCount: int
660		ThrottlePhysicsToRealtime: bool
553		Timeout: double
553		WarnCount: int
573		Check(condition: bool, description: string, source: Instance = Instance, line: int = 0): null
573		Checkpoint(text: string, source: Instance = Instance, line: int = 0): null
689		ConvertSlimAcrToObj(acrFullFilePath: string, objFileName: string): string
687		CreateAndSavePropertySet(source: Instance): string
687		CreateExtraAssetsFileFromPropertySet(psetFileName: string): string
573		Done(): null
573		Error(description: string, source: Instance = Instance, line: int = 0): null
573		Fail(description: string, source: Instance = Instance, line: int = 0): null
687		FetchExtraAssets(extraAssetsFileName: string): string
573		Message(text: string, source: Instance = Instance, line: int = 0): null
573		Require(condition: bool, description: string, source: Instance = Instance, line: int = 0): null
702		Run(): null
702		RunAsync(): null
486		ScopeTime(): Dictionary
679		TakeSnapshot(snapshotname: string): null
687		TranscodePropertySet(extraAssetsFileName: string, psetFileName: string): string
573		Warn(condition: bool, description: string, source: Instance = Instance, line: int = 0): null
462		isFeatureEnabled(name: string): bool
462		ServerCollectConditionalResult(condition: bool, text: string, script: Instance, line: int)
462		ServerCollectResult(text: string, script: Instance, line: int)
67 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
670		Capabilities: SecurityCapabilities
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
702		PredictionMode: PredictionMode
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
670		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
680		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
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
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()
657		StyledPropertiesChanged()
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 5

History		Member
696		CreatePropertySetDiff(sourceA: Instance, sourceB: Instance): string
214		DoCommand(name: string): void
214		GetCommandNames(): Array
214		IsCommandChecked(name: string): bool
214		IsCommandEnabled(name: string): bool

Description

TestService is a service used by Roblox internally to run analytical tests on the engine.

Scripts that are executed inside of TestService (via TestService:RunAsync()) have access to special macros that directly invoke functions under the service. Macros are essentially substitutions for large blocks of code that shouldn't need to be rewritten each time you want to call them.

RBX_CHECK

This macro does tests with calls to the TestService:Check() function.

Macro	Test Condition
`RBX_CHECK(cond)`	`cond == true`
`RBX_CHECK_MESSAGE(cond, failMsg)`	`cond == true`
`RBX_CHECK_THROW(CODE)`	`pcall(function() CODE end) == false`
`RBX_CHECK_NO_THROW(CODE)`	`pcall(function() CODE end) == true`
`RBX_CHECK_EQUAL(a, b)`	`a == b`
`RBX_CHECK_NE(a, b)`	`a ~= b`
`RBX_CHECK_GE(a, b)`	`a >= b`
`RBX_CHECK_LE(a, b)`	`a <= b`
`RBX_CHECK_GT(a, b)`	`a > b`
`RBX_CHECK_LT(a, b)`	`a < b`

RBX_REQUIRE

This macro does tests with calls to the TestService:Require() function.

Macro	Test Condition
`RBX_REQUIRE(cond)`	`cond == true`
`RBX_REQUIRE_MESSAGE(cond, failMsg)`	`cond == true`
`RBX_REQUIRE_THROW(CODE)`	`pcall(function() CODE end) == false`
`RBX_REQUIRE_NO_THROW(CODE)`	`pcall(function() CODE end) == true`
`RBX_REQUIRE_EQUAL(a, b)`	`a == b`
`RBX_REQUIRE_NE(a, b)`	`a ~= b`
`RBX_REQUIRE_GE(a, b)`	`a >= b`
`RBX_REQUIRE_LE(a, b)`	`a <= b`
`RBX_REQUIRE_GT(a, b)`	`a > b`
`RBX_REQUIRE_LT(a, b)`	`a < b`

RBX_WARN

This macro does tests with calls to the TestService:Warn() function.

Macro	Test Condition
`RBX_WARN(cond)`	`cond == true`
`RBX_WARN_MESSAGE(cond, failMsg)`	`cond == true`
`RBX_WARN_THROW(CODE)`	`pcall(function() CODE end) == false`
`RBX_WARN_NO_THROW(CODE)`	`pcall(function() CODE end) == true`
`RBX_WARN_EQUAL(a, b)`	`a == b`
`RBX_WARN_NE(a, b)`	`a ~= b`
`RBX_WARN_GE(a, b)`	`a >= b`
`RBX_WARN_LE(a, b)`	`a <= b`
`RBX_WARN_GT(a, b)`	`a > b`
`RBX_WARN_LT(a, b)`	`a < b`

Additional Macros

Macro	Description
`RBX_ERROR(msg)`	Directly calls the TestService:Error() function.
`RBX_FAIL(msg)`	Directly calls the TestService:Fail() function.
`RBX_MESSAGE(msg)`	Directly calls the TestService:Message() function.

History 139
Hide member changes

702 Add RunAsync
702 Change Tags of Run from [Yields] to [Yields, Deprecated]
702 Change PreferredDescriptor of Run from to RunAsync
701 Remove RunAsync
701 Change Tags of Run from [Yields, Deprecated] to [Yields]
701 Change PreferredDescriptor of Run from RunAsync to
702 Add RunAsync
702 Change Tags of Run from [Yields] to [Yields, Deprecated]
702 Change PreferredDescriptor of Run from to RunAsync
696 Remove CreatePropertySetDiff
689 Add ConvertSlimAcrToObj
687 Add TranscodePropertySet
687 Add FetchExtraAssets
687 Add CreateExtraAssetsFileFromPropertySet
687 Change ReturnType of CreateAndSavePropertySet from null to string
687 Change Parameters of CreateAndSavePropertySet from (source: Instance, fileName: string) to (source: Instance)
686 Add CreatePropertySetDiff
684 Add CreateAndSavePropertySet
679 Add TakeSnapshot
660 Add ThrottlePhysicsToRealtime
660 Change PreferredDescriptor of Is30FpsThrottleEnabled from to ThrottlePhysicsToRealtime
660 Change CanSave of Is30FpsThrottleEnabled from true to false
660 Change Tags of Is30FpsThrottleEnabled from [] to [NotReplicated, Deprecated]
640 Change CanSave of IsPhysicsEnvironmentalThrottled from false to true
640 Change Tags of IsPhysicsEnvironmentalThrottled from [Hidden, NotReplicated] to []
640 Change Tags of Is30FpsThrottleEnabled from [Hidden, NotReplicated] to []
640 Change CanSave of Is30FpsThrottleEnabled from false to true
590 Change Tags of IsPhysicsEnvironmentalThrottled from [] to [Hidden, NotReplicated]
590 Change CanSave of IsPhysicsEnvironmentalThrottled from true to false
590 Change Tags of Is30FpsThrottleEnabled from [] to [Hidden, NotReplicated]
590 Change CanSave of Is30FpsThrottleEnabled from true to false
573 Change ReturnType of Warn from void to null
573 Change ReturnType of Run from void to null
573 Change ReturnType of Require from void to null
573 Change ReturnType of Message from void to null
573 Change ReturnType of Fail from void to null
573 Change ReturnType of Error from void to null
573 Change ReturnType of Done from void to null
573 Change ReturnType of Checkpoint from void to null
573 Change ReturnType of Check from void to null
553 Change Default of WarnCount from to 0
553 Change Default of Timeout from to 10
553 Change Default of TestCount from to 0
553 Change Default of SimulateSecondsLag from to 0
553 Change Default of NumberOfPlayers from to 0
553 Change Default of IsSleepAllowed from to true
553 Change Default of IsPhysicsEnvironmentalThrottled from to true
553 Change Default of Is30FpsThrottleEnabled from to true
553 Change Default of ExecuteWithStudioRun from to false
553 Change Default of ErrorCount from to 0
553 Change Default of AutoRuns from to true
486 Add ScopeTime
486 Change ThreadSafety of WarnCount from ReadOnly to ReadSafe
486 Change ThreadSafety of Timeout from ReadOnly to ReadSafe
486 Change ThreadSafety of TestCount from ReadOnly to ReadSafe
486 Change ThreadSafety of SimulateSecondsLag from ReadOnly to ReadSafe
486 Change ThreadSafety of NumberOfPlayers from ReadOnly to ReadSafe
486 Change ThreadSafety of IsSleepAllowed from ReadOnly to ReadSafe
486 Change ThreadSafety of IsPhysicsEnvironmentalThrottled from ReadOnly to ReadSafe
486 Change ThreadSafety of Is30FpsThrottleEnabled from ReadOnly to ReadSafe
486 Change ThreadSafety of ExecuteWithStudioRun from ReadOnly to ReadSafe
486 Change ThreadSafety of ErrorCount from ReadOnly to ReadSafe
486 Change ThreadSafety of Description from ReadOnly to ReadSafe
486 Change ThreadSafety of AutoRuns from ReadOnly to ReadSafe
462 Change ThreadSafety of ServerCollectResult from to Unsafe
462 Change ThreadSafety of ServerCollectConditionalResult from to Unsafe
462 Change ThreadSafety of isFeatureEnabled from to Unsafe
462 Change ThreadSafety of Warn from to Unsafe
462 Change ThreadSafety of Run from to Unsafe
462 Change ThreadSafety of Require from to Unsafe
462 Change ThreadSafety of Message from to Unsafe
462 Change ThreadSafety of Fail from to Unsafe
462 Change ThreadSafety of Error from to Unsafe
462 Change ThreadSafety of Done from to Unsafe
462 Change ThreadSafety of Checkpoint from to Unsafe
462 Change ThreadSafety of Check from to Unsafe
462 Change ThreadSafety of WarnCount from to ReadOnly
462 Change ThreadSafety of Timeout from to ReadOnly
462 Change ThreadSafety of TestCount from to ReadOnly
462 Change ThreadSafety of SimulateSecondsLag from to ReadOnly
462 Change ThreadSafety of NumberOfPlayers from to ReadOnly
462 Change ThreadSafety of IsSleepAllowed from to ReadOnly
462 Change ThreadSafety of IsPhysicsEnvironmentalThrottled from to ReadOnly
462 Change ThreadSafety of Is30FpsThrottleEnabled from to ReadOnly
462 Change ThreadSafety of ExecuteWithStudioRun from to ReadOnly
462 Change ThreadSafety of ErrorCount from to ReadOnly
462 Change ThreadSafety of Description from to ReadOnly
462 Change ThreadSafety of AutoRuns from to ReadOnly
349 Add isFeatureEnabled
337 Add ExecuteWithStudioRun
214 Remove IsCommandEnabled
214 Remove IsCommandChecked
214 Remove GetCommandNames
214 Remove DoCommand
178 Add SimulateSecondsLag
151 Change Security of Run from LocalUserSecurity to PluginSecurity
95 Add ServerCollectResult
95 Add ServerCollectConditionalResult
95 Add NumberOfPlayers
94 Remove ServerCollectResult
94 Remove ServerCollectConditionalResult
94 Remove NumberOfPlayers
95 Add ServerCollectResult
95 Add ServerCollectConditionalResult
95 Add NumberOfPlayers
94 Remove ServerCollectResult
94 Remove ServerCollectConditionalResult
94 Remove NumberOfPlayers
95 Add ServerCollectResult
95 Add ServerCollectConditionalResult
95 Add NumberOfPlayers
57 Add IsCommandEnabled
57 Add IsCommandChecked
57 Add GetCommandNames
57 Add DoCommand
52 Change Parameters of Warn from (condition: bool, description: string) to (condition: bool, description: string, source: Instance = Instance, line: int = 0)
52 Add Run
52 Change Parameters of Require from (condition: bool, description: string) to (condition: bool, description: string, source: Instance = Instance, line: int = 0)
52 Change Parameters of Message from (text: string) to (text: string, source: Instance = Instance, line: int = 0)
52 Add Fail
52 Add Error
52 Change Parameters of Checkpoint from (text: string) to (text: string, source: Instance = Instance, line: int = 0)
52 Change Parameters of Check from (condition: bool, description: string) to (condition: bool, description: string, source: Instance = Instance, line: int = 0)
52 Add WarnCount
52 Add TestCount
52 Add ErrorCount
52 Add AutoRuns
51 Add Warn
51 Add Require
51 Add Message
51 Add Done
51 Add Checkpoint
51 Add Check
51 Add Timeout
51 Add IsSleepAllowed
51 Add IsPhysicsEnvironmentalThrottled
51 Add Is30FpsThrottleEnabled
51 Add Description
51 Add TestService

Members 33

AutoRuns
CreatorHub

Type		Default
bool		true

If set to true, the game will start running when the service's TestService:RunAsync() method is called.

Thread safety	ReadSafe
Category	Physics
Loaded/Saved	true

History 4

553 Change Default of AutoRuns from to true
486 Change ThreadSafety of AutoRuns from ReadOnly to ReadSafe
462 Change ThreadSafety of AutoRuns from to ReadOnly
52 Add AutoRuns

Check
CreatorHub

Parameters (4)		Default
condition	bool
description	string
source	Instance	Instance
line	int	0
Returns (1)
null

If condition is true, prints Check passed: followed by description to the output in blue text. Otherwise, prints Check failed: followed by description in red text.

Thread safety	Unsafe

History 4

573 Change ReturnType of Check from void to null
462 Change ThreadSafety of Check from to Unsafe
52 Change Parameters of Check from (condition: bool, description: string) to (condition: bool, description: string, source: Instance = Instance, line: int = 0)
51 Add Check

Checkpoint
CreatorHub

Parameters (3)		Default
text	string
source	Instance	Instance
line	int	0
Returns (1)
null

Prints Test checkpoint: followed by text to the output in blue text.

Thread safety	Unsafe

History 4

573 Change ReturnType of Checkpoint from void to null
462 Change ThreadSafety of Checkpoint from to Unsafe
52 Change Parameters of Checkpoint from (text: string) to (text: string, source: Instance = Instance, line: int = 0)
51 Add Checkpoint

ConvertSlimAcrToObj
CreatorHub

Parameters (2)
acrFullFilePath	string
objFileName	string
Returns (1)
string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

689 Add ConvertSlimAcrToObj

CreateAndSavePropertySet
CreatorHub

Parameters (1)
source	Instance
Returns (1)
string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

687 Change ReturnType of CreateAndSavePropertySet from null to string
687 Change Parameters of CreateAndSavePropertySet from (source: Instance, fileName: string) to (source: Instance)
684 Add CreateAndSavePropertySet

CreateExtraAssetsFileFromPropertySet
CreatorHub

Parameters (1)
psetFileName	string
Returns (1)
string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

687 Add CreateExtraAssetsFileFromPropertySet

Description
CreatorHub

Type		Default
string

A description of the test being executed.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 3

486 Change ThreadSafety of Description from ReadOnly to ReadSafe
462 Change ThreadSafety of Description from to ReadOnly
51 Add Description

Done
CreatorHub

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

Prints Testing Done to the output in blue text.

Thread safety	Unsafe

History 3

573 Change ReturnType of Done from void to null
462 Change ThreadSafety of Done from to Unsafe
51 Add Done

Error
CreatorHub

Parameters (3)		Default
description	string
source	Instance	Instance
line	int	0
Returns (1)
null

Prints a red error message (description) to the output, prefixed by TestService: .

Thread safety	Unsafe

History 3

573 Change ReturnType of Error from void to null
462 Change ThreadSafety of Error from to Unsafe
52 Add Error

ErrorCount
CreatorHub

Type		Default
int		0

Measures how many errors have been recorded in the test session.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	ReadSafe
Category	Results
Loaded/Saved	false/true

History 4

553 Change Default of ErrorCount from to 0
486 Change ThreadSafety of ErrorCount from ReadOnly to ReadSafe
462 Change ThreadSafety of ErrorCount from to ReadOnly
52 Add ErrorCount

Tags: [ReadOnly, NotReplicated]

ExecuteWithStudioRun
CreatorHub

Type		Default
bool		false

When set to true, TestService will be executed when using the Run action in Roblox Studio.

Note that if the NumberOfPlayers property is set to a value above 0, running the game will open NumberOfPlayers + 1 Studio windows where one window is a server and the rest are players connected to that server. Try to keep this value within a rational range (1 to 8 players) or else your computer's CPU will get overloaded.

Thread safety	ReadSafe
Category	Settings
Loaded/Saved	true

History 4

553 Change Default of ExecuteWithStudioRun from to false
486 Change ThreadSafety of ExecuteWithStudioRun from ReadOnly to ReadSafe
462 Change ThreadSafety of ExecuteWithStudioRun from to ReadOnly
337 Add ExecuteWithStudioRun

Fail
CreatorHub

Parameters (3)		Default
description	string
source	Instance	Instance
line	int	0
Returns (1)
null

Indicates a fatal error in a TestService run. If this is called inside of a script running inside the service, it will initiate a breakpoint on the line that invoked the error.

Thread safety	Unsafe

History 3

573 Change ReturnType of Fail from void to null
462 Change ThreadSafety of Fail from to Unsafe
52 Add Fail

FetchExtraAssets
CreatorHub

Parameters (1)
extraAssetsFileName	string
Returns (1)
string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

687 Add FetchExtraAssets

Is30FpsThrottleEnabled
CreatorHub

Type		Default
bool		true

Sets whether or not the physics engine should be throttled to 30 FPS while the test is being ran.

It exists only for backward compatibility, and should not be used for new work. ThrottlePhysicsToRealtime should be used instead.

Its interface does not cross the network boundary.

Thread safety	ReadSafe
Category	Physics
Loaded/Saved	true/false

History 11

660 Change PreferredDescriptor of Is30FpsThrottleEnabled from to ThrottlePhysicsToRealtime
660 Change CanSave of Is30FpsThrottleEnabled from true to false
660 Change Tags of Is30FpsThrottleEnabled from [] to [NotReplicated, Deprecated]
640 Change Tags of Is30FpsThrottleEnabled from [Hidden, NotReplicated] to []
640 Change CanSave of Is30FpsThrottleEnabled from false to true
590 Change Tags of Is30FpsThrottleEnabled from [] to [Hidden, NotReplicated]
590 Change CanSave of Is30FpsThrottleEnabled from true to false
553 Change Default of Is30FpsThrottleEnabled from to true
486 Change ThreadSafety of Is30FpsThrottleEnabled from ReadOnly to ReadSafe
462 Change ThreadSafety of Is30FpsThrottleEnabled from to ReadOnly
51 Add Is30FpsThrottleEnabled

Tags: [NotReplicated, Deprecated]

IsPhysicsEnvironmentalThrottled
CreatorHub

Type		Default
bool		true

Sets whether or not the physics environment should be throttled while running this test.

Thread safety	ReadSafe
Category	Physics
Loaded/Saved	true

History 8

640 Change CanSave of IsPhysicsEnvironmentalThrottled from false to true
640 Change Tags of IsPhysicsEnvironmentalThrottled from [Hidden, NotReplicated] to []
590 Change Tags of IsPhysicsEnvironmentalThrottled from [] to [Hidden, NotReplicated]
590 Change CanSave of IsPhysicsEnvironmentalThrottled from true to false
553 Change Default of IsPhysicsEnvironmentalThrottled from to true
486 Change ThreadSafety of IsPhysicsEnvironmentalThrottled from ReadOnly to ReadSafe
462 Change ThreadSafety of IsPhysicsEnvironmentalThrottled from to ReadOnly
51 Add IsPhysicsEnvironmentalThrottled

IsSleepAllowed
CreatorHub

Type		Default
bool		true

Sets whether or not physics objects will be allowed to fall asleep while the test simulation is running.

Thread safety	ReadSafe
Category	Physics
Loaded/Saved	true

History 4

553 Change Default of IsSleepAllowed from to true
486 Change ThreadSafety of IsSleepAllowed from ReadOnly to ReadSafe
462 Change ThreadSafety of IsSleepAllowed from to ReadOnly
51 Add IsSleepAllowed

Message
CreatorHub

Parameters (3)		Default
text	string
source	Instance	Instance
line	int	0
Returns (1)
null

Prints TestService: followed by text to the output in blue text.

Thread safety	Unsafe

History 4

573 Change ReturnType of Message from void to null
462 Change ThreadSafety of Message from to Unsafe
52 Change Parameters of Message from (text: string) to (text: string, source: Instance = Instance, line: int = 0)
51 Add Message

NumberOfPlayers
CreatorHub

Type		Default
int		0

The number of players expected in this test, if any.

Thread safety	ReadSafe
Category	Settings
Loaded/Saved	true

History 8

553 Change Default of NumberOfPlayers from to 0
486 Change ThreadSafety of NumberOfPlayers from ReadOnly to ReadSafe
462 Change ThreadSafety of NumberOfPlayers from to ReadOnly
95 Add NumberOfPlayers
94 Remove NumberOfPlayers
95 Add NumberOfPlayers
94 Remove NumberOfPlayers
95 Add NumberOfPlayers

Require
CreatorHub

Parameters (4)		Default
condition	bool
description	string
source	Instance	Instance
line	int	0
Returns (1)
null

If condition is true, prints Require passed: followed by description to the output in blue text. Otherwise prints Require failed. Test ended: followed by description in red text.

Thread safety	Unsafe

History 4

573 Change ReturnType of Require from void to null
462 Change ThreadSafety of Require from to Unsafe
52 Change Parameters of Require from (condition: bool, description: string) to (condition: bool, description: string, source: Instance = Instance, line: int = 0)
51 Add Require

Run
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work. RunAsync should be used instead.

It will block the calling thread until completion.

Security	PluginSecurity
Thread safety	Unsafe

History 10

702 Change Tags of Run from [Yields] to [Yields, Deprecated]
702 Change PreferredDescriptor of Run from to RunAsync
701 Change Tags of Run from [Yields, Deprecated] to [Yields]
701 Change PreferredDescriptor of Run from RunAsync to
702 Change Tags of Run from [Yields] to [Yields, Deprecated]
702 Change PreferredDescriptor of Run from to RunAsync
573 Change ReturnType of Run from void to null
462 Change ThreadSafety of Run from to Unsafe
151 Change Security of Run from LocalUserSecurity to PluginSecurity
52 Add Run

Tags: [Yields, Deprecated]

RunAsync
CreatorHub

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

Runs scripts which are parented to TestService.

It will block the calling thread until completion.

Security	PluginSecurity
Thread safety	Unsafe

History 3

Tags: [Yields]

ScopeTime
CreatorHub

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

Thread safety	Unsafe

History 1

486 Add ScopeTime

ServerCollectConditionalResult
CreatorHub

Parameters (4)
condition	bool
text	string
script	Instance
line	int

Fires when the server should collect a conditional test result.

Thread safety	Unsafe

History 6

462 Change ThreadSafety of ServerCollectConditionalResult from to Unsafe
95 Add ServerCollectConditionalResult
94 Remove ServerCollectConditionalResult
95 Add ServerCollectConditionalResult
94 Remove ServerCollectConditionalResult
95 Add ServerCollectConditionalResult

ServerCollectResult
CreatorHub

Parameters (3)
text	string
script	Instance
line	int

Fires when the server should collect a test result.

Thread safety	Unsafe

History 6

462 Change ThreadSafety of ServerCollectResult from to Unsafe
95 Add ServerCollectResult
94 Remove ServerCollectResult
95 Add ServerCollectResult
94 Remove ServerCollectResult
95 Add ServerCollectResult

SimulateSecondsLag
CreatorHub

Type		Default
double		0

Sets a specific amount of additional latency experienced by players during the test session.

Thread safety	ReadSafe
Category	Settings
Loaded/Saved	true

History 4

553 Change Default of SimulateSecondsLag from to 0
486 Change ThreadSafety of SimulateSecondsLag from ReadOnly to ReadSafe
462 Change ThreadSafety of SimulateSecondsLag from to ReadOnly
178 Add SimulateSecondsLag

TakeSnapshot
CreatorHub

Parameters (1)
snapshotname	string
Returns (1)
null

Thread safety	Unsafe

History 1

679 Add TakeSnapshot

TestCount
CreatorHub

Type		Default
int		0

Measures how many test calls have been recorded in the test session.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	ReadSafe
Category	Results
Loaded/Saved	false/true

History 4

553 Change Default of TestCount from to 0
486 Change ThreadSafety of TestCount from ReadOnly to ReadSafe
462 Change ThreadSafety of TestCount from to ReadOnly
52 Add TestCount

Tags: [ReadOnly, NotReplicated]

ThrottlePhysicsToRealtime
CreatorHub

Type		Default
bool		true

Sets whether the test should be throttled to simulate time according to real world time or as fast as possible.

Thread safety	ReadSafe
Category	Physics
Loaded/Saved	true

History 1

660 Add ThrottlePhysicsToRealtime

Timeout
CreatorHub

Type		Default
double		10

The maximum amount of time that tests are allowed to run for.

Thread safety	ReadSafe
Category	Settings
Loaded/Saved	true

History 4

553 Change Default of Timeout from to 10
486 Change ThreadSafety of Timeout from ReadOnly to ReadSafe
462 Change ThreadSafety of Timeout from to ReadOnly
51 Add Timeout

TranscodePropertySet
CreatorHub

Parameters (2)
extraAssetsFileName	string
psetFileName	string
Returns (1)
string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

687 Add TranscodePropertySet

Warn
CreatorHub

Parameters (4)		Default
condition	bool
description	string
source	Instance	Instance
line	int	0
Returns (1)
null

If condition is true, prints Warning passed: followed by description to the output in blue text. Otherwise prints Warning: followed by description to the output in yellow text.

Thread safety	Unsafe

History 4

573 Change ReturnType of Warn from void to null
462 Change ThreadSafety of Warn from to Unsafe
52 Change Parameters of Warn from (condition: bool, description: string) to (condition: bool, description: string, source: Instance = Instance, line: int = 0)
51 Add Warn

WarnCount
CreatorHub

Type		Default
int		0

Measures how many warning calls have been recorded in the test session.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	ReadSafe
Category	Results
Loaded/Saved	false/true

History 4

553 Change Default of WarnCount from to 0
486 Change ThreadSafety of WarnCount from ReadOnly to ReadSafe
462 Change ThreadSafety of WarnCount from to ReadOnly
52 Add WarnCount

Tags: [ReadOnly, NotReplicated]

isFeatureEnabled
CreatorHub

Parameters (1)
name	string
Returns (1)
bool

Thread safety	Unsafe

History 2

462 Change ThreadSafety of isFeatureEnabled from to Unsafe
349 Add isFeatureEnabled

Removed members 5

CreatePropertySetDiff
CreatorHub

Parameters (2)
sourceA	Instance
sourceB	Instance
Returns (1)
string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

696 Remove CreatePropertySetDiff
686 Add CreatePropertySetDiff

DoCommand
CreatorHub

Parameters (1)
name	string
Returns (1)
void

Security	LocalUserSecurity

History 2

214 Remove DoCommand
57 Add DoCommand

GetCommandNames
CreatorHub

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

Security	LocalUserSecurity

History 2

214 Remove GetCommandNames
57 Add GetCommandNames

IsCommandChecked
CreatorHub

Parameters (1)
name	string
Returns (1)
bool

Security	LocalUserSecurity

History 2

214 Remove IsCommandChecked
57 Add IsCommandChecked

IsCommandEnabled
CreatorHub

Parameters (1)
name	string
Returns (1)
bool

Security	LocalUserSecurity

History 2

214 Remove IsCommandEnabled
57 Add IsCommandEnabled

Engine API

Website

Related

RBX_CHECK

RBX_REQUIRE

RBX_WARN

Additional Macros

History 4

History 4

History 4

History 1

History 3

History 1

History 3

History 3

History 3

History 4

History 4

History 3

History 1

History 11

History 8

History 4

History 4

History 8

History 4

History 10

History 3

History 1

History 6

History 6

History 4

History 1

History 4

History 1

History 4

History 1

History 4

History 4

History 2

History 2

History 2

History 2

History 2

History 2