Vp object change: Difference between revisions
Jump to navigation
Jump to search
Basic layout |
m Added reference number attribute |
||
(One intermediate revision by the same user not shown) | |||
Line 2: | Line 2: | ||
|parameters= | |parameters= | ||
|attributes= | |attributes= | ||
{{sdk attribute row|int |reference_number |Is passed to the callback to identify for which method call it is fired}} | |||
{{sdk attribute row|int |OBJECT_ID |Id of object to change}} | {{sdk attribute row|int |OBJECT_ID |Id of object to change}} | ||
{{sdk attribute row|int |OBJECT_TYPE |Type of object}} | {{sdk attribute row|int |OBJECT_TYPE |Type of object}} | ||
Line 20: | Line 21: | ||
{{sdk attribute row|int|OBJECT_ID|Object id of changed object}} | {{sdk attribute row|int|OBJECT_ID|Object id of changed object}} | ||
|behavior= | |behavior= | ||
* Upon successful change of an object, {{sdk event|OBJECT_CHANGE}} is triggered for those who have subscribed to it. | |||
|caveats= | |caveats= | ||
|examples= | |examples= |
Latest revision as of 23:15, 31 July 2018
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 | |
---|---|---|
VP_REFERENCE_NUMBER | Is passed to the callback to identify for which method call it is fired | |
VP_OBJECT_ID | Id of object to change | |
VP_OBJECT_TYPE | Type of object | |
VP_OBJECT_X | X coordinate | |
VP_OBJECT_Y | Y coordinate | |
VP_OBJECT_Z | Z coordinate | |
VP_OBJECT_ROTATION_X | Rotation axis X | |
VP_OBJECT_ROTATION_Y | Rotation axis Y | |
VP_OBJECT_ROTATION_Z | Rotation axis Z | |
VP_OBJECT_ROTATION_ANGLE | Rotation angle | |
VP_OBJECT_MODEL | Model | |
VP_OBJECT_ACTION | Action | |
VP_OBJECT_DESCRIPTION | Description | |
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 |
---|---|---|
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