Difference between revisions of "TotalControl for LSL/Usage"

From SmartBots Developers Docs
Jump to: navigation, search
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{DISPLAYTITLE: Documentation}}
+
{{DISPLAYTITLE: Using TotalControl}}
−
This section describes how to communicate with AdminBot gateway: manage it to login / logout your bot, talk over and listen to bot chat etc.
+
This section describes how to communicate with the TotalControl script: manage it to login / logout your bot, talk over and listen to bot chat etc.
  
−
== Interacting with AdminBot ==
+
== Interacting with TotalControl ==
−
The two-way communication is performed by
+
−
* Commands (your script => AdminBot)
+
−
* Events (AdminBot => your script).
+
−
{| width=100%
+
  
−
! width=50% | EVENTS (bot => script)
+
The two-way communication is performed by using commands and events:
−
! width=50% | COMMANDS (script => bot)
+
  
−
|- class=row-a
+
[[Image:Totalcontrol-scheme.jpg|link=|center]]
−
| Events is a notification being sent from the bot to your script (error message, group chat IM etc).
+
<p></p>
  
−
[[TotalControl for LSL/Events|AdminBot Events]] section contains all events which can be sent by AdminBot to your script.
+
{| width=100% class="niceTable"
  
 +
! width=50% | COMMANDS<br>your script => bot
 +
! width=50% | EVENTS<br>bot => your script
 +
 +
|-
 
| These are the commands you send to the bot (initialization, group invitation etc).
 
| These are the commands you send to the bot (initialization, group invitation etc).
  
−
[[TotalControl for LSL/Commands|AdminBot Commands]] section contains the full list of the commands.
+
[[TotalControl for LSL/Commands|TotalControl Commands]] section contains the full list of the commands.
 +
 
 +
| Events are notifications being sent from the bot to your script (error messages, group chat IMs etc).
 +
 
 +
[[TotalControl for LSL/Events|TotalControl Events]] section contains all events which can be sent by TotalControl to your script.
  
 
|- class=row-b
 
|- class=row-b
−
|
 
−
=== How to receive events ===
 
−
Use [https://wiki.secondlife.com/wiki/Link_message link_message] LSL event to catch the events from the bot.
 
−
 
 
|
 
|
 
=== How to send commands ===
 
=== How to send commands ===
 
Use LSL [http://wiki.secondlife.com/wiki/LlMessageLinked llMessageLinked] function to send commands to the bot.
 
Use LSL [http://wiki.secondlife.com/wiki/LlMessageLinked llMessageLinked] function to send commands to the bot.
  
 +
<syntaxhighlight lang="lsl">
 +
llMessageLinked(LINK_SET, BOT_GET_BALANCE, "", NULL_KEY);
 +
</syntaxhighlight>
  
−
|- class=row-a
 
 
|
 
|
 +
=== How to receive events ===
 +
Use [https://wiki.secondlife.com/wiki/Link_message link_message] LSL event to catch the events from the bot.
 +
 +
<syntaxhighlight lang="lsl">
 +
link_message(integer sender, integer cmd, string data, key id) {
 +
  if(cmd == BOT_EVENT_LISTEN_MONEY) {
 +
    debug("My balance is: " + data);
 +
  }
 +
}
 +
</syntaxhighlight>
 +
 +
|- class=row-a|
 
|
 
|
 
=== Was the command successful? ===
 
=== Was the command successful? ===
−
Due to the nature or llMessageLinked function, it's not possible to retrieve the command result directly.
+
TotalControl invokes events to send you the command result.
−
 
+
−
However, AdminBot invokes events to signal the command result, available by [http://wiki.secondlife.com/wiki/Link_message link_message].
+
 
|}
 
|}
  
−
== Before Sending Any Commands ==
+
 
−
You have to set the group name before issuing the most of the commands. See [[TotalControl for LSL/Documentation/Initializing TotalControl|Initializing TotalControl]] for details.
+
== Your script work ==
 +
 
 +
# Initialize TotalControl (set bot name): [[TotalControl for LSL/Documentation/Initializing TotalControl|Initializing TotalControl]]
 +
# Send [[TotalControl Commands|commands]]
 +
# Receive [[TotalControl Events|events]]
  
 
== Examples ==
 
== Examples ==
−
We've provided examples on the most important functions of AdminBot. They are available here: [[TotalControl for LSL/Examples|TotalControl Examples]].
+
 
 +
We've provided examples on the most important functions of TotalControl. They are available here: [[TotalControl Examples]].
  
 
{{NavMenu}}
 
{{NavMenu}}
  
 
__NOTOC__
 
__NOTOC__

Latest revision as of 20:25, 1 March 2019

This section describes how to communicate with the TotalControl script: manage it to login / logout your bot, talk over and listen to bot chat etc.

Interacting with TotalControl

The two-way communication is performed by using commands and events:

Totalcontrol-scheme.jpg

COMMANDS
your script => bot 		EVENTS
bot => your script
These are the commands you send to the bot (initialization, group invitation etc).

TotalControl Commands section contains the full list of the commands.

Events are notifications being sent from the bot to your script (error messages, group chat IMs etc).

TotalControl Events section contains all events which can be sent by TotalControl to your script.

How to send commands

Use LSL llMessageLinked function to send commands to the bot. 

llMessageLinked(LINK_SET, BOT_GET_BALANCE, "", NULL_KEY);

How to receive events

Use link_message LSL event to catch the events from the bot. 

link_message(integer sender, integer cmd, string data, key id) {
  if(cmd == BOT_EVENT_LISTEN_MONEY) {
    debug("My balance is: " + data);
  } 
}

Was the command successful?

TotalControl invokes events to send you the command result.


Your script work

  1. Initialize TotalControl (set bot name): Initializing TotalControl
  2. Send commands
  3. Receive events

Examples

We've provided examples on the most important functions of TotalControl. They are available here: TotalControl Examples.


Retrieved from "https://www.mysmartbots.com/dev/docs/index.php?title=TotalControl_for_LSL/Usage&oldid=1564"