Difference between revisions of "Bot Playground/Commands/login"

From SmartBots Developers Docs
Jump to: navigation, search
(Created page with "{{DISPLAYTITLE:{{SUBPAGENAME}}}} <onlyinclude>Initiates bot login sequence.</onlyinclude> <syntaxhighlight lang="javascript"> Bot.login(location); </syntaxhighlight> {{API C...")
 
(Undo revision 650 by Phil (talk))
 
(One intermediate revision by the same user not shown)
(No difference)

Latest revision as of 21:18, 2 July 2016

Initiates bot login sequence.

Bot.login(location);

Reference

This command accepts the following parameters:

Variable Required Description


Input:
location optional The initial location to login. Leave blank for previous location.

Format: Region name/X/Y/Z

Use HOME instead of location to send the bot home (see examples below).

Output:
Function returns a Promise with the following data:
success bool true if command completed successfully
error string error string if command has failed

Examples

Bot.login("DuoLife/206/36/94");