getfpscap

Returns the current FPS cap value represented by Roblox, or 0 when the value cannot be read.

getfpscap(): number

Aliases get_fps_cap

Name	Type	Description
`fpsCap`	`number`	Current FPS cap value, or 0 when unavailable.

Returns the current FPS cap value represented by Roblox, or 0 when the value cannot be read.

Call it without parameters. The function reads the needed context from the current runtime state.

It returns fpsCap (number). Use the returns table to separate successful values from nil results and recoverable errors.

Read the FPS cap value currently represented by the TaskScheduler cap field.

local fpsCap = getfpscap()
print(fpsCap)