Saxonberg Server API
    Preparing search index...

    Interface ExitOptions

    Constructor options for Exit.

    Exactly one of destination (live ref) or destinationPath (templatePath for lazy resolution) must be provided. Supplying both is allowed when the caller already has both in hand (it skips one resolution step).

    interface ExitOptions {
        blocked?: boolean;
        destination?: Stuff & Container;
        destinationPath?: string;
        direction: string;
        door?: default | null;
        hidden?: boolean;
        keepLiveDestination?: boolean;
        media?: string[];
        messageIn?: string | null;
        messageOut?: string | null;
        muffled?: boolean;
        noFollow?: boolean;
        oneWay?: boolean;
        source: Stuff & Container;
        wheelPassable?: boolean;
    }
    Index

    Properties

    blocked? destination? destinationPath? direction door? hidden? keepLiveDestination? media? messageIn? messageOut? muffled? noFollow? oneWay? source wheelPassable?

    Properties

    blocked?: boolean
    destination?: Stuff & Container
    destinationPath?: string
    direction: string
    door?: default | null
    hidden?: boolean
    keepLiveDestination?: boolean

    Keep destination as a within-session live ref (Pattern B) even when it carries a templatePath, instead of degrading to path resolution (Pattern C). Required for exits between non-singleton runtime clones that SHARE a template path (e.g. Warren members): path resolution would be ambiguous (findByTemplatePath throws on multi-instance). Default false (the historical path-preferring behavior).

    media?: string[]

    Locomotion media this exit admits (e.g. ['ground'], ['water', 'ground']). An exit admits any LocomotionMode whose getMedium() is in this list. Default [] — legacy walk-only behavior (see allowsMode). Grouping by medium lets a normal corridor admit walk + run + crawl + sneak via ['ground'] rather than enumerating every mode name.

    messageIn?: string | null
    messageOut?: string | null
    muffled?: boolean
    noFollow?: boolean
    oneWay?: boolean
    source: Stuff & Container
    wheelPassable?: boolean

    Whether a wheeled hauled cart may pass through this exit. Default true. The media gate already refuses a cart on any non-ground exit (a ladder / ford / open air); this bit covers the one residue the medium can't express — an exit that admits walking but must refuse wheels (stairs, a stile, a turnstile, a narrow door, all media: ['ground']). Authors set it false on those. See the haulage terrain gate in LocomotionApi.canTraverseExit.

    Settings

    Member Visibility

    On This Page

    Properties