Interface MovementHookProvider

Optional hook on a source/destination location. Implementations decide how to render movement for that specific space. Anything they don't supply gets Mobile's default.

interface MovementHookProvider {
    getArrivalMessage?(mover: Stuff, exit: default): MovementBodies;
    getDepartureMessage?(mover: Stuff, exit: default): MovementBodies;
    getTeleportInMessage?(mover: Stuff): MovementBodies;
    getTeleportOutMessage?(mover: Stuff): MovementBodies;
}

Index

Methods

getArrivalMessage? getDepartureMessage? getTeleportInMessage? getTeleportOutMessage?

Methods

`Optional`getArrivalMessage

getArrivalMessage?(mover: Stuff, exit: default): MovementBodies
Parameters
- mover: Stuff
- exit: default
Returns MovementBodies
- Defined in packages/server/src/mud/lib/spatial/Mobile.ts:154

`Optional`getDepartureMessage

getDepartureMessage?(mover: Stuff, exit: default): MovementBodies
Parameters
- mover: Stuff
- exit: default
Returns MovementBodies
- Defined in packages/server/src/mud/lib/spatial/Mobile.ts:153

`Optional`getTeleportInMessage

getTeleportInMessage?(mover: Stuff): MovementBodies
Parameters
- mover: Stuff
Returns MovementBodies
- Defined in packages/server/src/mud/lib/spatial/Mobile.ts:156

`Optional`getTeleportOutMessage

getTeleportOutMessage?(mover: Stuff): MovementBodies
Parameters
- mover: Stuff
Returns MovementBodies
- Defined in packages/server/src/mud/lib/spatial/Mobile.ts:155