Difference between revisions of "Bot Playground/Commands/regionRestart"
From SmartBots Developers Docs
| (One intermediate revision by the same user not shown) | |||
| Line 10: | Line 10: | ||
{{API Variable Group|Input}} | {{API Variable Group|Input}} | ||
| − | {{API Variable|delay| | + | {{API Variable|delay|no}} optional delay before restart, seconds. Default 120, minimum 30, maximum 240. |
{{API Variable Group|Output}} | {{API Variable Group|Output}} | ||
{{API Return promise}} | {{API Return promise}} | ||
| Line 19: | Line 19: | ||
The bot has to be an Estate Manager of the current region. | The bot has to be an Estate Manager of the current region. | ||
| + | |||
| + | == Examples == | ||
| + | |||
| + | See a [[Bot_Playground/Examples/Region_restart|complex region restart script]] in Examples. | ||
| + | |||
{{NavMenu}} | {{NavMenu}} | ||
__NOTOC__ | __NOTOC__ | ||
Latest revision as of 18:07, 6 October 2022
Queries to restart current region of the bot
Bot.regionRestart(delay);
Reference
This command accepts the following parameters:
| Variable | Required | Description
| |
|---|---|---|---|
| Input: | |||
| delay | optional | optional delay before restart, seconds. Default 120, minimum 30, maximum 240. | |
| Output: | |||
| Function returns a Promise with the following data: | |||
| success | bool | true if command completed successfully | |
| error | string | error string if command has failed | |
Permissions
The bot has to be an Estate Manager of the current region.
Examples
See a complex region restart script in Examples.
