Reference API Roblox

Engine API

Website

Related

Reference API Roblox

TaskScheduler

Collection of settings for the Task Scheduler feature.

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Memory categoryInstances
Tags: [NotCreatable, Service]

Member index 4

HistoryMember
553SchedulerDutyCycle: double
553SchedulerRate: double
553ThreadPoolConfig: ThreadPoolConfig
553ThreadPoolSize: int
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 12

HistoryMember
336AreArbitersThrottled: bool
51BudgetEnforced: bool
336Concurrency: ConcurrencyModel
337NumRunningJobs: double
337NumSleepingJobs: double
337NumWaitingJobs: double
336PriorityMethod: PriorityMethod
336SleepAdjustMethod: SleepAdjustMethod
337ThreadAffinity: double
336ThrottledJobSleepTime: double
310AddDummyJob(exclusive: bool = true, fps: double = 30): void
310SetThreadShare(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 43

Members 4

SchedulerDutyCycle

TypeDefault
double

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

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryDiagnostics
Loaded/Savedfalse/true

History 4

Tags: [ReadOnly, NotReplicated]

SchedulerRate

TypeDefault
double

The current average rate of the task scheduler.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryDiagnostics
Loaded/Savedfalse/true

History 4

Tags: [ReadOnly, NotReplicated]

ThreadPoolConfig

TypeDefault
ThreadPoolConfig

The specified thread pooling configuration for the task scheduler.

Thread safetyReadSafe
CategoryConfiguration
Loaded/Savedtrue

History 4

ThreadPoolSize

TypeDefault
int

The current size of the thread pool.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryDiagnostics
Loaded/Savedfalse/true

History 4

Tags: [ReadOnly, NotReplicated]

Removed members 12

AddDummyJob

Parameters (2)Default
exclusivebooltrue
fpsdouble30
Returns (1)
void
SecurityLocalUserSecurity

History 2

AreArbitersThrottled

TypeDefault
bool
Category
Loaded/Savedfalse

History 2

BudgetEnforced

TypeDefault
bool
Category
Loaded/Savedfalse

History 2

Concurrency

TypeDefault
ConcurrencyModel
Category
Loaded/Savedfalse

History 2

NumRunningJobs

TypeDefault
double
This property is read-only. Its value can be read, but it cannot be modified.
Category
Loaded/Savedfalse

History 2

Tags: [ReadOnly]

NumSleepingJobs

TypeDefault
double
This property is read-only. Its value can be read, but it cannot be modified.
Category
Loaded/Savedfalse

History 2

Tags: [ReadOnly]

NumWaitingJobs

TypeDefault
double
This property is read-only. Its value can be read, but it cannot be modified.
Category
Loaded/Savedfalse

History 2

Tags: [ReadOnly]

PriorityMethod

TypeDefault
PriorityMethod
Category
Loaded/Savedfalse

History 2

SetThreadShare

Parameters (2)
timeSlicedouble
numShareint
Returns (1)
void
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
SecurityLocalUserSecurity

History 3

Tags: [Deprecated]

SleepAdjustMethod

TypeDefault
SleepAdjustMethod
Category
Loaded/Savedfalse

History 2

ThreadAffinity

TypeDefault
double
This property is read-only. Its value can be read, but it cannot be modified.
Category
Loaded/Savedfalse

History 2

Tags: [ReadOnly]

ThrottledJobSleepTime

TypeDefault
double
Category
Loaded/Savedfalse

History 2

Settings