vp_login

Method call snippet vp_login(instance, username, password, botname);

Logs in a bot to the universe server, using the credentials of an existing account.

Parameters

These are the parameters that this method requires:

Parameter	Usage
VPInstance instance	Pointer to the instance this method call is intended for
string username	Username of the account to log into
string password	Password of the account to log into
string botname	Desired name for the bot to use

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`	If any of the given string parameters exceed 255 characters in length
`VP_RC_INVALID_LOGIN`	The login credentials are incorrect
`VP_RC_TIMEOUT`	Timeout
`VP_RC_NOT_IN_UNIVERSE`	Bot is not currently connected to universe

The following attributes will be returned in VP_CALLBACK_LOGIN if the operation was successful:

Attribute	Usage	Also returned for
int VP_MY_USER_ID	User id of account used to log in

If a VP_CALLBACK_LOGIN 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.
When successfully logged in, bots will have square brackets around their name. For example, providing "Samantha" as the botname parameter will identify the bot as "[Samantha]".
The user ID of the account used to log in will be exposed to other users.
Strings may contain UTF-8 encoded characters (e.g. "\xE2\x98\xAF" is the "Yin and Yang" symbol ☯).

To log out from a universe, vp_destroy() must be called which will also disconnect the bot from the world.

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