vp_object_delete

Method call snippet vp_object_delete(instance, object_id);

Delete an object.

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 delete

Used attributes

This method uses data set in these attributes when called:

Attribute	Usage
int VP_REFERENCE_NUMBER	Is passed to the callback to identify for which method call it is fired

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

The following attributes will be returned in VP_CALLBACK_OBJECT_DELETE if the operation was successful:

Attribute	Usage	Also returned for
int VP_OBJECT_ID	Object id of deleted object

Behavior

• Upon successful deletion of an object, VP_EVENT_OBJECT_DELETE is triggered for those who have subscribed to it.

Examples

This method has no usage examples; please add at least one to this page

See also

• vp_object_add()
• vp_object_change()
• VP_CALLBACK_OBJECT_DELETE