getfpscap Synchronous

  • get_fps_cap

Read the frame-rate cap currently configured in the scheduler. Put it beside a settings control or save it before changing the cap.

Syntax
Luau
getfpscap() -> number

Parameters

This function takes no arguments.

Returns

number

The current cap as a number; 0 if the scheduler value is unavailable or invalid.

Usage notes

This is a configured limit, not a live FPS measurement.

Example

Example
Luau
local cap = getfpscap()
print(cap > 0 and ("Frame-rate cap: " .. cap) or "Cap unavailable")
Kawaii documentation