Vp destroy: Difference between revisions
Jump to navigation
Jump to search
Roy Curtis (talk | contribs) No edit summary |
Roy Curtis (talk | contribs) m (method templates) |
||
| Line 2: | Line 2: | ||
|behavior=If the destroyed instance was connected to a [[world]] and/or a [[universe]], it will be disconnected from both. This is the only way to disconnect a bot from a universe. | |behavior=If the destroyed instance was connected to a [[world]] and/or a [[universe]], it will be disconnected from both. This is the only way to disconnect a bot from a universe. | ||
|seealso= | |seealso= | ||
* | * {{sdk method|create}} | ||
}} | }} | ||
Revision as of 15:00, 30 September 2013
Method call snippet
vp_destroy(instance);Destroys an existing VPInstance.
Parameters
These are the parameters that this method requires:
| Parameter | Usage |
|---|---|
VPInstance instance |
Pointer to the instance this method call is intended for |
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) |
Behavior
If the destroyed instance was connected to a world and/or a universe, it will be disconnected from both. This is the only way to disconnect a bot from a universe.
Examples
- This method has no usage examples; please add at least one to this page