Difference between revisions of "Bot Playground/Events/script dialog"

From SmartBots Developers Docs
Jump to: navigation, search
Line 9: Line 9:
 
{{API Variable Group|''event'' object properties}}
 
{{API Variable Group|''event'' object properties}}
 
{{API Variable|name}}The name of the event in this case script_dialog
 
{{API Variable|name}}The name of the event in this case script_dialog
{{API Variable|buttons}} The selection options (buttons), separated by a new line
+
{{API Variable|buttons|Array}} The selection options (buttons) as array
{{API Variable|channel}} The channel on which the dialog listen to.
+
{{API Variable|channel|integer}} The channel on which the dialog listen to.
 
{{API Variable|owner_name}} The owner name from object that sent the dialog.
 
{{API Variable|owner_name}} The owner name from object that sent the dialog.
 
{{API Variable|text}} The text in the dialog window
 
{{API Variable|text}} The text in the dialog window

Revision as of 18:58, 11 July 2016

Fires when bot receives a scripted dialog

Bot.on("script_dialog", function(event) { ... });

Reference

This event comes with the following event object:

Variable Required Description
event object properties:
name The name of the event in this case script_dialog
buttons Array The selection options (buttons) as array
channel integer The channel on which the dialog listen to.
owner_name The owner name from object that sent the dialog.
text The text in the dialog window
object_uuid The UUID of the object that sent the dialog.
object_name The name of the object that sent the dialog.

Example

Bot.on("script_dialog", function(event) {
   console.log("Got a dialog with the Text:\n" + event.text + "\nAnd the Buttons:\n" + event.buttons);
});