Set the render FPS cap (sUNC setfpscap)
set-fps-capSet the Roblox executor's render frame-rate cap via setfpscap(cap); pass 0 to remove the limit. Returns the applied cap or an error if unavailable.
Instructions
WRITES CLIENT STATE — sets the executor's render frame-rate cap via setfpscap(cap). Pass 0 to uncap the frame rate. Requires setfpscap. The call is type-guarded and pcall-wrapped: if setfpscap is missing you get { error = 'setfpscap is not available in this executor.' }. Returns { cap, ok } or { error }. Signature: { cap: number, threadContext: number?, timeoutMs: number? }. Phase: act; cost=medium; idempotency=idempotent-write. Requires: active-client, explicit-mutation-approval. Produces: operation-receipt. Verify with: assert-state. Safety: MUTATING; writes live game/client state. On failure: inspect tool-schema for exact fields, defaults, constraints, and an invocation example.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | Yes | The target frame-rate cap; 0 means uncapped (no limit). | |
| 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. |