vp_leave
Revision as of 15:13, 30 September 2013 by Roy Curtis (talk | contribs) (Created page with "{{sdk method page|leave|Makes a bot leave its current world. |returncodes= {{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}} {{s...")
Method call snippet
vp_leave(instance);
Makes a bot leave its current world.
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) |
VP_RC_NOT_INITIALIZED |
SDK not initialized with vp_init() yet
|
VP_RC_NOT_IN_WORLD |
No such world is connected to the universe |
Behavior
- There is no special behavior for this method
Caveats
This does not need to be called to move a bot to another world, as vp_enter()
will do that automatically.
Examples
- This method has no usage examples; please add at least one to this page
See also
vp_enter()
vp_destroy()