Saxonberg Server API
    Preparing search index...

    Interface ExitInstruction

    Declarative-content shape for a single exit entry in Exitable.applyExits. Mirrors the YAML the content author writes:

    exits:
      north:
        destination: /narnia/castle/library
      portal:
        destination: /narnia/dark-wood/clearing
        bidirectional: true
        opposite: portal

    destination is the template path of the destination Location; the applier resolves it lazily via StuffApi.singleton (clones on first need). bidirectional defaults to true for cardinal directions (the inverse is inferred via NavigationApi.invertDirection) and false for non-cardinal labels unless opposite is supplied. door is the template path of an optional Door whose anchors are installed transitively when present.

    Per declarative-content-slate § exits on ExitableMixin.

    interface ExitInstruction {
        bidirectional?: boolean;
        blocked?: boolean;
        destination: string;
        door?: string;
        hidden?: boolean;
        media?: string[];
        messageIn?: string;
        messageOut?: string;
        muffled?: boolean;
        noFollow?: boolean;
        oneWay?: boolean;
        opposite?: string;
        wheelPassable?: boolean;
    }
    Index

    Properties

    bidirectional? blocked? destination door? hidden? media? messageIn? messageOut? muffled? noFollow? oneWay? opposite? wheelPassable?

    Properties

    bidirectional?: boolean
    blocked?: boolean
    destination: string
    door?: string
    hidden?: boolean
    media?: string[]
    messageIn?: string
    messageOut?: string
    muffled?: boolean
    noFollow?: boolean
    oneWay?: boolean
    opposite?: string
    wheelPassable?: boolean

    Whether a wheeled hauled cart may pass (default true). Set false on a stairs / stile / narrow exit that admits walking but not wheels. Wired through the one-way path (alongside media); a bidirectional exit inherits the default. See Exit.wheelPassable.

    Settings

    Member Visibility

    On This Page

    Properties