Difference between revisions of "AdminBot for LSL/Documentation"

From SmartBots Developers Docs
Jump to: navigation, search
 
(One intermediate revision by one other user not shown)
Line 14: Line 14:
 
| Events is a notification being sent from the bot to your script (error message, group chat IM etc).
 
| Events is a notification being sent from the bot to your script (error message, group chat IM etc).
  
[[AdminBot Events]] section contains all events which can be sent by AdminBot to your script.
+
[[AdminBot for Groups/Events|AdminBot Events]] section contains all events which can be sent by AdminBot to 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).
  
[[AdminBot Commands]] section contains the full list of the commands.
+
[[AdminBot for Groups/Commands|AdminBot Commands]] section contains the full list of the commands.
  
 
|- class=row-b
 
|- class=row-b

Latest revision as of 13:11, 12 May 2017

This section describes how to communicate with AdminBot gateway: manage it to send the group invitation, talk over and listen to group chat etc.

Interacting with AdminBot

The two-way communication is performed by

  • Commands (your script => AdminBot)
  • Events (AdminBot => your script).
EVENTS (bot => script) COMMANDS (script => bot)
Events is a notification being sent from the bot to your script (error message, group chat IM etc).

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

These are the commands you send to the bot (initialization, group invitation etc).

AdminBot Commands section contains the full list of the commands.

How to receive events

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

How to send commands

Use LSL llMessageLinked function to send commands to the bot.


Was the command successful?

Due to the nature or llMessageLinked function, it's not possible to retrieve the command result directly.

However, AdminBot invokes events to signal the command result, available by link_message.

Before Sending Any Commands

You have to set the group name before issuing the most of the commands. See Initializing AdminBot for details.

Examples

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