Vp object delete: Difference between revisions

Latest revision as of 23:17, 31 July 2018

Method call snippet vp_object_delete(instance, object_id);

Delete an object.

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

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

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

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

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

@@ Line 1: / Line 1: @@
 {{sdk method page|object_delete|Delete an object.
+|paramex=object_id
 |parameters=
+  {{sdk parameter row|int|object_id             |Id of object to delete}}
 |attributes=
-   {{sdk attribute row|int |OBJECT_ID |Id of object to delete}}
+   {{sdk attribute row|int|reference_number      |Is passed to the callback to identify for which method call it is fired}}
 |returncodes=
    {{sdk return code row|NOT_IN_WORLD |Bot is not currently in a world}}
@@ Line 8: / Line 10: @@
    {{sdk attribute row|int|OBJECT_ID|Object id of deleted object}}
 |behavior=
+* Upon successful deletion of an object, {{sdk event|OBJECT_DELETE}} is triggered for those who have subscribed to it.
 |caveats=
 |examples=