Skip to content

Scheduler:get_system_data ​

Obtains information about a given system.

Arguments ​

id number ​

The system id to obtain information from. This system must be registered, otherwise an error will be thrown.

luau
scheduler:get_system_data(id: number)

Return Properties SystemData ​

name string ​

The name of the system that is executed.

phase string? ​

The phase the system is executed in by the guest scheduler.

paused boolean ​

Indicates if the system is actively running or not. If true, scheduler:run will not run the system.

luau
type SystemData = {
    name: string,
    phase: string?,
    paused: boolean
}

Released under the MIT License.