Vp leave: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
m (fixed def)
mNo edit summary
Line 1: Line 1:
{{sdk method page|leave|Makes a bot leave its current [[world]].
{{sdk method page|leave|Makes a bot leave its current [[world]].
|parameters= 
|returncodes=
|returncodes=
   {{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}}
   {{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}}

Revision as of 22:07, 13 December 2016

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 Bot is not currently in a world

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