vp_object_change

Method call snippet vp_object_change(instance);

Change an existing object.

Parameters

These are the parameters that this method requires:

Parameter	Usage
VPInstance instance	Pointer to the instance this method call is intended for

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
int VP_OBJECT_ID	Id of object to change
int VP_OBJECT_TYPE	Type of object
float VP_OBJECT_X	X coordinate
float VP_OBJECT_Y	Y coordinate
float VP_OBJECT_Z	Z coordinate
float VP_OBJECT_ROTATION_X	Rotation axis X
float VP_OBJECT_ROTATION_Y	Rotation axis Y
float VP_OBJECT_ROTATION_Z	Rotation axis Z
float VP_OBJECT_ROTATION_ANGLE	Rotation angle
string VP_OBJECT_MODEL	Model
string VP_OBJECT_ACTION	Action
string VP_OBJECT_DESCRIPTION	Description
data VP_OBJECT_DATA	Data

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_CHANGE if the operation was successful:

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

Behavior

• Upon successful change of an object, VP_EVENT_OBJECT_CHANGE 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_delete()
• VP_CALLBACK_OBJECT_CHANGE