Miscellaneous

setfpscap

Sets the FPS cap value and returns no values.

Syntax

setfpscap(value: number)
Aliases set_fps_cap

Arguments

NameTypeDescription
valuenumberRequested FPS cap.

Description

Sets the FPS cap value and returns no values. Values that are non-finite, less than or equal to 0, or greater than 2000 are treated as 2000.

Call it with 1 parameter(s): value. The argument table explains which values are required and which ones only refine the behavior.

It does not return data. Treat the call as an action and handle errors around the call site when needed.

Example

Set the TaskScheduler FPS cap field and read it back with getfpscap.

setfpscap(240)
print(getfpscap())