vp_object_bump_begin
Method call snippet
vp_object_bump_begin(instance, object_id, session_to);Send a object contact begin 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 object to initiate contact with |
int session_to |
Session ID to send a bump event to, or 0 to send to everyone |
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 successful contact with an object,
VP_EVENT_OBJECT_BUMP_BEGINis 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.
Examples
- This method has no usage examples; please add at least one to this page