Vp object add: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
Sleepy E (talk | contribs)
Basic layout
 
Sleepy E (talk | contribs)
mNo edit summary
Line 22: Line 22:
|examples=
|examples=
|seealso=
|seealso=
* {{sdk method|object_change}}
* {{sdk method|object_delete}}
* {{sdk callback|OBJECT_ADD}}
}}
}}

Revision as of 09:30, 13 December 2016

Method call snippet vp_object_add(instance);

Build a new 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_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_ADD if the operation was successful:

Attribute Usage Also returned for
VP_OBJECT_ID Object id

Behavior

There is no special behavior for this method

Examples

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

See also