vp_object_change

From Virtual Paradise Wiki
Jump to: navigation, search
Method call snippet vp_object_change(instance);

Change an existing object.

Used attributes

This method uses data set in these attributes when called:

Attribute Usage
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 (0) or errored for any of these reasons:

Return code Cause
VP_RC_SUCCESS Successful call
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

See also