Utilities

getfpscap

Returns the current FPS cap configured by the executor.

Syntax

getfpscap(): number
Aliases get_fps_cap

Returns

NameTypeDescription
fpsCapnumberCurrent frames-per-second cap.

Description

Returns the current FPS cap configured by the executor.

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.

Example

Example call with placeholder values.

local result = getfpscap()
print(result)