Difference between revisions of "Bot Playground/Commands"
From SmartBots Developers Docs
(Add notecard and deleteInventory commands) |
|||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 9: | Line 9: | ||
{{API_Table_start|Command|Description}} | {{API_Table_start|Command|Description}} | ||
| + | {{API_Group|Access Rights}} | ||
| + | {{API_Entry|HTTP Bot Command|isMyOwner}} | ||
| + | {{API_Entry|HTTP Bot Command|isMyManager}} | ||
| + | {{API_Entry|HTTP Bot Command|isOnline}} | ||
| + | |||
| + | {{API_Group|Avatar Info}} | ||
| + | {{API_Entry|HTTP Bot Command|avatarInfo}} | ||
| + | {{API_Entry|HTTP Bot Command|checkScriptedAgent}} | ||
| + | |||
{{API_Group|Status}} | {{API_Group|Status}} | ||
{{API_Entry|HTTP Bot Command|status}} | {{API_Entry|HTTP Bot Command|status}} | ||
| Line 19: | Line 28: | ||
{{API_Entry|HTTP Bot Command|im}} | {{API_Entry|HTTP Bot Command|im}} | ||
{{API_Entry|HTTP Bot Command|replyDialog}} | {{API_Entry|HTTP Bot Command|replyDialog}} | ||
| + | {{API_Entry|HTTP Bot Command|startTyping}} | ||
| + | {{API_Entry|HTTP Bot Command|stopTyping}} | ||
{{API_Group|Friendship}} | {{API_Group|Friendship}} | ||
| Line 44: | Line 55: | ||
{{API_Entry|HTTP Bot Command|listInventory}} | {{API_Entry|HTTP Bot Command|listInventory}} | ||
{{API_Entry|HTTP Bot Command|giveInventory}} | {{API_Entry|HTTP Bot Command|giveInventory}} | ||
| + | {{API_Entry|HTTP Bot Command|deleteInventory}} | ||
| + | {{API_Entry|HTTP Bot Command|createNotecard}} | ||
| + | {{API_Entry|HTTP Bot Command|editNotecard}} | ||
| + | {{API_Entry|HTTP Bot Command|readNotecard}} | ||
{{API_Group|Appearance}} | {{API_Group|Appearance}} | ||
| Line 55: | Line 70: | ||
{{API_Group|Movement}} | {{API_Group|Movement}} | ||
{{API_Entry|HTTP Bot Command|fly}} | {{API_Entry|HTTP Bot Command|fly}} | ||
| + | {{API_Entry|HTTP Bot Command|getLocation}} | ||
| + | {{API_Entry|HTTP Bot Command|move}} | ||
{{API_Entry|HTTP Bot Command|sit}} | {{API_Entry|HTTP Bot Command|sit}} | ||
{{API_Entry|HTTP Bot Command|teleport}} | {{API_Entry|HTTP Bot Command|teleport}} | ||
| − | {{API_Entry|HTTP Bot Command| | + | {{API_Entry|HTTP Bot Command|walkTo}} |
{{API_Group|Other avatars interaction}} | {{API_Group|Other avatars interaction}} | ||
| − | |||
{{API_Entry|HTTP Bot Command|key2name}} | {{API_Entry|HTTP Bot Command|key2name}} | ||
{{API_Entry|HTTP Bot Command|name2key}} | {{API_Entry|HTTP Bot Command|name2key}} | ||
Latest revision as of 13:02, 18 September 2025
Commands are being sent to the bot by calling the javascript method of Bot:
Bot.im("Glaznah Gassner", "Hello there!");
Commands reference
| Command | Description | |
|---|---|---|
Access Rights | ||
| isMyOwner | Returns if the bot is owned by the avatar. | |
| isMyManager | Returns if the avatar is a Trusted Manager for the bot. | |
| isOnline | Returns true/false if the bot is online. | |
Avatar Info | ||
| avatarInfo | Returns the Second Life avatar details. | |
| checkScriptedAgent | Returns if the resident is scripted agents known by SmartBots. It included all SmartBots bots, and other residents our system considers bot or scripted agent. | |
Status | ||
| status | Returns the online status of the bot. | |
| statusExt | Returns the online status of the bot. | |
| login | Initiates bot login sequence. | |
| logout | Initiates bot logout sequence. | |
Messaging | ||
| say | Says message over a specific chat channel. | |
| im | Sends Instant Message to specific avatar. | |
| replyDialog | Virtually "presses" a pop-up dialog button (which was displayed by an in-world script). | |
| startTyping | Sends "typing" in chat to a specific user. | |
| stopTyping | Stops sending "typing" in chat to a specific user. | |
Friendship | ||
| acceptFriendshipOffer | Accept (or reject) a friendship offer sent by other avatar. | |
| offerFriendship | Offers friendship to a resident. | |
Group Control | ||
| acceptGroupOffer | Accept (or reject) a group invitation sent by other avatar. | |
| activateGroup | Activates a specific group (for example, to get build rights on the parcel). | |
| groupInfo | Returns the Second Life group details. | |
| joinGroup | Tries to join a group by UUID. | |
| leaveGroup | Commands bot to leave the group specified by a UUID. | |
| listGroups | Returns a list of the Second Life groups the bot is member of. | |
| revokeGroupRole | Removes a group member from a specific role. | |
| sendGroupIM | Sends a message to group chat. | |
| sendNotice | Sends a notice to the group. | |
| setGroupRole | Puts member of a group in a specific role. | |
Group Members Control | ||
| ejectGroupMember | Ejects residents from the group. | |
| inviteGroup | Sends a group invitation to a specific resident. | |
Inventory | ||
| acceptInventoryOffer | Accept (or reject) an inventory offer sent by other avatar or in-world script. | |
| listInventory | Returns an inventory list of the given folder. | |
| giveInventory | Commands bot to send an inventory item or folder to specific avatar. | |
| deleteInventory | Commands bot to delete an inventory item. | |
| createNotecard | Creates a notecard with the desired contents in the bot's inventory. | |
| editNotecard | Edits a notecard in the bot's inventory. | |
| readNotecard | Reads a notecard in the bot's inventory. | |
Appearance | ||
| takeoff | Removes a clothing item, body part or attachment (the opposite of the wear command). | |
| wear | Commands bot to wear a clothing item, body part or attach an object. | |
Money | ||
| getBalance | Retrieves the current bot's L$ balance. | |
| giveMoney | Commands bot to send money (L$) to specific avatar. | |
Movement | ||
| fly | Starts or stops flying. | |
| getLocation | Returns current location of the bot. | |
| move | Start or stop bot movement and rotations. | |
| sit | Commands bot to sit on a specific prim. Allows saving this object as a permanent location. | |
| teleport | Teleports bot to specific location. | |
| walkTo | Walk to a position within the current region. | |
Other avatars interaction | ||
| key2name | Returns avatar Second Life name by UUID. | |
| name2key | Returns the UUID of the given resident by name. | |
| offerTeleport | Sends a teleport offer to the resident. | |
| acceptTeleportOffer | Accept (or reject) a teleport offer sent by other avatar. | |
World interaction | ||
| scanNearbyAvatars | Scans current region for other avatars. | |
| takeInworldPrim | Takes (de-rezzes) or copies in-world prim into bot's inventory. Not available for QubicBot yet (?) | |
| touchAttachment | Touches an attachment of the bot (HUD or wearable object) | |
| touchPrim | Touches an in-world object (prim) by its UUID | |
Region (sim) control | ||
| regionRestart | Queries to restart current region of the bot | |
| regionRestartCancel | Cancels pending restart of current region | |
If you already using SmartBots HTTP API
If you already using SmartBots HTTP API, you may notice that these commands roughly correspond to HTTP API bot commands.
