TaskScheduler
CreatorHub

Collection of settings for the Task Scheduler feature.

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 4

History		Member
653		SchedulerDutyCycle: double
653		SchedulerRate: double
653		ThreadPoolConfig: ThreadPoolConfig
653		ThreadPoolSize: 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 12

History		Member
336		AreArbitersThrottled: bool
51		BudgetEnforced: bool
336		Concurrency: ConcurrencyModel
337		NumRunningJobs: double
337		NumSleepingJobs: double
337		NumWaitingJobs: double
336		PriorityMethod: PriorityMethod
336		SleepAdjustMethod: SleepAdjustMethod
337		ThreadAffinity: double
336		ThrottledJobSleepTime: double
310		AddDummyJob(exclusive: bool = true, fps: double = 30): void
310		SetThreadShare(timeSlice: double, numShare: int): void

Description

TaskScheduler is a read-only settings class responsible for the Task Scheduler feature. Can be found in Roblox Studio's settings with the name Task Scheduler.

History 48
Hide member changes

653 Change Default of ThreadPoolSize from to
653 Change Default of ThreadPoolConfig from to
653 Change Default of SchedulerRate from to
653 Change Default of SchedulerDutyCycle from to
653 Change Tags of TaskScheduler from [NotCreatable, Service] to [NotCreatable, Service, NotReplicated]
553 Change Default of ThreadPoolSize from to
553 Change Default of ThreadPoolConfig from to
553 Change Default of SchedulerRate from to
553 Change Default of SchedulerDutyCycle from to
486 Change ThreadSafety of ThreadPoolSize from ReadOnly to ReadSafe
486 Change ThreadSafety of ThreadPoolConfig from ReadOnly to ReadSafe
486 Change ThreadSafety of SchedulerRate from ReadOnly to ReadSafe
486 Change ThreadSafety of SchedulerDutyCycle from ReadOnly to ReadSafe
462 Change ThreadSafety of ThreadPoolSize from to ReadOnly
462 Change ThreadSafety of ThreadPoolConfig from to ReadOnly
462 Change ThreadSafety of SchedulerRate from to ReadOnly
462 Change ThreadSafety of SchedulerDutyCycle from to ReadOnly
413 Change Tags of TaskScheduler from [Service] to [NotCreatable, Service]
337 Remove ThreadAffinity
337 Remove NumWaitingJobs
337 Remove NumSleepingJobs
337 Remove NumRunningJobs
336 Remove ThrottledJobSleepTime
336 Remove SleepAdjustMethod
336 Remove PriorityMethod
336 Remove Concurrency
336 Remove AreArbitersThrottled
310 Remove SetThreadShare
310 Remove AddDummyJob
51 Remove BudgetEnforced
48 Change Tags of SetThreadShare from [] to [Deprecated]
47 Add SetThreadShare
47 Add AddDummyJob
47 Add ThrottledJobSleepTime
47 Add ThreadPoolSize
47 Add ThreadPoolConfig
47 Add ThreadAffinity
47 Add SleepAdjustMethod
47 Add SchedulerRate
47 Add SchedulerDutyCycle
47 Add PriorityMethod
47 Add NumWaitingJobs
47 Add NumSleepingJobs
47 Add NumRunningJobs
47 Add Concurrency
47 Add BudgetEnforced
47 Add AreArbitersThrottled
47 Add TaskScheduler

Members 4

SchedulerDutyCycle
CreatorHub

Type		Default
double

The average time divided by the average interval of the duty cycle.

Its interface does not cross the network boundary.

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

Thread safety	ReadSafe
Category	Diagnostics
Loaded/Saved	false/true

History 5

653 Change Default of SchedulerDutyCycle from to
553 Change Default of SchedulerDutyCycle from to
486 Change ThreadSafety of SchedulerDutyCycle from ReadOnly to ReadSafe
462 Change ThreadSafety of SchedulerDutyCycle from to ReadOnly
47 Add SchedulerDutyCycle

Tags: [ReadOnly, NotReplicated]

SchedulerRate
CreatorHub

Type		Default
double

The current average rate of the task scheduler.

Its interface does not cross the network boundary.

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

Thread safety	ReadSafe
Category	Diagnostics
Loaded/Saved	false/true

