FutureProg functions
linkcells
Overload 1
linkcells overload 1
Exit linkcells(Location origin, Location destination, OverlayPackage overlay, Number direction)
Available in
- computer function
- computer program
- standard futureprog
Creates a standard bidirectional cardinal exit between two rooms in an editable overlay package. This is equivalent to linking rooms with the room builder tools. Returns the created exit from the origin side or null if either room/package is invalid, the package is not editable, the direction is invalid, the rooms are the same, or a conflicting exit already exists.
| Parameter | Type | Description |
|---|---|---|
origin |
Location |
The origin room for the new exit. |
destination |
Location |
The destination room for the new exit. |
overlay |
OverlayPackage |
The editable overlay package where the exit should be created or copied. |
direction |
Number |
The outbound cardinal direction as a numeric enum value. |
Overload 2
linkcells overload 2
Exit linkcells(Location origin, Location destination, OverlayPackage overlay, Text direction)
Available in
- computer function
- computer program
- standard futureprog
Creates a standard bidirectional cardinal exit between two rooms in an editable overlay package. This is equivalent to linking rooms with the room builder tools. Returns the created exit from the origin side or null if either room/package is invalid, the package is not editable, the direction is invalid, the rooms are the same, or a conflicting exit already exists.
| Parameter | Type | Description |
|---|---|---|
origin |
Location |
The origin room for the new exit. |
destination |
Location |
The destination room for the new exit. |
overlay |
OverlayPackage |
The editable overlay package where the exit should be created or copied. |
direction |
Text |
The outbound cardinal direction name, such as north or up. |