Difference between revisions of "TotalControl for LSL/Commands/BOT STATUS QUERY"

From SmartBots Developers Docs
Jump to: navigation, search
(Added example)
 
(2 intermediate revisions by the same user not shown)
Line 33: Line 33:
 
  LOGGED OUT
 
  LOGGED OUT
  
 +
{{AdminBot Event after Command Entry|id}} Bot UUID
 +
{{AdminBot Event after Command End}}
  
 
== Example ==
 
== Example ==
Line 39: Line 41:
 
integer BOT_SETUP_SETBOT = 280101;
 
integer BOT_SETUP_SETBOT = 280101;
 
integer BOT_STATUS_QUERY = 280106;
 
integer BOT_STATUS_QUERY = 280106;
 +
 +
integer READY = FALSE;
  
 
string name = "SmartBots Resident";
 
string name = "SmartBots Resident";
Line 52: Line 56:
 
touch_start(integer total_number)
 
touch_start(integer total_number)
 
{
 
{
llMessageLinked(LINK_SET,BOT_SETUP_SETBOT,name,accesscode);
+
if (READY) {
 +
llMessageLinked(LINK_SET,BOT_STATUS_QUERY,"","");
 +
} else {
 +
llOwnerSay("The bot is not ready. If you received a Setup Failed message then please check your access code is correct, otherwise please try again in a moment.");
 +
}
 
}
 
}
  
Line 58: Line 66:
 
string id = (string)idk;
 
string id = (string)idk;
 
if(cmd == BOT_SETUP_SUCCESS) {
 
if(cmd == BOT_SETUP_SUCCESS) {
 +
READY = TRUE;
 
llOwnerSay("Setup Success: data=" + data + "\nkey= " + id);
 
llOwnerSay("Setup Success: data=" + data + "\nkey= " + id);
 
} else if(cmd == BOT_SETUP_FAILED ) {
 
} else if(cmd == BOT_SETUP_FAILED ) {
 +
READY = FALSE;
 
llOwnerSay("Setup Failed: data=" + data + "\nkey= " + id);
 
llOwnerSay("Setup Failed: data=" + data + "\nkey= " + id);
 
} else if(cmd == BOT_EVENT_STATUS_REPLY ) {
 
} else if(cmd == BOT_EVENT_STATUS_REPLY ) {
Line 67: Line 77:
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
 
{{AdminBot Event after Command Entry|id}} Bot UUID
 
{{AdminBot Event after Command End}}
 
  
 
{{AdminBot for Bots Commands - standard footer}}
 
{{AdminBot for Bots Commands - standard footer}}

Latest revision as of 23:12, 11 March 2019

Queries the selected bot status (useful to determine the subscription length). Result is being returned using BOT_EVENT_STATUS_REPLY event

llMessageLinked(LINK_SET,BOT_STATUS_QUERY,"","");

Variables

The following table shows input values (you send them with the API call) and returned output values.

Variable Required Description


str yes ---
id yes ---

Return value

The result of this command will be returned to your script using BOT_EVENT_STATUS_REPLY event:

link_message( integer sender, integer num, string str, key id )
sender link number of a sender prim
num BOT_EVENT_STATUS_REPLY
str String representing the bot's status:
  1. first line - bot status code (see all codes here)
  2. second line - bot expiration date
  3. third line - bot online status

Online statuses:

  • ONLINE - Bot is online
  • LOGGED OUT - Bot was logged out by gracefully
  • CONNECTING - The bot is logging in
  • OFFLINE - Bot is expired or has an error

Example:

OK
2019-03-10 00:00
LOGGED OUT
id Bot UUID

Example

integer BOT_SETUP_SETBOT = 280101;
integer BOT_STATUS_QUERY = 280106;

integer READY = FALSE;

string name = "SmartBots Resident";
string accesscode = "f7dheb7fba9";

default
{
	state_entry()
	{
		llMessageLinked(LINK_SET,BOT_SETUP_SETBOT,name,accesscode);
	}

	touch_start(integer total_number)
	{
		if (READY) {
			llMessageLinked(LINK_SET,BOT_STATUS_QUERY,"","");
		} else {
			llOwnerSay("The bot is not ready. If you received a Setup Failed message then please check your access code is correct, otherwise please try again in a moment.");
		}
	}

	link_message(integer sender, integer cmd, string data, key idk) {
		string id = (string)idk;
		if(cmd == BOT_SETUP_SUCCESS) {
			READY = TRUE;
			llOwnerSay("Setup Success: data=" + data + "\nkey= " + id);
		} else if(cmd == BOT_SETUP_FAILED ) {
			READY = FALSE;
			llOwnerSay("Setup Failed: data=" + data + "\nkey= " + id);
		} else if(cmd == BOT_EVENT_STATUS_REPLY ) {
			llOwnerSay("Status: data = " + data + "\nkey= " + id);
		}
	}
}