vp_avatar_click
Method call snippet
vp_avatar_click(instance, object_id, session_to, hit_x, hit_y, hit_z);
Send an avatar 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 avatar_session |
The session id of the clicked avatar |
Used attributes
This method uses data set in these attributes when called:
Attribute | Usage | |
---|---|---|
VP_VP_CLICK_HIT_X | X coordinate of hit (world coordinates) | |
VP_VP_CLICK_HIT_Y | Y coordinate of hit (world coordinates) | |
VP_VP_CLICK_HIT_Z | Z coordinate of hit (world coordinates) |
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 avatar,
VP_EVENT_AVATAR_CLICK
is sent to those who have subscribed to it. Seevp_event_set()
.
Examples
- This method has no usage examples; please add at least one to this page