View source for AdminBot for LSL/Events

{{DISPLAYTITLE: Events}}
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 for Groups/Examples|AdminBot Examples]] for usage patterns).

== Parsing Events ==

LSL link_message event has the following syntax:

<syntaxhighlight lang="lsl">
link_message(integer sender_num, integer num, string str, key id) {
  ...
}
</syntaxhighlight>

For AdminBot, '''num''' will contain 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 gateway:

{|  class="niceTable striped"
! Event
! Description &amp; Parameters
|-
| colspan="3" |
=== Status events ===

|-
| SB_COMMAND_FAILED
| Raised when command error occurs.

'''str''':<br>
first line - [[AdminBot_for_Groups/Documentation/Status_Codes|command status code]]<br>second line - text explaination

|-
| SB_SETUP_SUCCESS
| Raised when group has been set '''successfully''' (group exists and not expired)

'''str''': group name

'''id''': group UUID

|-
| 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.
'''*Group chat saving must be enabled.'''

'''str''': ''resident-name'': ''message''

''id'': Resident UUID
|}

The numeric values are available here: [[AdminBot Examples: Header variables|Commands and events values]].

{{NavMenu}}

__NOTOC__