Copy text to the host clipboard (sUNC setclipboard / toclipboard)
set-clipboardCopies provided text to the host machine's OS clipboard, overwriting current contents via setclipboard or toclipboard when available.
Instructions
WRITES HOST STATE — copies the given text to the host machine's OS clipboard via setclipboard(text), falling back to toclipboard(text) on executors that use that name. This overwrites whatever is currently on the clipboard. Requires one of these functions. The call is type-guarded and pcall-wrapped: if neither is present you get { error = 'setclipboard is not available in this executor.' }. Returns { ok, length } or { error }. Signature: { text: string, 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 |
|---|---|---|---|
| text | Yes | The text to place on the host clipboard. | |
| 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. |