Saxonberg Server API
    Preparing search index...

    Interface TraversalGuard

    Result of Exit.canTraverse().

    reason is a player-facing error string when ok === false. When ok is true the reason is absent.

    gate / mode / context are additive: pre-locomotion callers that only read reason keep working; new consumers branch on gate to compose verb-templated rejection prose without re-parsing reason.

    interface TraversalGuard {
        context?: Record<string, unknown>;
        gate?: TraversalGate;
        mode?: string;
        ok: boolean;
        reason?: string;
    }
    Index

    Properties

    context? gate? mode? ok reason?

    Properties

    context?: Record<string, unknown>

    Gate-specific context (e.g. { missing: 'ClimbableMixin' }).

    gate?: TraversalGate
    mode?: string

    Short mode name (e.g. 'walk') when the gate is mode-related.

    ok: boolean
    reason?: string

    Settings

    Member Visibility

    On This Page

    Properties