Difference between revisions of "Bot Playground/Commands"

From SmartBots Developers Docs
Jump to: navigation, search
 
(34 intermediate revisions by 3 users not shown)
Line 9: Line 9:
  
 
{{API_Table_start|Command|Description}}
 
{{API_Table_start|Command|Description}}
−
 
+
{{API_Group|Status}}
−
{{API_Group|Program flow}}
+
{{API_Entry|HTTP Bot Command|status}}
−
{{API_Entry|HTTP Bot Command|console.log}}
+
{{API_Entry|HTTP Bot Command|statusExt}}
−
{{API_Entry|HTTP Bot Command|exit}}
+
{{API_Entry|HTTP Bot Command|login}}
−
 
+
{{API_Entry|HTTP Bot Command|logout}}
−
{{API_Group|System}}
+
−
{{API_Entry|HTTP Bot Command|name2key}}
+
−
{{API_Entry|HTTP Bot Command|key2name}}
+
  
 
{{API_Group|Messaging}}
 
{{API_Group|Messaging}}
 
{{API_Entry|HTTP Bot Command|say}}
 
{{API_Entry|HTTP Bot Command|say}}
 
{{API_Entry|HTTP Bot Command|im}}
 
{{API_Entry|HTTP Bot Command|im}}
−
{{API_Entry|HTTP Bot Command|imUuid}}
+
{{API_Entry|HTTP Bot Command|replyDialog}}
−
{{API_Entry|HTTP Bot Command|offerTeleport}}
+
{{API_Entry|HTTP Bot Command|startTyping}}
−
{{API_Entry|HTTP Bot Command|offerFriendship}}
+
{{API_Entry|HTTP Bot Command|stopTyping}}
−
{{API_Entry|HTTP Bot Command|reply_dialog}}
+
  
−
{{API_Group|Group Messaging}}
+
{{API_Group|Friendship}}
−
{{API_Entry|HTTP Bot Command|groupIM}}
+
{{API_Entry|HTTP Bot Command|acceptFriendshipOffer}}
−
{{API_Entry|HTTP Bot Command|groupNotice}}
+
{{API_Entry|HTTP Bot Command|offerFriendship}}
  
−
{{API_Group|Group Management}}
+
{{API_Group|Group Control}}
−
{{API_Entry|HTTP Bot Command|groupInvite}}
+
{{API_Entry|HTTP Bot Command|acceptGroupOffer}}
−
{{API_Entry|HTTP Bot Command|groupEject}}
+
{{API_Entry|HTTP Bot Command|activateGroup}}
 +
{{API_Entry|HTTP Bot Command|groupInfo}}
 +
{{API_Entry|HTTP Bot Command|joinGroup}}
 +
{{API_Entry|HTTP Bot Command|leaveGroup}}
 +
{{API_Entry|HTTP Bot Command|listGroups}}
 +
{{API_Entry|HTTP Bot Command|revokeGroupRole}}
 +
{{API_Entry|HTTP Bot Command|sendGroupIM}}
 +
{{API_Entry|HTTP Bot Command|sendNotice}}
 
{{API_Entry|HTTP Bot Command|setGroupRole}}
 
{{API_Entry|HTTP Bot Command|setGroupRole}}
 +
 +
{{API_Group|Group Members Control}}
 +
{{API_Entry|HTTP Bot Command|ejectGroupMember}}
 +
{{API_Entry|HTTP Bot Command|inviteGroup}}
  
 
{{API_Group|Inventory}}
 
{{API_Group|Inventory}}
 +
{{API_Entry|HTTP Bot Command|acceptInventoryOffer}}
 +
{{API_Entry|HTTP Bot Command|listInventory}}
 
{{API_Entry|HTTP Bot Command|giveInventory}}
 
{{API_Entry|HTTP Bot Command|giveInventory}}
 +
 +
{{API_Group|Appearance}}
 +
{{API_Entry|HTTP Bot Command|takeoff}}
 +
{{API_Entry|HTTP Bot Command|wear}}
 +
 +
{{API_Group|Money}}
 +
{{API_Entry|HTTP Bot Command|getBalance}}
 
{{API_Entry|HTTP Bot Command|giveMoney}}
 
{{API_Entry|HTTP Bot Command|giveMoney}}
  
−
{{API_Group|World}}
+
{{API_Group|Movement}}
−
{{API_Entry|HTTP Bot Command|teleport}}
+
−
{{API_Entry|HTTP Bot Command|walk}}
+
 
{{API_Entry|HTTP Bot Command|fly}}
 
{{API_Entry|HTTP Bot Command|fly}}
−
{{API_Entry|HTTP Bot Command|touch}}
+
{{API_Entry|HTTP Bot Command|move}}
 +
{{API_Entry|HTTP Bot Command|sit}}
 +
{{API_Entry|HTTP Bot Command|teleport}}
 +
{{API_Entry|HTTP Bot Command|walkTo}}
 +
 
 +
{{API_Group|Other avatars interaction}}
 +
{{API_Entry|HTTP Bot Command|avatarInfo}}
 +
{{API_Entry|HTTP Bot Command|key2name}}
 +
{{API_Entry|HTTP Bot Command|name2key}}
 +
{{API_Entry|HTTP Bot Command|offerTeleport}}
 +
{{API_Entry|HTTP Bot Command|acceptTeleportOffer}}
 +
 
 +
{{API_Group|World interaction}}
 +
{{API_Entry|HTTP Bot Command|scanNearbyAvatars}}
 +
{{API_Entry|HTTP Bot Command|takeInworldPrim}}
 +
{{API_Entry|HTTP Bot Command|touchAttachment}}
 +
{{API_Entry|HTTP Bot Command|touchPrim}}
 +
 
 +
{{API_Group|Region (sim) control}}
 +
{{API_Entry|HTTP Bot Command|regionRestart}}
 +
{{API_Entry|HTTP Bot Command|regionRestartCancel}}
  
 
{{API_Table_end}}
 
{{API_Table_end}}
 +
 +
== 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|HTTP API bot commands]].
  
 
{{NavMenu}}
 
{{NavMenu}}
 
__NOTOC__
 
__NOTOC__

Latest revision as of 06:57, 7 December 2023

Commands are being sent to the bot by calling the javascript method of Bot: 

Bot.im("Glaznah Gassner", "Hello there!");

Commands reference

Command Description

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 a list of the Second Life groups the bot is member of.
giveInventory Commands bot to send an inventory item or folder to specific avatar.

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.
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

avatarInfo Returns the Second Life avatar details.
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.

Retrieved from "https://www.mysmartbots.com/dev/docs/index.php?title=Bot_Playground/Commands&oldid=2268"