Difference between revisions of "AdminBot for LSL/Events"

From SmartBots Developers Docs
Jump to: navigation, search
 
(3 intermediate revisions by the same user not shown)
Line 20: Line 20:
 
The following events can be raised by AdminBot:
 
The following events can be raised by AdminBot:
  
−
{| class="niceTable striped"
+
{{API Table start|Command|Description}}
−
! Event
+
−
! Description & Parameters
+
−
|-
+
−
| colspan="3" |
+
−
=== Status events ===
+
  
−
|-
+
{{API Group|Command execution status}}
−
| SB_COMMAND_FAILED
+
{{API Entry|AdminBot|SB_COMMAND_FAILED}}
−
| Raised when command error occurs.
+
{{API Entry|AdminBot|SB_COMMAND_COMPLETED}}
  
−
'''str''':<br>
+
{{API Group|Setup status}}
−
first line - [[AdminBot_for_Groups/Documentation/Status_Codes|command status code]]<br>second line - text explaination
+
{{API Entry|AdminBot|SB_SETUP_SUCCESS}}
 +
{{API Entry|AdminBot|SB_SETUP_FAILED}}
 +
{{API Entry|AdminBot|SB_SETUP_BOTNAME}}
  
−
|-
+
{{API Group|Group status request events}}
−
| SB_SETUP_SUCCESS
+
{{API Entry|AdminBot|SB_STATUS_REPLY}}
−
| Raised when group has been set '''successfully''' (group exists and not expired)
+
  
−
'''str''': group name
+
{{API Group|Avatar status request events}}
 +
{{API Entry|AdminBot|SB_GROUP_CHECKED}}
  
−
'''id''': group UUID
+
{{API Group|Group chat events}}
−
 
+
{{API Entry|AdminBot|SB_CHAT_SUCCESS}}
−
|-
+
{{API Entry|AdminBot|SB_CHAT_MESSAGE}}
−
| SB_SETUP_FAILED
+
−
| Raised when there was an error setting the group (group does not exist, expired etc)
+
−
 
+
−
'''str''':<br>
+
−
first line - [[AdminBot_for_Groups/Documentation/Status_Codes|group status code]]<br>second life - group expiration date
+
−
 
+
−
|-
+
−
| SB_SETUP_BOTNAME
+
−
| Raised after successful AdminBot initialization. Delivers the bot name and UUID serving the choosen group.
+
−
 
+
−
'''str''': SL bot name
+
−
 
+
−
'''id''': SL bot UUID
+
−
 
+
−
|-
+
−
| colspan="3" |
+
−
=== Group status request events ===
+
−
 
+
−
|-
+
−
| SB_STATUS_REPLY
+
−
| Reply when you request the group status using [[AdminBot_for_Groups/Commands|SB_STATUS_QUERY]]
+
−
 
+
−
'''str''':<br>
+
−
first line - [[AdminBot_for_Groups/Documentation/Status_Codes|group status code]]<br>second line - group expiration date
+
−
 
+
−
'''id''': group UUID
+
−
 
+
−
|-
+
−
| colspan="3" |
+
−
=== Avatar status request events ===
+
−
 
+
−
|-
+
−
| SB_GROUP_CHECKED
+
−
| The reply of the [[AdminBot_for_Groups/Commands/SB_AVATAR_GROUP|SB_AVATAR_GROUP]] command.
+
−
 
+
−
'''str''': 0 - avatar is not in the group<br>
+
−
1 - avatar is in the group
+
−
 
+
−
'''id''': avatar UUID
+
−
 
+
−
|-
+
−
| colspan="3" |
+
−
=== Group chat events ===
+
−
 
+
−
|-
+
−
| SB_CHAT_SUCCESS
+
−
| Raised when bot successfully connects to the group chat (see [[AdminBot_for_Groups/Commands/SB CHAT LISTEN|SB_CHAT_LISTEN]])
+
−
 
+
−
'''id''': Group UUID
+
−
 
+
−
|-
+
−
| SB_CHAT_MESSAGE
+
−
| Raised when bot receives the group chat message.
+
−
'''Important''': [https://www.mysmartbots.com/docs/Group_Chat_Control_Service Group Chat] service must be activated.
+
−
 
+
−
'''str''': ''resident-name'': ''message''
+
−
 
+
−
'''id''': Resident UUID
+
−
|}
+
−
 
+
−
{{API Table start|Command|Description}}
+
−
 
+
−
{{API Group|Startup commands}}
+
−
{{API Entry|AdminBot|SB_COMMAND_FAILED}}
+
  
 
{{API Table end}}
 
{{API Table end}}
  
−
The numeric values are available here: [[AdminBot Examples: Header variables|Commands and events values]].
+
The numeric values are available here: [[AdminBot_for_LSL/Examples/Headers|Commands and events IDs]].
  
 
{{NavMenu}}
 
{{NavMenu}}
  
 
__NOTOC__
 
__NOTOC__

Latest revision as of 11:48, 3 November 2017

AdminBot raises events to inform your script about errors, chat IMs and other things happened. To catch it, use the LSL link_message event (see AdminBot Examples for usage patterns).

Parsing Events

LSL link_message event has the following syntax: 

link_message(integer sender_num, integer num, string str, key id) {
  if(num == SB_SETUP_SUCCESS) {
    ...
  }
}

For AdminBot event, num contains the event code (see below). str and id value depend on the event. Refer to the table below for more info.

Events List

The following events can be raised by AdminBot:

Command Description

Command execution status

SB_COMMAND_FAILED Raised when command execution error occurs.
SB_COMMAND_COMPLETED Raised when command execution completes without errors.

Setup status

SB_SETUP_SUCCESS Raised when group has been set successfully (group exists and not expired)
SB_SETUP_FAILED Raised when there was an error setting the group (group does not exist, expired etc)
SB_SETUP_BOTNAME Raised after successful AdminBot initialization. Delivers the bot name and UUID serving the choosen group.

Group status request events

SB_STATUS_REPLY Replies when you request the group status using SB_STATUS_QUERY

Avatar status request events

SB_GROUP_CHECKED The reply of the SB_AVATAR_GROUP command.

Group chat events

SB_CHAT_SUCCESS Raised when bot successfully connects to the group chat (see SB_CHAT_LISTEN)
SB_CHAT_MESSAGE Raised when bot receives the group chat message.

The numeric values are available here: Commands and events IDs.


Retrieved from "https://www.mysmartbots.com/dev/docs/index.php?title=AdminBot_for_LSL/Events&oldid=1477"