vp_destroy

Method call snippet vp_destroy(instance);

Destroys an existing SDK instance.

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.

Caveats

This method will always return VP_RC_SUCCESS even when passed a NULL pointer. However, passing an invalid instance pointer will crash the bot due to a memory access violation.

Examples

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

See also

• vp_create()