World text

Declare plain text and the host text editor.

Generated from the reviewed SDK 0.1.0 contract snapshot. Unreviewed workspace changes are not included.

Public exports

Import from @scape/sdk.

GizmoTextEditor, gizmoWorldText, validGizmoTextEditor, validGizmoWorldText.

Type declarations

These declarations preserve source comments and related types. Import only the public exports listed above; module-relative paths below describe how the package is organized.

import { type ObjectDefinition } from './api.js';
/** A single text field rendered by Scape's existing anchored configuration popover. */
export interface GizmoTextEditor {
    field: string;
    action: string;
    label: string;
    maxLength: number;
}
export declare function validGizmoTextEditor(value: unknown): value is GizmoTextEditor;
/** Plain, bounded text only: hosts must never interpret this as HTML. */
export declare function validGizmoWorldText(value: unknown): value is string;
export declare function gizmoWorldText(definition: ObjectDefinition, state: unknown): string;

Usage and limits

See Gizmo guides, working examples, and limits for lifecycle, validation and host behavior.

All SDK exports