Docs

Directional push ​

Request bounded directional movement while a cell is occupied.

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

Public exports ​

Import from @scape/sdk.

GizmoPush, gizmoPushError, resolveGizmoPush.

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.

ts
import { type ObjectDefinition } from './api.js';
/** One adjacent cell at host-controlled speed. No coordinates, player IDs or collision bypass. */
export interface GizmoPush {
    direction: 'right' | 'down' | 'left' | 'up';
    /** Defaults to false. Lateral exits are always allowed. */
    blockOpposingInput?: boolean;
}
export declare function gizmoPushError(value: unknown): string | null;
/** Pure state-derived intent, checked during registration, actions and host evaluation. */
export declare function resolveGizmoPush(definition: ObjectDefinition, state: unknown): GizmoPush | null;

Usage and limits ​

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

All SDK exports