FutureProg functions
swapoverlay
Overload 1
swapoverlay overload 1
Boolean swapoverlay(Number overlay)
Available in
- computer function
- computer program
- standard futureprog
Swaps an approved overlay into the worldfile as if you had run the CELL SWAP command. Returns true if successful.
| Parameter | Type | Description |
|---|---|---|
overlay |
Number |
The Id number of the overlay you want to swap |
Overload 2
swapoverlay overload 2
Boolean swapoverlay(Number overlay, Location room)
Available in
- computer function
- computer program
- standard futureprog
Swaps an approved overlay for one room only into the worldfile as if you had run the CELL SWAP command. Returns true if successful. This use case is only recommended for advanced scenarios - in most cases you should swap the entire overlay in at once
| Parameter | Type | Description |
|---|---|---|
overlay |
Number |
The Id number of the overlay you want to swap |
room |
Location |
The room you want to swap this package in for only |
Overload 3
swapoverlay overload 3
Boolean swapoverlay(OverlayPackage overlay)
Available in
- computer function
- computer program
- standard futureprog
Swaps an approved overlay into the worldfile as if you had run the CELL SWAP command. Returns true if successful.
| Parameter | Type | Description |
|---|---|---|
overlay |
OverlayPackage |
The overlay package that you want to swap |
Overload 4
swapoverlay overload 4
Boolean swapoverlay(OverlayPackage overlay, Location room)
Available in
- computer function
- computer program
- standard futureprog
Swaps an approved overlay for one room only into the worldfile as if you had run the CELL SWAP command. Returns true if successful. This use case is only recommended for advanced scenarios - in most cases you should swap the entire overlay in at once
| Parameter | Type | Description |
|---|---|---|
overlay |
OverlayPackage |
The overlay package that you want to swap |
room |
Location |
The room you want to swap this package in for only |
Overload 5
swapoverlay overload 5
Boolean swapoverlay(Text overlay)
Available in
- computer function
- computer program
- standard futureprog
Swaps an approved overlay into the worldfile as if you had run the CELL SWAP command. Returns true if successful.
| Parameter | Type | Description |
|---|---|---|
overlay |
Text |
The name of the overlay you want to swap |
Overload 6
swapoverlay overload 6
Boolean swapoverlay(Text overlay, Location room)
Available in
- computer function
- computer program
- standard futureprog
Swaps an approved overlay for one room only into the worldfile as if you had run the CELL SWAP command. Returns true if successful. This use case is only recommended for advanced scenarios - in most cases you should swap the entire overlay in at once
| Parameter | Type | Description |
|---|---|---|
overlay |
Text |
The name of the overlay you want to swap |
room |
Location |
The room you want to swap this package in for only |