Difference between revisions of "Bot Playground/Commands/im"

From SmartBots Developers Docs
Jump to: navigation, search
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
 
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
 
<onlyinclude>Sends Instant Message to specific avatar.</onlyinclude>
 
<onlyinclude>Sends Instant Message to specific avatar.</onlyinclude>
 +
 +
<syntaxhighlight lang="javascript">
 +
Bot.im( name_or_UUID, message );
 +
</syntaxhighlight>
  
 
{{API Command Table}}
 
{{API Command Table}}
Line 6: Line 10:
  
 
{{API Variable Group|Input}}
 
{{API Variable Group|Input}}
{{API Variable|location|no}} The initial location to login. Leave blank for previous location.
+
{{API Variable|name_or_UUID|yes}} The name or UUID of the avatar
 
+
{{API Variable|message |yes}} The message to send
Format: ''Region name/X/Y/Z''
+
 
+
Use HOME instead of location to send the bot home (see examples below).
+
 
+
 
{{API Variable Group|Output}}
 
{{API Variable Group|Output}}
{{API Return value}}
+
{{API Return none}}
  
 
{{API Variables Table End}}
 
{{API Variables Table End}}
  
 
== Comments ==
 
== Comments ==
 +
 +
 +
{{NavMenu}}

Latest revision as of 14:28, 30 September 2016

Sends Instant Message to specific avatar.

Bot.im( name_or_UUID, message );

Reference

This command accepts the following parameters:

Variable Required Description


Input:
name_or_UUID yes The name or UUID of the avatar
message yes The message to send
Output:
result This function does not return anything

Comments