History 5

653 Change Default of SchedulerRate from to
553 Change Default of SchedulerRate from to
486 Change ThreadSafety of SchedulerRate from ReadOnly to ReadSafe
462 Change ThreadSafety of SchedulerRate from to ReadOnly
47 Add SchedulerRate

Tags: [ReadOnly, NotReplicated]

ThreadPoolConfig
CreatorHub

Type		Default
ThreadPoolConfig

The specified thread pooling configuration for the task scheduler.

Thread safety	ReadSafe
Category	Configuration
Loaded/Saved	true

History 5

653 Change Default of ThreadPoolConfig from to
553 Change Default of ThreadPoolConfig from to
486 Change ThreadSafety of ThreadPoolConfig from ReadOnly to ReadSafe
462 Change ThreadSafety of ThreadPoolConfig from to ReadOnly
47 Add ThreadPoolConfig

ThreadPoolSize
CreatorHub

Type		Default
int

The current size of the thread pool.

Its interface does not cross the network boundary.

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

Thread safety	ReadSafe
Category	Diagnostics
Loaded/Saved	false/true

History 5

653 Change Default of ThreadPoolSize from to
553 Change Default of ThreadPoolSize from to
486 Change ThreadSafety of ThreadPoolSize from ReadOnly to ReadSafe
462 Change ThreadSafety of ThreadPoolSize from to ReadOnly
47 Add ThreadPoolSize

Tags: [ReadOnly, NotReplicated]

Removed members 12

AddDummyJob
CreatorHub

Parameters (2)		Default
exclusive	bool	true
fps	double	30
Returns (1)
void

Security	LocalUserSecurity

History 2

310 Remove AddDummyJob
47 Add AddDummyJob

AreArbitersThrottled
CreatorHub

Type		Default
bool

Category
Loaded/Saved	false

History 2

336 Remove AreArbitersThrottled
47 Add AreArbitersThrottled

BudgetEnforced
CreatorHub

Type		Default
bool

Category
Loaded/Saved	false

History 2

51 Remove BudgetEnforced
47 Add BudgetEnforced

Concurrency
CreatorHub

Type		Default
ConcurrencyModel

Category
Loaded/Saved	false

History 2

336 Remove Concurrency
47 Add Concurrency

NumRunningJobs
CreatorHub

Type		Default
double

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

Category
Loaded/Saved	false

History 2

337 Remove NumRunningJobs
47 Add NumRunningJobs

Tags: [ReadOnly]

NumSleepingJobs
CreatorHub

Type		Default
double

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

Category
Loaded/Saved	false

History 2

337 Remove NumSleepingJobs
47 Add NumSleepingJobs

Tags: [ReadOnly]

NumWaitingJobs
CreatorHub

Type		Default
double

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

Category
Loaded/Saved	false

History 2

337 Remove NumWaitingJobs
47 Add NumWaitingJobs

Tags: [ReadOnly]

PriorityMethod
CreatorHub

Type		Default
PriorityMethod

Category
Loaded/Saved	false

History 2

336 Remove PriorityMethod
47 Add PriorityMethod

SetThreadShare
CreatorHub

Parameters (2)
timeSlice	double
numShare	int
Returns (1)
void

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

Security	LocalUserSecurity

History 3

310 Remove SetThreadShare
48 Change Tags of SetThreadShare from [] to [Deprecated]
47 Add SetThreadShare

Tags: [Deprecated]

SleepAdjustMethod
CreatorHub

Type		Default
SleepAdjustMethod

Category
Loaded/Saved	false

History 2

336 Remove SleepAdjustMethod
47 Add SleepAdjustMethod

ThreadAffinity
CreatorHub

Type		Default
double

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

Category
Loaded/Saved	false

History 2

337 Remove ThreadAffinity
47 Add ThreadAffinity

Tags: [ReadOnly]

ThrottledJobSleepTime
CreatorHub

Type		Default
double

Category
Loaded/Saved	false

History 2

336 Remove ThrottledJobSleepTime
47 Add ThrottledJobSleepTime

Engine API

Website

Related

History 5

History 5

History 5

History 5

History 2

History 2

History 2

History 2

History 2

History 2

History 2

History 2

History 3

History 2

History 2

History 2