Read the current FPS cap (sUNC getfpscap)
get-fps-capRead the executor's current render frame-rate cap. Returns the cap as a number, where 0 means uncapped, so you can detect limits or confirm uncapped rendering.
Instructions
Read the executor's current render frame-rate cap via getfpscap(). Returns the cap as a number; 0 means uncapped. Requires getfpscap. The call is type-guarded and pcall-wrapped: if getfpscap is missing you get { error = 'getfpscap is not available in this executor.' }. Returns { fpsCap } or { error }. Signature: { threadContext: number?, timeoutMs: number? }. Phase: observe; cost=medium; idempotency=read-only. Requires: active-client. Produces: structured-observation. Safety: read-only. On failure: inspect tool-schema for exact fields, defaults, constraints, and an invocation example.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| timeoutMs | No | Optional per-call deadline in milliseconds; omit it to use the tool or server default. | |
| threadContext | No | Optional Roblox thread identity for this call; omit it to use the server default. |