Difference between revisions of "Bot Playground/Events/sit"

From SmartBots Developers Docs
Jump to: navigation, search
Line 8: Line 8:
 
{{API Event Table}}
 
{{API Event Table}}
 
{{API Variable Group|''event'' object properties}}
 
{{API Variable Group|''event'' object properties}}
{{API Variable|sitting}} [boolean] true if bot seated on the object, false if it stands
+
{{API Variable|sitting|boolean}} [boolean] true if bot seated on the object, false if it stands
 
{{API Variable|object_uuid}} the UUID of the object bot is sitting on. NULL_KEY if bot is standing.
 
{{API Variable|object_uuid}} the UUID of the object bot is sitting on. NULL_KEY if bot is standing.
 
{{API Variable|prev_seat}} [object { x, y, z }] - the sitting position (offset)
 
{{API Variable|prev_seat}} [object { x, y, z }] - the sitting position (offset)

Revision as of 18:44, 11 July 2016

Fires when bot sits on the object

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

Reference

This event comes with the following event object:

Variable Required Description
event object properties:
sitting boolean [boolean] true if bot seated on the object, false if it stands
object_uuid the UUID of the object bot is sitting on. NULL_KEY if bot is standing.
prev_seat [object { x, y, z }] - the sitting position (offset)

Example

Bot.on("sit", function(event) { 
  console.log("I'm sitting on the object ", event.object_uuid);
});