Vp enter

Method call snippet vp_enter(instance, world);

Enters a bot into a world.

Parameters

These are the parameters that this method requires:

Parameter	Usage
VPInstance instance	Pointer to the instance this method call is intended for
string world	Name of an online world to enter

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_STRING_TOO_LONG	World name was longer than 255 bytes
VP_RC_CONNECTION_ERROR	Disconnected from universe while sending, or connecting to the world failed
VP_RC_WORLD_NOT_FOUND	No such world is connected to the universe
VP_RC_WORLD_LOGIN_ERROR	Could not login to world (e.g. incorrect world address configured) or banned (not yet implemented)
VP_RC_TIMEOUT	Connection attempt to the world server timed out (e.g. firewalled server)
VP_RC_NOT_IN_UNIVERSE	Bot is not currently connected to universe

Behavior

• If a VP_CALLBACK_ENTER callback is set this function will return immediately and return the result using the callback, otherwise it will call vp_wait() in a loop until done.
• If the bot was already in a world, it will automatically leave that world.
• This will trigger VP_EVENT_WORLD_SETTING for each world setting, provided that the instance has subscribed to the event. See vp_event_set().

Caveats

• The bot will not have a visible "presence" in the world (e.g. will not appear to other users or bots') until vp_state_change() is called at least once.
• World names are case-sensitive.

Examples

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

See also

• VP_CALLBACK_ENTER
• vp_state_change()
• vp_leave()