rojo/.cursor/rules/roblox/reference/engine/classes/TaskScheduler.yaml
2026-02-02 12:08:47 -06:00

104 lines
2.6 KiB
YAML

# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
name: TaskScheduler
type: class
memory_category: Instances
summary: |
Collection of settings for the _Task Scheduler_ feature.
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_.
code_samples: []
inherits:
- Instance
descendants: []
tags:
- NotCreatable
- Service
- NotReplicated
deprecation_message: ''
properties:
- name: TaskScheduler.SchedulerDutyCycle
summary: |
The average time divided by the average interval of the duty cycle.
description: |
The average time divided by the average interval of the duty cycle.
code_samples: []
type: double
tags:
- ReadOnly
- NotReplicated
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Diagnostics
serialization:
can_load: false
can_save: true
capabilities: []
- name: TaskScheduler.SchedulerRate
summary: |
The current average rate of the task scheduler.
description: |
The current average rate of the task scheduler.
code_samples: []
type: double
tags:
- ReadOnly
- NotReplicated
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Diagnostics
serialization:
can_load: false
can_save: true
capabilities: []
- name: TaskScheduler.ThreadPoolConfig
summary: |
The specified thread pooling configuration for the task scheduler.
description: |
The specified thread pooling configuration for the task scheduler.
code_samples: []
type: ThreadPoolConfig
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Configuration
serialization:
can_load: true
can_save: true
capabilities: []
- name: TaskScheduler.ThreadPoolSize
summary: |
The current size of the thread pool.
description: |
The current size of the thread pool.
code_samples: []
type: int
tags:
- ReadOnly
- NotReplicated
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Diagnostics
serialization:
can_load: false
can_save: true
capabilities: []
methods: []
events: []
callbacks: []