vp_object_click
Method call snippet
vp_object_click(instance, object_id, session_to, hit_x, hit_y, hit_z);Sends an object click event to other users in the world.
Parameters
These are the parameters that this method requires:
| Parameter | Usage |
|---|---|
VPInstance instance |
Pointer to the instance this method call is intended for |
int object_id |
Id of the clicked object |
int session_to |
Session ID to send an object click event to, or 0 to send to everyone |
float hit_x |
X coordinate of hit (absolute) |
float hit_y |
Y coordinate of hit (absolute) |
float hit_z |
Z coordinate of hit (absolute) |
Returns
This method returns a return code integer, which indicates whether the call was successful or errored for any reason:
| Return code | Cause |
|---|---|
VP_RC_SUCCESS |
Successful call (for methods that have a registered callback, it only means the request has been sent) |
VP_RC_NOT_IN_WORLD |
Bot is not currently in a world |
Behavior
- Upon successfully clicking an object,
VP_EVENT_OBJECT_CLICKis sent to those who have subscribed to it. If session_to is set to that of a user, then only it will receive the event.
Caveats
- Coordinates are absolute, not relative to the position to the object.
Examples
- This method has no usage examples; please add at least one to this page