FutureProg functions
customlinkcells
Overload 1
customlinkcells overload 1
Exit customlinkcells(Location origin, Location destination, OverlayPackage overlay, Number template, Text outboundKeyword, Text outboundTarget, Text inboundKeyword, Text inboundTarget)
Available in
- computer function
- computer program
- standard futureprog
Creates a custom non-cardinal exit between two rooms in an overlay package, using explicit keywords and targets for both directions. This is equivalent to creating a non-cardinal builder exit from a template. Returns the created exit or null if the rooms, editable package, template, or target text are invalid, or if 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. |
template |
Number |
The non-cardinal exit template ID to use. |
outboundKeyword |
Text |
The primary keyword for the origin-to-destination side. |
outboundTarget |
Text |
The target/sdesc displayed for the origin-to-destination side. |
inboundKeyword |
Text |
The primary keyword for the destination-to-origin side. |
inboundTarget |
Text |
The target/sdesc displayed for the destination-to-origin side. |
Overload 2
customlinkcells overload 2
Exit customlinkcells(Location origin, Location destination, OverlayPackage overlay, Text template, Text outboundKeyword, Text outboundTarget, Text inboundKeyword, Text inboundTarget)
Available in
- computer function
- computer program
- standard futureprog
Creates a custom non-cardinal exit between two rooms in an overlay package, using explicit keywords and targets for both directions. This is equivalent to creating a non-cardinal builder exit from a template. Returns the created exit or null if the rooms, editable package, template, or target text are invalid, or if 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. |
template |
Text |
The non-cardinal exit template name to use. |
outboundKeyword |
Text |
The primary keyword for the origin-to-destination side. |
outboundTarget |
Text |
The target/sdesc displayed for the origin-to-destination side. |
inboundKeyword |
Text |
The primary keyword for the destination-to-origin side. |
inboundTarget |
Text |
The target/sdesc displayed for the destination-to-origin side. |